Product view signals
A Product View represents “intimate contact” with a product, itinerary, account, or similar offering for purchase or application. Typically, this is in the form of a product detail page, a quick view, or a similar encounter.
- Retail: Typically a product detail page or quick view
- Travel: Typically the viewing of an itinerary, room, etc. for booking
- Banking: Typically the viewing of a specific account to open
- Insurance: Typically the viewing of a specific policy to apply for
Configuration
Required fields
Field | Values | Definition |
---|---|---|
category | String. Valid value - Behavior | The category of the signal. For behavioral signals the category should always be “Behavior”. |
name | String | The name assigned to the signal. Can contain specific information about the signal that differentiates it from other signals. |
signalType | String. For product view signals, useproductView . | The type of signal being sent. Must be from the set of supported signals. |
productId | String | Identifier of the product |
productDescription | String | Description of the product |
price | Number or string | Current price of the product including discounts |
currency | String | Currency in which the price of the product is being represented |
Optional fields
Field | Values | Definition |
---|---|---|
effect | String. Valid values: - negative - positive | Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring. |
pageCategory | String | Reflects the type of page e.g. home, listing, details, search, etc. |
signalCustomAttributes | String | Allows for custom attributes that are not predefined by the product |
discount | Number or string | Discounts from the original price in currency. Adding the discount to the unitPrice would total the original price. |
productCategory | String | Category the product falls in based on the product catalog |
productUrl | String | URL of the product |
productImageUrl | String | URL of the image of the product |
shoppingCartUrl | String | URL of the shopping cart that the add to carts are contributing to |
virtualCategory | String | Promotional category such as “recently added” |
inStock | Boolean. Valid values: - true - false - NULL (unknown) | Indicates whether the product is in stock. NULL if unknown |
Sample payload
{
"signalType": "productView",
"category": "Behavior",
"name": "productView from product page",
"pageCategory": "Women Clothes",
"url": "https://retail.acoustic-demo.com/en/women/2-9-brown-bear-printed-sweater.html#/1-size-s",
"effect": "positive"
}
All data in the SDK payload must be collected manually, there is no automatic binding from the values in the page to the payload fields.
Updated 22 days ago