Skip to main content
POST
Recommend For User

Authorizations

api_key
string
query
required

Headers

referer
string

Body

application/json
tenant
string
required

Identifier associated with the API integration

market
string
required

Market identifier

type
string
required

Type of the recommendation, e.g. cross_sell

locale
string | null

Locale identifier

limit
integer | null

Maximum number of recommendations returned.

Required range: 1 <= x <= 128
user_id
string | null

Customer identifier

session_id
string | null

Session identifier

dsid
string | null

Populated for integrations performed by Depict.ai only. Depict.ai Session Id

Minimum string length: 1
document_referrer
string | null
metadata
Metadata · object | null

Metadata that can be used to modify the behaviour of the recommendation system

Response

Successful Response

displays
Displays · object[]
required
error
string | null
variant
integer | null
experiment_id
string | null