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.

Query Parameters

port

integer | null

Body

application/json

market

string

required

tenant

string

required

filters

object[] | null

List of filters to apply to the results.

Show child attributes

sort

object | null

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.

Show child attributes

session_id

string | null

Session identifier

Minimum length: 1

metadata

object | null

Metadata that can be used to modify the behaviour of the search.

Show child attributes

locale

string | null

The locale to use for the search. If not set, the default locale will be used.

user_id

string | null

User identifier

Minimum length: 1

dsid

string | null

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

Minimum length: 1

query

string | null

The search query.

Response

200 - application/json

displays

object[]

required

error

string | null

variant

integer | null

experiment_id

string | null