Tracking Sdk

Implements

ITrackingSdk

Methods

addPaymentMethod()

addPaymentMethod(order?, props?, metadata?): Promise<void>

Tracks progression through a checkout when the user completes adding a payment method.
Products and values should represent the current state of the cart.

Parameters

• order?: CommerceActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.addPaymentMethod

Example

Converge.track.addPaymentMethod({
 products: [
     {
         currencyCode: 'USD',
         productIdentifier: '119933',
         variantIdentifier: '1245663433',
         sku: 'sku_product_4',
         lineItemIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
         productName: 'Super awesome product',
         variantName: 'Super variant - size medium',
         categoryName: 'T shirts',
         brandName: 'Tshirts r us',
         unitPrice: 84.33,
         quantity: 1,
         totalDiscount: 0
     },
     {
         currencyCode: 'USD',
         productIdentifier: '442121',
         variantIdentifier: '166544353',
         sku: 'sku_product_12',
         lineItemIdentifier: '8c2d8599bf3c4d7ea6ffba40ea8c8784',
         productName: 'Very cool product',
         variantName: 'Cool variant - size large',
         categoryName: 'Bracelets',
         brandName: 'Bracelets r us',
         unitPrice: 5,
         quantity: 2,
         totalDiscount: 0
     }
 ],
 checkoutIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
 cartIdentifier: 'a32573fe7d024deda1bb186c2d3899ca',
 orderIdentifier: '3075b174947347388e5c13a7df87c341',
 orderNumber: '445778431',
 customerIdentifier: '55381',
 paymentMethodName: 'Credit card',
 currencyCode: 'USD',
 isTest: false,
 totalRefunds: 10.4,
 totalDiscounts: 20.12,
 totalTax: 87.1,
 totalShippingPrice: 12.10
});

addToCart()

addToCart(product?, props?, metadata?): Promise<void>

Tracks adding a product to the cart.

Parameters

• product?: CommerceActivityTrackingEventProductMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.addToCart

Example

Converge.track.addToCart({
   currencyCode: 'USD',
   productIdentifier: '119933',
   variantIdentifier: '1245663433',
   sku: 'sku_product_4',
   lineItemIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
   productName: 'Super awesome product',
   variantName: 'Super variant - size medium',
   categoryName: 'T shirts',
   brandName: 'Tshirts r us',
   unitPrice: 84.33,
   quantity: 1,
   totalDiscount: 0
});

addToWishlist()

addToWishlist(product?, props?, metadata?): Promise<void>

Tracks adding a product to a wishlist.

Parameters

• product?: CommerceActivityTrackingEventProductMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.addToWishlist

Example

Converge.track.addToWishlist({
  currencyCode: 'USD',
  productIdentifier: '119933',
  variantIdentifier: '1245663433',
  sku: 'sku_product_4',
  lineItemIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
  productName: 'Super awesome product',
  variantName: 'Super variant - size medium',
  categoryName: 'T shirts',
  brandName: 'Tshirts r us',
  unitPrice: 84.33,
  quantity: 1,
  totalDiscount: 0
});

applyPromotionalCode()

applyPromotionalCode(info?, props?, metadata?): Promise<void>

Parameters

• info?: PromotionalActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.applyPromotionalCode

changeProductAttribute()

changeProductAttribute(info?, props?, metadata?): Promise<void>

Parameters

• info?: ChangeProductAttributeActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.changeProductAttribute

contactMessage()

contactMessage(info?, props?, metadata?): Promise<void>

Tracks a contact message.
Before calling this method it is recommended to call the IdentitySDK.mergeProfile method to enrich the user profile and include profile traits with the contact message event.

Parameters

• info?: LeadActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.contactMessage

Example

Converge.track.contactMessage({
  sourceContentName: 'Website enquiry form',
  companyName: 'Company in need of help'
});

custom()

custom(name, props?, metadata?): Promise<void>

Tracks a custom event.

Parameters

• name: string

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.custom

Example

Converge.track.custom('MyCustomEventName');

filterItemsByAttribute()

filterItemsByAttribute(filters?, props?, metadata?): Promise<void>

Parameters

• filters?: FilterItemsByAttributeActivityTrackingEventMetadata[]

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.filterItemsByAttribute

initiateCheckout()

initiateCheckout(order?, props?, metadata?): Promise<void>

Tracks initiation by the user to checkout a cart.
Products and values should represent the current state of the cart.

Parameters

• order?: CommerceActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.initiateCheckout

Example

