Ad Impression¶

https://{cluster-id}.elevate-api.cloud/api/storefront/v3/notifications/ad-impression

POST¶

The ad impression/view notification should be sent when the visitor has seen the sponsored content. See here for more information.

~~For retail media only.~~

Request¶

Header parameters¶

Name	Description	Example
Accept-Encoding	Allows responses to be compressed using Gzip.	`gzip`

Query parameters¶

Name	Description	Example
customerKey Required	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 Required	Must match the corresponding market identifier in the data feed.	`UK`
sessionKey Required	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`

Supported Content-Type¶

application/json;charset=utf-8
text/plain;charset=utf-8

Request body¶

Example

application/json;charset=utf-8

{
  "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"
}

Schema

TicketNotification¶

The ticket is a unique string for an object generated by Elevate. It is used with notifications as a method to collect behavioural data.

Name	Type	Description
ticket Required	string	Unique ticket for the Elevate object. Examples: `"Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7"`

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¶

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.