GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
Guides

Page Style Template

Endpoints

VerbEndpointDescription
GET/entities/{entityId}/endpoint-pathGets all items from Entity blablabla
POST/entities/{entityId}/endpoint-pathCreates a new item from Entity blablabla
PUT/entities/{entityId}/endpoint-pathUpdates a specific Entity item blablabla

 

{name} Attributes

AttributeData TypeDescription
id*stringEntity ID, lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi.

Acceptable values: int64
Default: NA
Writeable? N / Nullable? N
namestringEntity name, lorem ipsum dolor sit amet....

Acceptable values: up to 255-chars string
Default: NA
Writeable? Y / Nullable? N
entityIdslistList of Entity ID, lorem ipsum dolor sit amet...

Accepted values: list of int32 or strings
Writeable? N / Nullable? N
budgetdecimalBudget cap, lorem ipsum dolor sit amet...

Accepted values: equals or greater than zero
Default: null
Writeable? Y / Nullable? Y
isAutoDailyPacing*booleanLorem ipsum dolor sit amet...

Accepted values: true, false
Default: false
Writeable? Y / Nullable? N
clickAttributionWindow*enumPost-click attribution window

Accepted values: 7D, 14D, 30D
Default: 30D
Writeable? Y / Nullable? N
createdAttimestampTimestamp of entity creation, in UTC

Accepted values: yyyy-mm-ddThh:mm:ss±hh:mm (in ISO-8601 )
Writeable? N / Nullable? N

* Required

[GET]

https://api.criteo.com/{version}/retail-media/..../...

Sample Request

curl -X GET "https://api.criteo.com/{version}/retail-media/.../..." \
    -H "Authorization: Bearer <MY_ACCESS_TOKEN>"

Sample Response

{
    "foo": "bar"
}

[POST]

https://api.criteo.com/{version}/retail-media/.../...

Sample Request

curl -L -X POST 'https://api.criteo.com/{version}/retail-media/.../...' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <MY_ACCESS_TOKEN>'
-d '{
        "foo": "bar"
    }'

Sample Response

{
    "foo": "bar"
}

Responses

ResponseDescription
🟢 200Call executed with success
🟢 201Entity was created successfully
🔴 400
🔴 404
🔴 406
🔴 409
🔴 415