Converge.track.initiateCheckout({
 products: [
     {
         currencyCode: 'USD',
         productIdentifier: '119933',
         variantIdentifier: '1245663433',
         sku: 'sku_product_4',
         lineItemIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
         productName: 'Super awesome product',
         variantName: 'Super variant - size medium',
         categoryName: 'T shirts',
         brandName: 'Tshirts r us',
         unitPrice: 84.33,
         quantity: 1,
         totalDiscount: 0
     },
     {
         currencyCode: 'USD',
         productIdentifier: '442121',
         variantIdentifier: '166544353',
         sku: 'sku_product_12',
         lineItemIdentifier: '8c2d8599bf3c4d7ea6ffba40ea8c8784',
         productName: 'Very cool product',
         variantName: 'Cool variant - size large',
         categoryName: 'Bracelets',
         brandName: 'Bracelets r us',
         unitPrice: 5,
         quantity: 2,
         totalDiscount: 0
     }
 ],
 checkoutIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
 cartIdentifier: 'a32573fe7d024deda1bb186c2d3899ca',
 customerIdentifier: '55381',
 currencyCode: 'USD',
 isTest: false,
});

keywordSearch()

keywordSearch(info?, props?, metadata?): Promise<void>

Tracks a search made by a user.
Keyword search events can be automatically tracked by using the config.tracking.analytics.autoCollection.activityNames and config.tracking.analytics.autoCollection.keywordSearchQueryParamName config.

Parameters

• info?: SearchActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.keywordSearch

Example

Converge.track.keywordSearch({
 searchText: 'super cool product name'
});

lead()

lead(info?, props?, metadata?): Promise<void>

Tracks a lead.
Before calling this method it is recommended to call the IdentitySDK.mergeProfile method to enrich the user profile and include profile traits with the lead event.

Parameters

• info?: LeadActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.lead

Example

Converge.track.lead({
  sourceContentName: 'Lead generation form',
  companySize: '40 - 100',
  companyName: 'Company in need of help',
  predictedLtv: 500000,
  predictedValue: 10000,
  currencyCode: 'USD'
});

newsletterSignup()

newsletterSignup(info?, props?, metadata?): Promise<void>

Parameters

• info?: SignUpActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.newsletterSignup

order()

order(order?, props?, metadata?): Promise<void>

Tracks a successful order or purchase.
Products and values should represent the current state of the cart.

Parameters

• order?: CommerceActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.order

Example

Converge.track.order({
 products: [
     {
         currencyCode: 'USD',
         productIdentifier: '119933',
         variantIdentifier: '1245663433',
         sku: 'sku_product_4',
         lineItemIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
         productName: 'Super awesome product',
         variantName: 'Super variant - size medium',
         categoryName: 'T shirts',
         brandName: 'Tshirts r us',
         unitPrice: 84.33,
         quantity: 1,
         totalDiscount: 0
     },
     {
         currencyCode: 'USD',
         productIdentifier: '442121',
         variantIdentifier: '166544353',
         sku: 'sku_product_12',
         lineItemIdentifier: '8c2d8599bf3c4d7ea6ffba40ea8c8784',
         productName: 'Very cool product',
         variantName: 'Cool variant - size large',
         categoryName: 'Bracelets',
         brandName: 'Bracelets r us',
         unitPrice: 5,
         quantity: 2,
         totalDiscount: 0
     }
 ],
 checkoutIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
 cartIdentifier: 'a32573fe7d024deda1bb186c2d3899ca',
 orderIdentifier: '3075b174947347388e5c13a7df87c341',
 orderNumber: '445778431',
 customerIdentifier: '55381',
 paymentMethodName: 'Credit card',
 currencyCode: 'USD',
 isTest: false,
 totalRefunds: 10.4,
 totalDiscounts: 20.12,
 totalTax: 87.1,
 totalShippingPrice: 12.10
});

removeFromCart()

removeFromCart(product?, props?, metadata?): Promise<void>

Tracks removing a product from a cart.

Parameters

• product?: CommerceActivityTrackingEventProductMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.removeFromCart

Example

Converge.track.removeFromCart({
   currencyCode: 'USD',
   productIdentifier: '119933',
   variantIdentifier: '1245663433',
   sku: 'sku_product_4',
   lineItemIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
   productName: 'Super awesome product',
   variantName: 'Super variant - size medium',
   categoryName: 'T shirts',
   brandName: 'Tshirts r us',
   unitPrice: 84.33,
   quantity: 1,
   totalDiscount: 0
});

schedule()

