Search events
Note: Your integration may add custom parameters. The tables only list parameters that exist in Synerise and SDKs/APIs by default.
item.search
An AI search request was made.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that 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 | autocomplete |
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. |
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 exist in all events |
| productId | string | 16874 |
ID of the viewed 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 | autocomplete |
The search type that was used |
| 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. |
