Your integration may add custom parameters. The tables only list parameters that exist in Synerise and SDKs/APIs by default.
item.search
AI search returned response to a search request.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| totalResults | number | 45 |
The number of results returned by the search. |
| query | string | shoes |
The query string that was searched. |
| personalized | boolean | true |
Informs if the search was personalized by the AI. |
| total | number | 45 |
The number of results returned by the search. |
| filters | array of objects | [{"name": "deleted","value": "!= 1"}] |
Filters that were used in the search |
| correlationId | string | ef3f2774b3c14ff3fb3c892c4da2d4ae |
Correlation ID for pagination. |
| index | string | afc98c53b968b4c47ff1e21e7219d4f41668083405 |
ID of the search index that was used. |
| appliedRules | array of numbers | [435,234] |
Query rules that were applied to the search |
| searchType | string | full-text-search |
The search type |
| Additional parameters | any | lorem ipsum |
Additional parameters that were added to the search request, in the params parameter. |
| Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, some parameters are added automatically. |
item.search.classification
AI search returned response to a search request using predictive filtering.
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| chosenCategories | object | [{"score": 275,"reliabilityLevel":"VeryHigh","ctr": "0.9581881533101045","actions": ["staticFilter","elasticFilter","boosting"],"category":"boots"}] |
The list of categories returned by predictive filtering with: the score, average CTR for all categories, reliability level, filter options; |
| categories[reliabilityLevel] | object | ["boots"] |
An array of predicted categories at a specific reliability level (low, medium, high, very high, certain) |
| query | string | shoes |
The query string that was searched. |
| index | string | afc98c53b968b4c47ff1e21e7219d4f41668083405 |
ID of the search index that was used. |
| 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. |
item.search.click
An item was clicked in an AI search result.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| item | string | 16874 |
ID of the clicked item. Must be the same as the item's itemId in the item feed and sku in transaction events. |
| 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. |
| position | integer | 2 |
Position of the clicked item in the search results |
| searchType | string | full-text-search |
The search type |
| Parameters added by Synerise Web SDK | various | n/a | If the event was sent from a web page or an email with a tracking code, some parameters are added automatically. |
suggestion.search
A request to a suggestion index has been sent.
The suggestion.search and suggestion.search.click events are free until December 31, 2025. After that date, you will be charged for these events.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| totalResults | number | 45 |
The number of returned suggestions |
| searchType | string | full-text-search |
The search type |
| query | string | shoes |
The query string that was searched. |
| total | number | 45 |
The number of returned suggestions |
| index | string | bcd98c53b968b4c47ff1e21e7219d4f41668083679 |
ID of the suggestion index that was used. |
| correlationId | string | ef3f2774b3c14ff3fb3c892c4da2d4ae |
Correlation ID for pagination. |
suggestion.search.click
An item from a suggestion was clicked in an AI search result.
The suggestion.search and suggestion.search.click events are free until December 31, 2025. After that date, you will be charged for these events.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| searchType | string | full-text-search |
The search type |
| position | integer | 2 |
Position of the clicked suggestion in the search results |
| correlationId | string | ef3f2774b3c14ff3fb3c892c4da2d4ae |
Correlation ID for pagination. |
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 |