Product configuration signals
A Product Configuration represents any interaction with a product that suggests that the user is preparing to add the product to their cart.
Examples include, but are not limited to:
- Selecting a size and/ or color
- Assigning a shipping postal code
- Completing customization fields, such as for engraving or personalization
Configuration
Required fields
Field | Values | Definition |
---|---|---|
category | String. Valid value - Behavior | The category of the signal. |
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 configuration signals, useproductConfiguration . | The type of signal being sent. |
productId | String | Identifier of the product |
productName | String | Name of the product |
configurationType | String | Type of configuration that happened |
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. |
signalCustomAttributes | Array of objects | Allows for custom attributes that are not predefined by the product. For each custom attribute, add an object with name and value . |
Sample payload
{
"signalType": "productConfiguration",
"name": "productConfiguration from product page",
"category": "Behavior",
"productId": "03456889",
"productName": "Today is a good day framed poster",
"configurationType": "dimension change",
"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 28 days ago