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

FieldValuesDefinition
categoryString. Valid value - BehaviorThe category of the signal. For behavioral signals the category should always be “Behavior”.
nameString The name assigned to the signal. Can contain specific information about the signal that differentiates it from other signals.
signalTypeString. For product view signals, use
productView.
The type of signal being sent. Must be from the set of supported signals.
productIdStringIdentifier of the product
productDescriptionStringDescription of the product
priceNumber or string Current price of the product including discounts
currencyStringCurrency in which the price of the product is being represented

Optional fields

FieldValuesDefinition
effectString. Valid values:

- negative
- positive
Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring.
pageCategoryStringReflects the type of page e.g. home, listing, details, search, etc.
signalCustomAttributesStringAllows for custom attributes that are not predefined by the product
discountNumber or string Discounts from the original price in currency. Adding the discount to the unitPrice would total the original price.
productCategoryStringCategory the product falls in based on the product catalog
productUrlStringURL of the product
productImageUrlStringURL of the image of the product
shoppingCartUrlStringURL of the shopping cart that the add to carts are contributing to
virtualCategoryStringPromotional category such as “recently added”
inStockBoolean. 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.