Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The ad impression/view notification should be sent when the visitor has seen the sponsored content.
POST https://{cluster-id}.elevate-api.cloud/api/storefront/v3/notifications/ad-impression
Request header parameters
| Name | Description | Example |
|---|---|---|
Accept-Encoding | Allows responses to be compressed using Gzip. | gzip |
Request query parameters
| Name | Description | Example |
|---|---|---|
customerKey* | A key that uniquely identifies the current visitor. Using UUIDs as keys are recommended This field is required unless userContext is set to ANONYMOUS or UNPERSONALIZED in which case it is not allowed.If userContext is set to ‘SYNTHETIC’ this is optional. | e3921377-18a2-47c9-a449-06b894898623 |
market* | Must match the corresponding market identifier in the data feed. | UK |
sessionKey* | A unique key, identifying the session. Using UUIDs as keys are recommended. This field is required unless userContext is set to ANONYMOUS in which case it is not allowed.If userContext is set to SYNTHETIC this is optional. | 0b05119e-eeb8-418a-bbfb-defa0dde417e |
userContext | Specifies the level of consent for data tracking. If omitted, the request will be treated as if PERSONALIZED is used. See user context for more details. Supported values: PERSONALIZED, UNPERSONALIZED, ANONYMOUS, SYNTHETIC. | PERSONALIZED |
Request body example
{
"ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"
}
Request body schema
| Name | Type | Description |
|---|---|---|
| ticket* | string | Unique ticket for the Elevate object. Examples: "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7" |
Example request
curl -i \
-X POST \
-H 'Accept-Encoding: null' \
-H 'Content-Type: application/json;charset=utf-8' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/notifications/ad-impression?customerKey=customerKey&market=market&sessionKey=sessionKey&userContext=userContext" \
-T request-body.file
Response codes
| Status | Description |
|---|---|
204 | Notification was received successfully. |
400 | Invalid or missing required arguments. |
500 | Server error such as cluster unavailable or busy. The response body may contain more information about the error. |