API Reference
Release NotesPostman CollectionUI LibrariesClient Libraries

Retrieve engagements

get
https://retail.media-cnstrc.com/v1/engagements

šŸ” This endpoint requires HTTP Bearer authentication.
For authenticating with Bearer token, required scopes are: retail_media.engagements(r).

Beta: This endpoint is in beta and may change. Retrieve advertiser engagements of the retailer, along with their suspension status in the given index.

Query Params
string
required

The key of the index to use.

length ā‰„ 1

When provided, only engagements whose advertiser identifier, as defined in the items catalog, matches this value are returned.

Opaque cursor returned by a previous response. When omitted, the first page is returned. Must be used with the same filters as the request that returned it.

integer
1 to 1000
Defaults to 100

Maximum number of engagements to return in a single page.

Responses

Updated about 4 hours ago

Did this page help you?
Language
Credentials
Bearer
token
LoadingLoadingā€¦
Response
Choose an example:
application/json

Updated about 4 hours ago

Did this page help you?