List of Endpoints
This section contains all documentation on implementing our newest API version, version 2022-07.
This new version includes Open Auction (CPC campaigns) and Preferred Deals (CPM campaigns) Ads.
Synchronous Endpoints
- All campaign operations except for Catalogs are achieved through synchronous endpoints
Asynchronous Endpoints
- Catalogs and Reports are requested & retrieved through asynchronous endpoints
Access to Preferred Deals Endpoints
Our Preferred Deals capabilities are currently only accessible to our Retailer partners as part of our beta launch.
To gain access to Preferred Deals documentation, please reach out to your Criteo Account Manager.
List of Endpoints
Campaign Endpoints
| Entity | Method | Endpoint | Description |
|---|---|---|---|
| Accounts | GET | /accounts | Lists all Accounts associated with your API credentials |
| Brands | GET | /accounts/{accountId}/brands | Lists all Brands associated with the Account |
| Retailers | GET | /accounts/{accountId}/retailers | Lists all Retailers associated with the Account |
| Catalogs | POST | /accounts/{accountId}/catalogs | Requests the Catalog associated with the Account |
GET | /catalogs/{catalogId}/status | Retrieves the status of the requested Catalog | |
GET | /catalogs/{catalogId}/output | Retrieves the output of a Catalog | |
| Balances | GET | /accounts/{accountId}/balances | Lists all Balances on the Account |
POST | /balances/{balanceId}/campaigns/append | Adds one or more Campaigns to the Balance | |
POST | /balances/{balanceId}/campaigns/delete | Removes one or more Campaigns from the Balance | |
GET | /balances/{balanceId}/campaigns | Lists all Campaigns on the Balance | |
| Campaigns | GET | /accounts/{accountId}/campaigns | Lists all Campaigns within the Account |
POST | /accounts/{accountId}/campaigns | Creates a new Campaign within the Account | |
GET | /campaigns/{campaignId} | Retrieves a single Campaign | |
PUT | /campaigns/{campaignId} | Updates a single Campaign | |
| Line items (Generic) | GET | /accounts/{accountId}/line-items | Lists all Line items associated with the Account |
GET | /line-items/{lineItemId} | Retrieves a single Line item | |
| Promoted Products (Generic) | POST | /line-items/{lineItemId}/products/append | Adds one or more Products to the Line Item |
POST | /line-items/{lineItemId}/products/delete | Removes one or more Products from the Line Item | |
GET | /line-items/{lineItemId}/products | Lists all Products on the Line Item | |
POST | /line-items/{lineItemId}/products/pause | Pause Products on a Specific Line Item | |
POST | /line-items/{lineItemId}/products/unpause | Reactivate Paused Products on a Specific Line Item | |
| Line items (Open Auction) | GET | /auction-line-items/{lineItemId} | Retrieves a single Open Auction Line item |
PUT | /auction-line-items/{lineItemId} | Updates a single Open Auction Line item | |
GET | /campaigns/{campaignId}/auction-line-items | Retrieves all Open Auction line items for a single Campaign | |
POST | /campaigns/{campaignId}/auction-line-items | Creates an Open Auction Line item within a single Campaign | |
| Negative Keyword Targeting | GET | /auction-line-items/{line-item-id}/targeting/keywords | Get All Negated Keywords on a specific Line Item |
POST | /auction-line-items/{line-item-id}/targeting/keywords/append | Add Negated Keywords to a Specific Line Item | |
POST | /auction-line-items/{line-item-id}/targeting/keywords/delete | Remove Negated Keywords from a Specific Line Item |
Analytics Endpoints
- Reports are requested & retrieved through asynchronous endpoints
| Entity | Method | Endpoint | Description |
|---|---|---|---|
| Reports | POST | /reports/campaigns | Requests a Campaign Report |
POST | /reports/line-items | Requests a Line Item Report | |
GET | /reports/{reportId}/status | Retrieves the status of the requested Report | |
GET | /reports/{reportId}/output | Retrieves the output of the Report |
Updated over 1 year ago