Get Results

Used to get search results that match the given query. Has support for filtering and sorting. Example response: <pre> { "n_hits": 1, "displays": [ { "product_id": "foobar", "title": "Foobar" } ], "sorts": [ { "field": "_relevance", "order": "desc", "meta": { "title": "Relevance", "values": [ "desc" ], "names": [ "Relevance" ] } }, { "field": "title", "order": "asc", "meta": { "title": "Title", "values": [ "asc", "desc" ], "names": [ "A-Z", "Z-A" ] } } ], "filters": [ { "field": "sale_price", "op": "inrange", "data": [ 0, 2500 ], "meta": { "group_title": "Price", "type": "range", "min": 0, "max": 2500, "currency": "EUR" }, "id": "price0" }, { "field": "color_name", "op": "in", "meta": { "group_title": "Color", "type": "checkbox", "values": [ "Blue", "Black", "Brown" ] }, "id": "colors1" } ], "search_request_id": "1a278f4a-16eb-4d95-a002-88bd305493d4", "cursor": "eyJjIjogMSwgInIiOiAwfQ==" } </pre> Example request body for applying a filter: <pre> { "tenant": "foobar" "market": "en", "limit": 20, "query": "hoodie", "filters": [ { "field": "color_name", "op": "in", "data": ["Blue"] } ] } </pre>

Query Parameters

port

integer | null

Body

application/json

market

string

required

tenant

string

required

cursor

string | null

Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.

Maximum length: 500

dsid

string | null

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

Minimum length: 1

filters

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.id

string | null

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

filters.meta

object | null

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.

• Meta
• Meta
• Meta

Show child attributes

filters.meta.max

number

required

The maximum value that can be selected in the range.

filters.meta.min

number

required

The minimum value that can be selected in the range.

filters.meta.type

enum<string>

required

Available options:

range

filters.meta.currency

string | null

The currency of the range values.

filters.meta.group_expanded

boolean | null

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

filters.meta.group_title

string | null

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

filters.meta.unit

string | null

The unit of the range values.

limit

integer | null

Used for cursor-based pagination. Maximum number of results per response.

Required range: 1 < x < 250

locale

string | null

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

metadata

object | null

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

Show child attributes

metadata.{key}

string

query

string | null

The search query.

session_id

string | null

Session identifier

Minimum length: 1

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

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

object | null

Metadata about the sort that can be used for rendering.

Show child attributes

sort.meta.title

string

required

sort.meta.names

string[] | null

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

sort.meta.values

enum<string>[]

Selectable values

Available options:

asc,

desc

user_id

string | null

User identifier

Minimum length: 1

Response

200 - application/json

displays

object[]

required

The search results.

n_hits

integer

required

Total number of results for this query. Not necessarily exact.

search_request_id

string

required

content_search_links

object[]

List of links to content pages that match the search query.

Show child attributes

content_search_links.description

string | null

required

Short human-readable description for the content page

content_search_links.page_url

string

required

URL for the content page

content_search_links.title

string

required

Title for the content page

content_search_links.highlights

object[]

Highlights that show why the search query matched this content page

Show child attributes

content_search_links.highlights.field

string

required

content_search_links.highlights.matched_tokens

string[]

required

content_search_links.highlights.snippet

string

required

content_search_links.image_url

string | null

URL for the content page image

content_search_links.type

enum<string>

default:

content_link

Available options:

content_link

cursor

string | null

Cursor that can be used in the next request to get subsequent results. If this is not set, there are no more results.

Maximum length: 500

debug_info

any | null

filters

object[] | null

Available filters that can be used for filtering in the subsequent request.

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.id

string | null

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

filters.meta

object | null

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.

• Meta
• Meta
• Meta

Show child attributes

filters.meta.max

number

required

The maximum value that can be selected in the range.

filters.meta.min

number

required

The minimum value that can be selected in the range.

filters.meta.type

enum<string>

required

Available options:

range

filters.meta.currency

string | null

The currency of the range values.

filters.meta.group_expanded

boolean | null

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

filters.meta.group_title

string | null

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

filters.meta.unit

string | null

The unit of the range values.

sorts

object[] | null

Available methods for sorting the response. Any element from this list can be sent as sort in subsequent requests.

Show child attributes

sorts.field

string

required

The field to sort by.

sorts.order

enum<string>

required

The order to sort by.

Available options:

asc,

desc

sorts.meta

object | null

Metadata about the sort that can be used for rendering.

Show child attributes

sorts.meta.title

string

required

sorts.meta.names

string[] | null

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

sorts.meta.values

enum<string>[]

Selectable values

Available options:

asc,

desc