Skip to main content
POST
/
preview
/
reports
/
top-products
/preview/reports/top-products
curl --request POST \
  --url https://api.criteo.com/preview/reports/top-products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "GenerateTopProductsReport",
    "attributes": {
      "timezone": "Europe/Paris",
      "startDate": "2024-01-01T00:00:00.0000000+00:00",
      "endDate": "2024-01-04T00:00:00.0000000+00:00",
      "advertiserId": "1234",
      "limit": 200,
      "rankProductsBy": "Clicks",
      "dimensions": [
        "CampaignId",
        "Campaign",
        "AdSetId",
        "AdSet",
        "ProductId",
        "Product",
        "ProductUrl",
        "Brand",
        "Category"
      ],
      "metrics": [
        "Clicks",
        "Ctr",
        "Visits",
        "Sales",
        "Cost",
        "Revenue",
        "Displays"
      ],
      "currency": "EUR",
      "brands": [
        "Brand1",
        "Brand2"
      ],
      "categoryIds": [
        "6666",
        "7777"
      ],
      "campaignIds": [
        "9999"
      ],
      "adSetIds": [
        "11111",
        "22222"
      ],
      "adSetStatus": [
        "Active",
        "NotRunning"
      ]
    }
  }
}
'
{
  "data": [
    {
      "attributes": {
        "rows": [
          {}
        ]
      },
      "type": "<string>"
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "detail": "<string>",
      "instance": "<string>",
      "source": {},
      "stackTrace": "<string>",
      "title": "<string>",
      "traceId": "<string>",
      "traceIdentifier": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "<string>",
      "detail": "<string>",
      "instance": "<string>",
      "source": {},
      "stackTrace": "<string>",
      "title": "<string>",
      "traceId": "<string>",
      "traceIdentifier": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

A top-level object that encapsulates a Criteo API request for a single value object.

data
object

A value resource exposed by the API.

Response

Success

A top-level object that encapsulates a Criteo API response for several value objects.

data
object[] | null
errors
object[] | null
read-only

Errors that occured during this call.

warnings
object[] | null
read-only

Warnings that occured during this call.