Skip to main content
POST
/
v2
/
search
/
related
Get Related Recommendations
curl --request POST \
  --url 'https://api.depict.ai/v2/search/related?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "market": "<string>",
  "tenant": "<string>",
  "filters": [
    {
      "field": "<string>",
      "meta": {
        "type": "<unknown>",
        "min": 123,
        "max": 123,
        "group_title": "<string>",
        "group_expanded": true,
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "sort": {
    "field": "<string>",
    "meta": {
      "title": "<string>",
      "values": [],
      "names": [
        "<string>"
      ]
    }
  },
  "session_id": "<string>",
  "metadata": {},
  "locale": "<string>",
  "user_id": "<string>",
  "dsid": "<string>",
  "query": "<string>"
}
'
import requests

url = "https://api.depict.ai/v2/search/related?api_key="

payload = {
    "market": "<string>",
    "tenant": "<string>",
    "filters": [
        {
            "field": "<string>",
            "meta": {
                "type": "<unknown>",
                "min": 123,
                "max": 123,
                "group_title": "<string>",
                "group_expanded": True,
                "unit": "<string>",
                "currency": "<string>"
            },
            "id": "<string>"
        }
    ],
    "sort": {
        "field": "<string>",
        "meta": {
            "title": "<string>",
            "values": [],
            "names": ["<string>"]
        }
    },
    "session_id": "<string>",
    "metadata": {},
    "locale": "<string>",
    "user_id": "<string>",
    "dsid": "<string>",
    "query": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    market: '<string>',
    tenant: '<string>',
    filters: [
      {
        field: '<string>',
        meta: {
          type: '<unknown>',
          min: 123,
          max: 123,
          group_title: '<string>',
          group_expanded: true,
          unit: '<string>',
          currency: '<string>'
        },
        id: '<string>'
      }
    ],
    sort: {field: '<string>', meta: {title: '<string>', values: [], names: ['<string>']}},
    session_id: '<string>',
    metadata: {},
    locale: '<string>',
    user_id: '<string>',
    dsid: '<string>',
    query: '<string>'
  })
};

fetch('https://api.depict.ai/v2/search/related?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.depict.ai/v2/search/related?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'market' => '<string>',
    'tenant' => '<string>',
    'filters' => [
        [
                'field' => '<string>',
                'meta' => [
                                'type' => '<unknown>',
                                'min' => 123,
                                'max' => 123,
                                'group_title' => '<string>',
                                'group_expanded' => true,
                                'unit' => '<string>',
                                'currency' => '<string>'
                ],
                'id' => '<string>'
        ]
    ],
    'sort' => [
        'field' => '<string>',
        'meta' => [
                'title' => '<string>',
                'values' => [
                                
                ],
                'names' => [
                                '<string>'
                ]
        ]
    ],
    'session_id' => '<string>',
    'metadata' => [
        
    ],
    'locale' => '<string>',
    'user_id' => '<string>',
    'dsid' => '<string>',
    'query' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.depict.ai/v2/search/related?api_key="

	payload := strings.NewReader("{\n  \"market\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"type\": \"<unknown>\",\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"unit\": \"<string>\",\n        \"currency\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"sort\": {\n    \"field\": \"<string>\",\n    \"meta\": {\n      \"title\": \"<string>\",\n      \"values\": [],\n      \"names\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"session_id\": \"<string>\",\n  \"metadata\": {},\n  \"locale\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"dsid\": \"<string>\",\n  \"query\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.depict.ai/v2/search/related?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"market\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"type\": \"<unknown>\",\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"unit\": \"<string>\",\n        \"currency\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"sort\": {\n    \"field\": \"<string>\",\n    \"meta\": {\n      \"title\": \"<string>\",\n      \"values\": [],\n      \"names\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"session_id\": \"<string>\",\n  \"metadata\": {},\n  \"locale\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"dsid\": \"<string>\",\n  \"query\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.depict.ai/v2/search/related?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"market\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"type\": \"<unknown>\",\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"unit\": \"<string>\",\n        \"currency\": \"<string>\"\n      },\n      \"id\": \"<string>\"\n    }\n  ],\n  \"sort\": {\n    \"field\": \"<string>\",\n    \"meta\": {\n      \"title\": \"<string>\",\n      \"values\": [],\n      \"names\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"session_id\": \"<string>\",\n  \"metadata\": {},\n  \"locale\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"dsid\": \"<string>\",\n  \"query\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "displays": [
    {}
  ],
  "error": "<string>",
  "variant": 123,
  "experiment_id": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<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.

​
sort
SortModel · 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.

​
session_id
string | null

Session identifier

Minimum string length: 1
​
metadata
Metadata · object | null

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

​
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

Successful Response

​
displays
Displays · object[]
required
​
error
string | null
​
variant
integer | null
​
experiment_id
string | null