Skip to main content
GET
/experimental/retail-media/accounts/{account-id}/change-history-entries

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://api.criteo.com/oauth2
Token URL
https://api.criteo.com/oauth2/token
FlowClient Credentials
Token URL
https://api.criteo.com/oauth2/token
Scopes1
RetailMedia_Campaign_Read
Grants Read access to the capabilities from the Campaign domain, for RetailMedia applications

Path Parameters

account-id
string
required

External opaque identifier of the advertiser account whose change history is requested.

Query Parameters

campaign-ids
string[]

When provided, only changes for these external opaque campaign identifiers are returned. Entries for campaigns outside the caller's account access are excluded without revealing whether the campaign exists. Omission is equivalent to an empty array.

end-time
string<date-time>

Inclusive upper bound on change time, in UTC (ISO-8601 date-time). Defaults to the request time when omitted.

entity-types
string[]

Restrict results to changes on the given entity types (see the entity type field). Unknown values are not errors; they simply match no entries. Omission is equivalent to an empty array.

event-types
string[]

Restrict results to specific change-event types (see eventType). When omitted, all supported event types may be returned. Unknown values are not errors; they simply match no entries. Omission is equivalent to an empty array.

limit
integer<int32>
default:25

Maximum number of change-history entries to return in a single page.

Required range: 1 <= x <= 100
line-item-ids
string[]

When provided, only changes for these external opaque line-item identifiers are returned. Entries for line items outside the caller's account access are excluded without revealing whether the line item exists. Omission is equivalent to an empty array.

offset
integer<int32>
default:0

Zero-based index of the first change-history entry to return.

Required range: x >= 0
start-time
string<date-time>

Inclusive lower bound on change time, in UTC (ISO-8601 date-time). Defaults to 7 days before the request time when omitted.

Response

200 - application/json

Change history entries retrieved.

A top-level object that encapsulates a Criteo API response for several entities and metadata.

data
object[] | null
errors
object[] | null

Errors that occured during this call.

meta
object | null

Offset based pagination metadata.

warnings
object[] | null

Warnings that occured during this call.