Skip to main content
POST
Get Sponsored Ad

Authorizations

x-api-key
string
header
required

Headers

x-api-key
string
required
x-site-id
integer<int64>
required

Body

application/json
zoneIds
number<float>[]
required

One or more zone IDs to request decisions for.

keywords
string[]
required

Keyword signals used for targeting — e.g. destination names or product categories.

siteId
number<float>

Your site ID. Can be passed here instead of the x-site-id header.

count
number<float>

Maximum number of ads to return per zone.

eventIds
object[]

Contextual event identifiers for the current page or session.

ip
string

The end-user's IP address, used for geo-targeting.

user
string

A stable user identifier for frequency capping and personalisation.

Whether the user has given GDPR consent.

customTargeting
object

Freeform key-value targeting parameters. Values can be strings, numbers, or arrays of either.

Response

Successful operation

user
object

A stable user identifier for frequency capping and personalisation.

decisions
object