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.

POST /v2/search/related

Try it

200

{
  "displays": [
    {}
  ],
  "error": "<string>",
  "variant": 123,
  "experiment_id": "<string>"
}

Authorizations

api_key · string · query · required

Headers

x-use-db-display-store · boolean · default: false

Body

application/json

market · string · required

tenant · string · required

filters · SearchFilter · object[] | null

List of filters to apply to the results.

Show child attributes

filters. field · string · required

The field to filter by.

filters. op · enum<string> · required

The operation used for filtering. The filtering should be read as field op data, for example brand in ["Nike", "Adidas"].

Available options: eq, neq, in, nin, leq, geq, inrange

filters. data

Data for the filter.

Available options: true, false

filters. meta · RangeFilterMeta · object

Metadata about the filter that can be used for rendering. For example, this could contain the possible values to filter by and their counts in the results.

RangeFilterMeta

Show child attributes

filters.meta. type · any · required

filters.meta. min · number · required

The minimum value that can be selected in the range.

filters.meta. max · number · required

The maximum value that can be selected in the range.

filters.meta. group_title · string | null

Title of the group, where a group consists of all the filters that share an ID.

filters.meta. group_expanded · boolean | null

Whether the filter group should be expanded by default or not.

filters.meta. unit · string | null

The unit of the range values.

filters.meta. currency · string | null

The currency of the range values.

filters. id · string | null

ID of the filter. If multiple filters share the same ID, they should be grouped together in the UI.

sort · SortModel · object

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

sort. field · string · required

The field to sort by.

sort. order · enum<string> · required

The order to sort by.

Available options: asc, desc

sort. meta · SortMeta · object

Metadata about the sort that can be used for rendering.

Show child attributes

sort.meta. title · string · required

sort.meta. values · enum<string>[]

Selectable values

Available options: asc, desc

sort.meta. names · string[] | null

Names for orders (this is what you should display in the UI, not values)

session_id · string | null

Session identifier

Minimum string length: 1

metadata · Metadata · object

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

Show child attributes

metadata. {key} · string

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 string length: 1

dsid · string | null

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

Minimum string length: 1

query · string | null

The search query.

Response

200

application/json

Successful Response

displays · Displays · object[] · required

error · string | null

variant · integer | null

experiment_id · string | null