Discard
GuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceChangelogDiscussionsLog In

API Pattern

Base URL

https://api.criteo.com/2022-04/retail-media/{endpoint}

Synchronous Endpoints

  • All campaign operations except for Catalogs are achieved through synchronous endpoints

Operation

Method

Endpoint

Create an entity

POST

/{plural-parent-entity-name}/{parentEntityId}/{plural-entity-name}

Delete from a list

POST

/{plural-parent-entity-name}/{parentEntityId}/{plural-entity-name}/delete

Append to a list

POST

/{plural-parent-entity-name}/{parentEntityId}/{plural-entity-name}/append

Get all entities

GET

/{plural-parent-entity-name}/{parentEntityId}/{plural-entity-name}

Get a specific entity

GET

/{plural-entity-name}/{entityId}

Update a specific entity

PUT

/{plural-entity-name}/{entityId}

📘

  • Create operations using the POST method expect every Required (R) field; omitting Optional (O) fields will set those fields to Default values
  • Update operations using the PUT method expect every Write (W) field; omitting these fields is equivalent to setting them to null, if possible

Asynchronous Endpoints

  • Catalogs and Reports are requested & retrieved through asynchronous endpoints

Operation

Method

Endpoint

Create a resource request

POST

/{plural-parent-entity-name}/{parentEntityId}/{plural-entity-name}
or
/{plural-parent-entity-name}/{plural-entity-name}

Retrieve the status of the requested resource

GET

/{plural-entity-name}/{entityId}/status

Retrieve the output of the requested resource

GET

/{plural-entity-name}/{entityId}/output

Bulk Calls

Our Reporting endpoints allow for bulk operations. Specifically, through the 2 following endpoints

  • POST /reports/campaigns
  • POST /reports/line-items
    you will be able to send us several CampaignIds or LineItemIds, with a maximum of 50 ids per call.

To do so, please use the following attributes and terminology in one or the other endpoint (example below for the POST /report/campaigns endpoint, same applies to the line-item endpoint):

  • when requesting a single Id then id: CampaignId, OR
  • when requesting several Ids then ids: ["CampaignId1","CampaignId2",..."CampaignIdn"],

Important: Do not use id and ids in the same call, this will lead to un-valid request response.
For more details, refer to our Report Request Attributes.

When sending more than 50 ids, you will get the following error

{"errors":
[
  {"code":"exceeded-ids-cap",
   "title":"Requests are capped for 50 unique ids, 51 were provided",
   "type":"validation",
   "traceId":"aa47dd83-8ca9-4a79-a179-ad5be6932ff1",
   "instance":"/api/v1/reports/line-item",
   "detail":"ids Requests are capped for 50 unique ids, 51 were provided (Value: \"1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51\")",
   "source":{"ids":"data/attributes/ids"}}
   ]}

Did this page help you?