(GET) Push Click Stats
This is an endpoint where you can send your analytics data to our server. If you want to see your metrics , like number of clicks, CTR, etc, to be displayed in our dashboard, you have to send the click data to this endpoint. When user clicks on one of the search result, you have to send both the session ID and the search ID.
GET#
#
HeaderField | Type | Description |
---|---|---|
x-forwarded-for | String | IP of the user |
#
Request Header Example#
Request BodyField | Type | Description |
---|---|---|
event | String | Event's name |
method optional | String | Search method (strict, fuzzy, or soft) |
url optional | String | Product url |
searchId | String | Generated unique id of the search (every search action must have an unique id eventhough the user is the same) |
searchQuery | String | Search keyword that typed by the user |
searchCounter optional | String | Number of search that user already did |
sessionId | String | Session id of the user |
token | String | Token of the engine (token from the search layer) |
itemId optional | String | Item id that sent by our search result |
productId | String | Unique id of the products (product id from your site) |
title | String | The name/title of product |
timeZone | String | Timezone of the user |
#
Param Example#
Success 200Field | Type | Description |
---|---|---|
success | Boolean | Request was successful |