• Our APIs respond with data, errors, and metadata blocks where appropriate

• For example, metadata appears only for paginated responses

• A response expected to return multiple entities may contain both data and errors blocks

• Entity IDs are unique across all Retail Media entities

{
    "data": [
        {
            "type": "{entityType}",
            "id": "{entityId}",
            "attributes": {
                "{fieldName}": {numericValue},
                "{fieldName}": "{stringValue}",
                // ...
            }
        },
   
        // ...
   
        {...}
    ],
    "errors": [
        {
            "traceId": "{traceId}",
            "type": "{errorType}",
            "code": "{errorCode}",
            "instance": "{uri}",
            "title": "{errorTitle}",
            "detail": "{errorDetail}",
            "source": {
                "{fieldName}": "{fieldPath}",
                // ...
            }
        },
 
        // ...
         
        {...}
    ],
    "metadata": {
        "totalItemsAcrossAllPages": {numberOfEntities},
        "currentPageSize": {pageSize},
        "currentPageIndex": {pageIndex},
        "totalPages": {numberOfPages},
        "nextPage": "https://{endpoint}?pageIndex={pageIndex}&pageSize={pageSize}",
        "previousPage": "https://{endpoint}?pageIndex={pageIndex}&pageSize={pageSize}"
    }
}

Data Attributes

Error Attributes

Pagination

• Pagination is supported via query parameters for a subset of endpoints that list multiple entities

• Results are returned in ascending order by id

1. List all Accounts associated with your API credentials

2. List all Brands associated with the Account

3. List all Retailers associated with the Account

4. List all Campaigns within the Account

5. List all Line Items within the Campaign

6. List all Promoted Products on the Line Item

7. List all Balances on the Account

8. List all Campaigns on the Balance

HTTP Response Codes

• 200 OK: Request successful

• 201 Created: New entity was successfully created

• 207 Multi-Status: May occur when operating on multiple entities, such as the call resulting in some successes but also some failures

• 400 Bad Request: Improper syntax, check your call structure

• 401 Unauthorized: Unauthenticated, refresh your access token

• 403 Forbidden: Insufficient rights to perform this action

• 404 Not Found: Resource not found, check your entity IDs in the call

• 408 Timeout: Request timed out

• 409 Conflict: Request conflicts with something, such as a campaign name that already exists

• 429 Too Many Requests: Too many requests

• 5xx: Something's wrong on Criteo's end...