Get Related Recommendations
Returns recommendations for products related to the search query. Note that this endpoint takes the same request body as the /v2/search/results
endpoint, excluding the pagination parameters. It should be called once the user has exhausted the search results for their query and the recommended products are typically shown below the search results.
curl --request POST \
--url https://api.depict.ai/v2/search/related \
--header 'Content-Type: application/json' \
--data '{
"dsid": "<string>",
"filters": [
{
"data": "true",
"field": "<string>",
"id": "<string>",
"meta": {
"max": 123,
"min": 123
},
"op": "eq"
}
],
"market": "<string>",
"metadata": {},
"query": "<string>",
"session_id": "<string>",
"sort": {
"field": "<string>",
"meta": {
"title": "<string>"
},
"order": "asc"
},
"tenant": "<string>",
"user_id": "<string>"
}'
{
"displays": [
{}
],
"error": "<string>",
"experiment_id": "<string>",
"variant": 123
}
Authorizations
Body
Populated for integrations performed by Depict.ai only. Depict.ai Session Id
List of filters to apply to the results.
Metadata that can be used to modify the behaviour of the search.
The search query.
Session identifier
Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the sorts
field.
User identifier
Response
Was this page helpful?
curl --request POST \
--url https://api.depict.ai/v2/search/related \
--header 'Content-Type: application/json' \
--data '{
"dsid": "<string>",
"filters": [
{
"data": "true",
"field": "<string>",
"id": "<string>",
"meta": {
"max": 123,
"min": 123
},
"op": "eq"
}
],
"market": "<string>",
"metadata": {},
"query": "<string>",
"session_id": "<string>",
"sort": {
"field": "<string>",
"meta": {
"title": "<string>"
},
"order": "asc"
},
"tenant": "<string>",
"user_id": "<string>"
}'
{
"displays": [
{}
],
"error": "<string>",
"experiment_id": "<string>",
"variant": 123
}