Skip to main content
POST
/
preview
/
recommendation
/
search
/preview/recommendation/search
curl --request POST \
  --url https://api.criteo.com/preview/recommendation/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nbRequestedProducts": 123,
  "partnerId": 123,
  "adId": 123,
  "adSetId": 123,
  "userId": "<string>"
}
'
{
  "extraInfos": [
    123
  ],
  "products": [
    {
      "alternativeClickUrl": "<string>",
      "brand": "<string>",
      "clickUrl": "<string>",
      "description": "<string>",
      "googleCategory": "<string>",
      "hasVariants": true,
      "imageUrl": "<string>",
      "name": "<string>",
      "price": 123,
      "productExternalId": "<string>",
      "relevancyScore": 123,
      "retailPrice": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Recommendation request parameters

nbRequestedProducts
integer<int32>
required

Amount of products to recommend.

partnerId
integer<int32>
required

Id of the partner.

adId
integer<int32>

Id of the Ad. This field is optional, it allows to setup Reco controls at Ad level.

adSetId
integer<int32>

Id of the AdSet. This field is optional and is resolved automatically for adsets previously configured.

identityType
enum<string>

Type of the user identifier (CtoBundle, Idfa, Gaid...) Optional if its type is CtoBundle

Available options:
CtoBundle,
Idfa,
Gaid,
InternalUserId
userId
string

Used to retrieve user events from Criteo trackers.

Response

200 - application/json

Success

Recommendation response

extraInfos
integer<int32>[] | null

Additional information in case of warnings, errors...

products
object[] | null

Recommended products