List of Endpoints - Criteo Docs

Overview

This section contains all the latest API endpoints that have been released in preview, and that may be available in the next stable API version. This new version includes both Onsite Sponsored Products (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.

List of Endpoints (Including Preferred Deals)

Accounts

Method	Endpoint	Description
GET	`/accounts`	Lists all Accounts associated with your API credentials

Brands

Method	Endpoint	Description
GET	`/accounts/{accountId}/brands`	Lists all Brands associated with the Account

Retailers

Method	Endpoint	Description
GET	`/accounts/{accountId}/retailers`	Lists all Retailers associated with the Account

Creatives

Method	Endpoint	Description
GET	`/accounts/{accountId}/creatives`	Lists all Creatives associated with the Account
POST	`/assets`	Upload creative asset image file
GET	`/{retailer-id}/templates`	Get a list of available creative templates for a specified retailer
POST	`/{account-id}/creatives`	Create a new account creative
GET	`/{account-id}/creatives/{creative-id}`	Get account creative by creative ID
PUT	`/{account-id}/creatives/{creative-id}`	Update an existing creative
GET	`/line-items/{line-item-id}/product-buttons/{product-button-id}`	Get a single Product SKU collection (product button)
PUT	`/line-items/{line-item-id}/product-buttons/{product-button-id}`	Update a Product SKU collection (product button)
DELETE	`/line-items/{line-item-id}/product-buttons/{product-button-id}`	Delete a Product SKU collection (Product Button)
GET	`/line-items/{line-item-id}/product-buttons`	Get all the Product SKU collection (product buttons) associated with a line item
POST	`/line-items/{line-item-id}/product-buttons/create`	Create a new Product SKU collections (product buttons) on a line item

Pages

Method	Endpoint	Description
GET	`/retailers/{retailerId}/pages`	List all Pages associated with the Retailer

Audiences

Method	Endpoint	Description
GET	`/accounts/{accountId}/audiences`	Lists all Audiences associated with the Account
POST	`/accounts/{accountId}/audiences`	Creates a new Audience within the Account

Catalog

Method	Endpoint	Description
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

Method	Endpoint	Description
GET	`/categories/{categoryId}`	Search for categories based on category ID
GET	`/categories?retailerId={retailerId}&?textSubstring={textSubstring}&pageIndex={pageIndex}&pageSize={pageSize}`	Search for retailer categories and filter down by a specific category name

Balances

Method	Endpoint	Description
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

Method	Endpoint	Description
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)

Method	Endpoint	Description
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)

Method	Endpoint	Description
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

Keywords

Method	Endpoint	Description
GET	`/line-items/{LineItemId}/keywords`	Retrieve a set of positive and negative keywords for a line item
POST	`line-items/{LineItemId}/keywords/add-remove`	Add or remove keywords from a line item
POST	`/line-items/{LineItemId}/keywords/set-bid`	Add or remove keywords from a line item.

Line items (Open Auction)

Method	Endpoint	Description
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
GET	`/line-items/{lineItemId}/bid-multipliers`	Returns all bid multipliers for valid page types of the specified line item.
PUT	`/line-items/{lineItemId}/bid-multipliers`	Replaces all existing bid multipliers with the provided bid multipliers or the default value (1.0). Note: A PUT operation with an empty attributes object will reset all values to their default.

Negated keywords (Open Auction)

Method	Endpoint	Description
GET	`/auction-line-items/{lineItemId}/targeting/keywords`	Get All Negated Keywords on a specific Line Item
POST	`/auction-line-items/{lineItemId}/targeting/keywords/append`	Add Negated Keywords to a Specific Line Item
POST	`/auction-line-items/{lineItemId}/targeting/keywords/delete`	Remove Negated Keywords from a Specific Line Item

Line items (Preferred Deals)

Method	Endpoint	Description
GET	`/preferred-line-items/{lineItemId}`	Retrieves a single Preferred Deal Line item
PUT	`/preferred-line-items/{lineItemId}`	Updates a single Preferred Deal Line item
GET	`/campaigns/{campaignId}/preferred-line-items`	Retrieves all Preferred Deals line items for a single Campaign
POST	`/campaigns/{campaignId}/preferred-line-items`	Creates a Preferred Deals Line item within a single Campaign

Store targeting (Preferred Deals)

Method	Endpoint	Description
GET	`/preferred-line-items/{lineItemId}/targeting/stores`	Retrieves all targeted Stores for a single Preferred Deals Line item
PUT	`/preferred-line-items/{lineItemId}/targeting/stores`	Update all targeted Stores for a single Preferred Deals Line item
POST	`/preferred-line-items/{lineItemId}/targeting/stores/append`	Add targeted Stores for a single Preferred Deals Line item
POST	`/preferred-line-items/{lineItemId}/targeting/stores/delete`	Remove targeted Stores for a single Preferred Deals Line item

Added-to-basket targeting (Preferred Deals)

Method	Endpoint	Description
GET	`/preferred-line-items/{lineItemId}/targeting/add-to-basket`	Retrieves all targeted added-to-basket SKU IDs and Categories for a single Preferred Deals Line item
PUT	`/preferred-line-items/{lineItemId}/targeting/add-to-basket`	Update all targeted added-to-basket SKU IDs and Categories for a single Preferred Deals Line item
POST	`/preferred-line-items/{lineItemId}/targeting/add-to-basket/append`	Add targeted added-to-basket SKU IDs and Categories for a single Preferred Deals Line item
POST	`/preferred-line-items/{lineItemId}/targeting/add-to-basket/delete`	Remove targeted added-to-basket SKU IDs and Categories for a single Preferred Deals Line item

Audience targeting (Preferred Deals)

Method	Endpoint	Description
GET	`/preferred-line-items/{lineItemId}/targeting/audiences`	Retrieves all targeted Audiences for a single Preferred Deals Line item
PUT	`/preferred-line-items/{lineItemId}/targeting/audiences`	Update all targeted Audiences for a single Preferred Deals Line item
POST	`/preferred-line-items/{lineItemId}/targeting/audiences/append`	Add targeted Audiences for a single Preferred Deals Line item
POST	`/preferred-line-items/{lineItemId}/targeting/audiences/delete`	Remove targeted Audiences for a single Preferred Deals Line item

Analytics Endpoints

Reports are requested & retrieved through asynchronous endpoints

Method	Endpoint	Description
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

​Overview

​Synchronous Endpoints

​Asynchronous Endpoints

​List of Endpoints (Including Preferred Deals)

​Accounts

​Brands

​Retailers

​Creatives

​Pages

​Audiences

​Catalog

​Categories

​Balances

​Campaigns

​Line items (Generic)

​Promoted Products (Generic)

​Keywords

​Line items (Open Auction)

​Negated keywords (Open Auction)

​Line items (Preferred Deals)

​Store targeting (Preferred Deals)

​Added-to-basket targeting (Preferred Deals)

​Audience targeting (Preferred Deals)

​Analytics Endpoints

​What’s next