schedule(info?, props?, metadata?): Promise<void>

Tracks a request to schedule a call or meeting.
Before calling this method it is recommended to call the IdentitySDK.mergeProfile method to enrich the user profile and include profile traits with the schedule event.

Parameters

• info?: LeadActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.schedule

Example

Converge.track.schedule({
  sourceContentName: 'Meeting request form',
  companySize: '40 - 100',
  companyName: 'Company in need of help',
  predictedLtv: 500000,
  predictedValue: 10000,
  currencyCode: 'USD'
});

startTrial()

startTrial(info?, props?, metadata?): Promise<void>

Tracks starting a trail for a product or service.
Before calling this method it is recommended to call the IdentitySDK.mergeProfile method to enrich the user profile and include profile traits with the start trial event.

Parameters

• info?: LeadActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.startTrial

Example

Converge.track.startTrial({
  sourceContentName: '7 day product trial',
  companySize: '40 - 100',
  predictedLtv: 500000,
  predictedValue: 10000,
  currencyCode: 'USD'
});

subscriptionItemPurchase()

subscriptionItemPurchase(order?, props?, metadata?): Promise<void>

Tracks a successful subscription item purchase.
Products and values should represent the current state of the cart.

Parameters

• order?: CommerceActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.subscriptionItemPurchase

Example

Converge.track.subscriptionItemPurchase({
 products: [
     {
         currencyCode: 'USD',
         productIdentifier: '119933',
         variantIdentifier: '1245663433',
         sku: 'sku_product_4',
         lineItemIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
         productName: 'Super awesome product',
         variantName: 'Super variant - size medium',
         categoryName: 'T shirts',
         brandName: 'Tshirts r us',
         unitPrice: 84.33,
         quantity: 1,
         totalDiscount: 0
     },
     {
         currencyCode: 'USD',
         productIdentifier: '442121',
         variantIdentifier: '166544353',
         sku: 'sku_product_12',
         lineItemIdentifier: '8c2d8599bf3c4d7ea6ffba40ea8c8784',
         productName: 'Very cool product',
         variantName: 'Cool variant - size large',
         categoryName: 'Bracelets',
         brandName: 'Bracelets r us',
         unitPrice: 5,
         quantity: 2,
         totalDiscount: 0
     }
 ],
 checkoutIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
 cartIdentifier: 'a32573fe7d024deda1bb186c2d3899ca',
 orderIdentifier: '3075b174947347388e5c13a7df87c341',
 orderNumber: '445778431',
 customerIdentifier: '55381',
 paymentMethodName: 'Credit card',
 currencyCode: 'USD',
 isTest: false,
 totalRefunds: 10.4,
 totalDiscounts: 20.12,
 totalTax: 87.1,
 totalShippingPrice: 12.10
});

userLogin()

userLogin(info?, props?, metadata?): Promise<void>

Parameters

• info?: UserAccountActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.userLogin

userLoginSignup()

userLoginSignup(info?, props?, metadata?): Promise<void>

Parameters

• info?: SignUpActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.userLoginSignup

viewContentItem()

viewContentItem(info?, props?, metadata?): Promise<void>

Tracks viewing a specific page, post or blog article.
Product views should use the viewProduct event instead of this event.

Parameters

• info?: ContentItemActivityTrackingEventMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.viewContentItem

Example

Converge.track.viewContentItem({
 contentName: 'July 2022 newsletter'
});

viewPage()

viewPage(props?, metadata?): Promise<void>

Tracks a page view.
Page views can be automatically tracked by using the config.tracking.analytics.autoCollection.activityNames config.

Parameters

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.viewPage

Example

Converge.track.viewPage();

viewProduct()

viewProduct(product?, props?, metadata?): Promise<void>

Tracks viewing of a single product.

Parameters

• product?: CommerceActivityTrackingEventProductMetadata

• props?: IActivityCommonProps

• metadata?: IActivityMetadataProps

Returns

Promise<void>

Implementation of

ITrackingSdk.viewProduct

Example

Converge.track.viewProduct({
   currencyCode: 'USD',
   productIdentifier: '119933',
   variantIdentifier: '1245663433',
   sku: 'sku_product_4',
   lineItemIdentifier: 'cc8bac2979ea4f5c9a2e8f25fa7ea6d1',
   productName: 'Super awesome product',
   variantName: 'Super variant - size medium',
   categoryName: 'T shirts',
   brandName: 'Tshirts r us',
   unitPrice: 84.33,
   quantity: 1,
   totalDiscount: 0
});