- Fill your API Key (provided by Imagino)
- Add Event type (For example, "product seen")
- Add Event value (For example, the SKU of the product)
- Fill your custom data (Optional)
- Fill the userId (Optional)
The Tag set automatically 2 cookies for each visitor :
_imo_browser_id
set for 13 months_imo_session_id
set for the session
The imagino Tag server side SDK consists of one API endpoint to be called. POST https://tag.imagino.com/#API_KEY#/events
The following payload must be respected:
{
"data": {
"event": {
"sku": "string"
},
"user": {
"utm_source": "string"
}
},
"deviceId": "80faad33-3ce1-400c-88aa-939c2ad8058a",
"sessionId": "a8c36ddf-88ee-4e3c-8f0e-e516f80b551d",
"userId": "12345",
"eventType": "string",
"eventValue": "12345",
"host": "www.imagino.com"
}
Below is a description of the different payload variables.
Key | Type | Required | Description |
---|---|---|---|
host | String | Required | URL of the calling website. Needs to be whitelisted and associated with the tag API key. |
sessionId | String | Required | Id of the session. Needs to be generated server side. |
deviceId | String | Required | Id associated with the device or browser. |
eventType | String | Required | Name of the event. For exemple, product seen. |
eventValue | String, Number | Required | Value associated with the event. For exemple, the SKU of the product. |
data.event | Object | Optional | Json object contaning the value associated with the event. For exemple, product price, categorie or name. |
data.user | Object | Optional | Json object contaning the value associated with the user. For exemple, name or UTM values. |
The Imagino Tag API always responds with a code 200.
- On success, API responds with
OK
. - On error, API responds with
NOK
and the error description.NOK: no referrer - Host is empty
NOK: site - Host is not whitelisted
NOK: <json cannot be unserilzed> - Payload does not respect the format NOK: unauthorized - Wrong API key
NOK: event - Error while processing the event