POST
/
v2
/
search
/
related
Authorization
Body
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

api_key
string
queryrequired

Body

application/json
dsid
string

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

filters
object[]

List of filters to apply to the results.

market
string
required
metadata
object

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

query
string

The search query.

session_id
string

Session identifier

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

tenant
string
required
user_id
string

User identifier

Response

200 - application/json
displays
object[]
required
error
string
experiment_id
string
variant
integer