Skip to main content
POST
/
preview
/
retail-media
/
insights
/
share-of-voice
/preview/retail-media/insights/share-of-voice
curl --request POST \
  --url https://api.criteo.com/preview/retail-media/insights/share-of-voice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "accountId": "<string>",
      "dimensions": [],
      "endDate": "2023-11-07T05:31:56Z",
      "metrics": [],
      "startDate": "2023-11-07T05:31:56Z",
      "accountIds": [
        "<string>"
      ],
      "activationPlatforms": [],
      "aggregationLevel": "category",
      "brandIds": [
        "<string>"
      ],
      "budgetModels": [],
      "campaignType": "all",
      "format": "json-compact",
      "keywords": [
        "<string>"
      ],
      "keywordTypes": [],
      "retailerIds": [
        "<string>"
      ],
      "servedCategories": [
        "<string>"
      ]
    },
    "type": "<string>"
  }
}
'
{
  "data": {
    "attributes": {
      "createdAt": "<string>",
      "expiresAt": "<string>",
      "fileSizeBytes": 123,
      "md5CheckSum": "<string>",
      "message": "<string>",
      "rowCount": 123
    },
    "id": "<string>",
    "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

application/json

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

data
object
required

A value resource exposed by the API.

Response

200 - application/json

Success

A top-level object that encapsulates a Criteo API response for a single entity.

data
object

A domain entity exposed by the API, identified by a unique id.

errors
object[] | null
read-only

Errors that occured during this call.

warnings
object[] | null
read-only

Warnings that occured during this call.