Sign in

Welcome to our Support Center

Get help with integration and live campaigns

Welcome to our Support Center. Get help with integration and live campaigns

Marketing API details

The Criteo API can be accessed using this url: https://api.criteo.com/marketing

Endpoints

Request Type

Endpoint

Objective

Parameters

Response

POST

/oauth2/token

Retrieve token that will allow you to post request to the API

client_id (mandatory)

client_secret (mandatory)

grant_type (mandatory)

 

GET

/portfolio

Retrieve your advertiserId(s)

none

 

GET

/v1/audiences

Fetch the list of audiences

advertiser_id: int 
(optional)

List of audiences: JSON

Forbidden (wrong advertiser_id)

POST

/v1/audiences/userlist/

Create an audience

advertiser_id: int
(mandatory)

 

name: string
(mandatory)

 

description:string
(optional)

audience id: int

PUT

/v1/audiences/<audience_id>

Change an audience metadata

name: string
(optional)

description: string
(optional)

OK/ERROR

PATCH

/v1/audiences/userlist/<audience_id>

Add/Remove users to an audience

operation: string (ADD  or REMOVE) 
(mandatory)

schema: string
(EMAIL or MADID)
(mandatory)

identifiers: list of string
(mandatory)

OK/ERROR

DELETE 

/v1/audiences/userlist/<audience_id>/users

Remove all users from an audience

None

OK/ERROR

DELETE 

/v1/audiences/<audience_id>

Delete an audience

None

OK/ERROR

 

Parameters 

Parameter

Used for...

Details

client_id

Token retrieval

- Your e-mail (same login as for Criteo Management Center)

client_secret

Token retrieval

- Your password (same login as for Criteo Management Center)

advertiser_Id

Specific client data retrieval

Your client ID

Retrieved from /portfolio endpoint

- Retrieved from /client’s endpoint

name

Specifics data provided by the client

- Your client name

description

Specifics data provided by the client

-Varchar

name

Change an audience metadata

- String

description

Change an audience metadata

- String

 

operation

Define the type of change that the client wants to perform

(add or remove users from an audience)

- String with value ADD or REMOVE

schema

Type of data provided by the client

- String with value EMAIL or MADID

identifiers

Data provided by the client

- List of string

- Plain text emails

- MD5 of emails

- SHA256 of MD5 of emails

- Device Ids (IDFA, AAID)

Note: the API doesn't accept cookies ids from DMPs

  

Limit to the number of identifiers per request:

The number of identifiers is limited to 50,000 per ADD/REMOVE request. If your audience segment is larger than 50,000 entries, you need to split the file in 50,000 line portions and upload each of them individually.

Limit to the number of requests per client:

The number of calls is limited to 200 requests per minute, per client/IP. 

 

Response codes 

Response code

Reason

200

Success

400

Bad request, invalid syntax

401

Authentication failed

403

Access forbidden

404

Not found

409

Conflict, name already in use

429

Rate limit reached, no more than 200 requests per minute, per client

500

Unknown error

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk