Enable product purchase signals in the Connect web library

A Product Purchase represents conversion into a product, itinerary, account, or similar offering for purchase. Typically, this is in the form of an order, a booking, or an application.

  • Retail: Typically a product purchase
  • Travel: Typically the booking of an itinerary, room, etc.
  • Banking: Typically the application for a specific account
  • Insurance: Typically the application for a specific policy

Availability

The product purchase signal is included into all Connect subscriptions (Pro, Premium and Ultimate).

Configuration

The Connect library provides a method, TLT.logSignal() with which to send the signal to the Acoustic Connect endpoint, as a JSON object.

Required fields

FieldValuesDefinition
categoryString. Valid value - Behavior. The category of the signal. Do not edit.
currencyString. Valid values - ISO 4217 currency codes.The currency in which the price of the product is being represented
effectString. Valid values:

- negative
- positive
Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring.

We suggest sending positive for all product purchase signals.
nameString, up to 256 charactersAssign a name to the signal to differentiate it from other signals.
signalTypeString. Valid value -
productPurchase.
The type of signal to enable. Do not edit.
productIdStringThe identifier of the product. It may coincide with the SKU.
productNameStringThe name of the product
unitPriceNumberThe unit price of the product

Optional fields

FieldValuesDefinition
quantityIntegerThe quantity of the product purchased
discountNumberDiscount from the original price. If the exact amount is not provided, you could calculate the difference between the original and the current price.
orderIdStringThe ID assigned to the order
productCategoryStringThe category that the product falls in based on the product catalog
productDescriptionStringThe description of the product
productImageUrlStringThe URL of the product image
productUrlStringThe URL of the product page
promotionIdStringFor the use case of on-site marketing like hero images and other calls-to-action, those calls-to-action would have a promotion ID that would "stick" to the behaviors after it.
signalCustomAttributesArray of objectsAllows for custom attributes that are not predefined by the product
virtualCategoryStringThe category is based on how the visitor got to the page, for example from "New arrivals" or "Sale".

Example

{
  "signalType": "productPurchase",
  "name": "productPurchase from product page",
  "category": "Behavior",
  "productId": "10",
  "productName": "Today is a good day Framed poster-Dimension 40x60cm",
  "quantity": 1,
  "effect": "positive"
}