Recommendation events
recommendation.generated
A recommendation was generated for a profile. You can use the data from this event to analyze which recommendation campaigns and types are displayed, what items are recommended, and so on.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignId | string | mXRQzZjARZhz |
ID of the recommendation campaign |
| contextItem | array | ["10990874"] |
itemIds of the items that were used as the context of the recommendation |
| type | string | recommendations-complement-basket |
Type of the recommendation |
| catalogId | string | 5464 |
Item catalog that was used in the recommendation |
| correlationId | string | 43cc2e3f-df11-4c78-abe1-4d0710abba3f |
Correlation ID is used to associate events that are the result of the same request, for example to link a recommendation frame with a recommendation.click event or a search request with an item.search.click event. |
| experimentId | integer | 930 |
ID of the A/B test |
| variantId | integer | 2484 |
ID of the variant for A/B test |
| recommendedItems | array | ["0000209942583","0000207614376","0000301228783","5901985665329"] |
The IDs of items that were recommended. Use in analyses instead of the results parameter. |
| results | array of objects | [{"item":"12000254","score":"0.062140"}] |
A list of item that were recommended, with their scores on a scale from 0 to 1, where 1 is the highest score. The parameter is available upon request. Unusable in analyses. |
| Additional parameters | any | lorem ipsum |
Additional parameters that were added to the recommendation request, in the params parameter. |
recommendation.view
A recommendation frame was displayed to a viewer. The parameters may include a list of the items in the frame, depending on your implementation.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| items | array | ["12345","67890"] |
An array of items that were displayed, identified by itemId (also called sku, productId, or retailer_part_no in some APIs and SDKs). |
| campaignId | string | mXRQzZjARZhz |
ID of the recommendation campaign |
| correlationId | string | 43cc2e3f-df11-4c78-abe1-4d0710abba3f |
Correlation ID is used to associate events that are the result of the same request, for example to link a recommendation frame with a recommendation.click event or a search request with an item.search.click event. |
recommendation.click
A recommended item was clicked.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| item | string | 12345 |
The item that was clicked, identified by itemId (also called sku, productId, or retailer_part_no in some APIs and SDKs). |
| campaignId | string | mXRQzZjARZhz |
ID of the recommendation campaign |
| correlationId | string | 43cc2e3f-df11-4c78-abe1-4d0710abba3f |
Correlation ID is used to associate events that are the result of the same request, for example to link a recommendation frame with a recommendation.click event or a search request with an item.search.click event. |
recommendation.seen
Event from content widget. Sent by mobile SDKs separately for each item in a displayed recommendation. The SDK can be configured to send a recommendation.view event instead, which sends all items in one event.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| campaignId | string | mXRQzZjARZhz |
ID of the recommendation campaign |
variant.assign
Event generated as a result of assigning a customer to a variant of an A/B/X test of a recommendation, AI Search, or dynamic content (for variant optimizer feature driven by AI engine).
Default retention 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| experimentId | integer | 930 |
ID of the A/B test |
| variantId | integer | 2484 |
ID of the variant for A/B test |
| variantName | string | FV5PIcmhmN0p |
ID of the recommendation campaign assigned to the test variant |
