Get Results - Depict Documentation

Get Results

curl --request POST \
  --url https://api.depict.ai/v2/search/results \
  --header 'Content-Type: application/json' \
  --data '
{
  "market": "<string>",
  "tenant": "<string>",
  "cursor": "<string>",
  "limit": 125,
  "filters": [
    {
      "field": "<string>",
      "meta": {
        "min": 123,
        "max": 123,
        "group_title": "<string>",
        "group_expanded": true,
        "type": "range",
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "sort": {
    "field": "<string>",
    "meta": {
      "title": "<string>",
      "values": [
        "desc",
        "asc"
      ],
      "names": [
        "<string>"
      ]
    }
  },
  "session_id": "<string>",
  "metadata": {},
  "locale": "<string>",
  "user_id": "<string>",
  "dsid": "<string>",
  "query": "<string>"
}
'

import requests

url = "https://api.depict.ai/v2/search/results"

payload = {
    "market": "<string>",
    "tenant": "<string>",
    "cursor": "<string>",
    "limit": 125,
    "filters": [
        {
            "field": "<string>",
            "meta": {
                "min": 123,
                "max": 123,
                "group_title": "<string>",
                "group_expanded": True,
                "type": "range",
                "unit": "<string>",
                "currency": "<string>"
            },
            "id": "<string>"
        }
    ],
    "sort": {
        "field": "<string>",
        "meta": {
            "title": "<string>",
            "values": ["desc", "asc"],
            "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>',
    cursor: '<string>',
    limit: 125,
    filters: [
      {
        field: '<string>',
        meta: {
          min: 123,
          max: 123,
          group_title: '<string>',
          group_expanded: true,
          type: 'range',
          unit: '<string>',
          currency: '<string>'
        },
        id: '<string>'
      }
    ],
    sort: {
      field: '<string>',
      meta: {title: '<string>', values: ['desc', 'asc'], names: ['<string>']}
    },
    session_id: '<string>',
    metadata: {},
    locale: '<string>',
    user_id: '<string>',
    dsid: '<string>',
    query: '<string>'
  })
};

fetch('https://api.depict.ai/v2/search/results', 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/results",
  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>',
    'cursor' => '<string>',
    'limit' => 125,
    'filters' => [
        [
                'field' => '<string>',
                'meta' => [
                                'min' => 123,
                                'max' => 123,
                                'group_title' => '<string>',
                                'group_expanded' => true,
                                'type' => 'range',
                                'unit' => '<string>',
                                'currency' => '<string>'
                ],
                'id' => '<string>'
        ]
    ],
    'sort' => [
        'field' => '<string>',
        'meta' => [
                'title' => '<string>',
                'values' => [
                                'desc',
                                'asc'
                ],
                '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/results"

	payload := strings.NewReader("{\n  \"market\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 125,\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"type\": \"range\",\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        \"desc\",\n        \"asc\"\n      ],\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/results")
  .header("Content-Type", "application/json")
  .body("{\n  \"market\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 125,\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"type\": \"range\",\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        \"desc\",\n        \"asc\"\n      ],\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/results")

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  \"cursor\": \"<string>\",\n  \"limit\": 125,\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"type\": \"range\",\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        \"desc\",\n        \"asc\"\n      ],\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

{
  "n_hits": 123,
  "search_request_id": "<string>",
  "displays": [
    {}
  ],
  "sorts": [
    {
      "field": "<string>",
      "order": "asc",
      "meta": {
        "title": "<string>",
        "values": [
          "desc",
          "asc"
        ],
        "names": [
          "<string>"
        ]
      }
    }
  ],
  "filters": [
    {
      "field": "<string>",
      "op": "eq",
      "data": "true",
      "meta": {
        "min": 123,
        "max": 123,
        "group_title": "<string>",
        "group_expanded": true,
        "type": "range",
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "cursor": "<string>",
  "content_search_links": [
    {
      "title": "<string>",
      "description": "<string>",
      "page_url": "<string>",
      "type": "content_link",
      "image_url": "<string>",
      "highlights": [
        {
          "field": "<string>",
          "snippet": "<string>",
          "matched_tokens": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "debug_info": null
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

results

Get Results

curl --request POST \
  --url https://api.depict.ai/v2/search/results \
  --header 'Content-Type: application/json' \
  --data '
{
  "market": "<string>",
  "tenant": "<string>",
  "cursor": "<string>",
  "limit": 125,
  "filters": [
    {
      "field": "<string>",
      "meta": {
        "min": 123,
        "max": 123,
        "group_title": "<string>",
        "group_expanded": true,
        "type": "range",
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "sort": {
    "field": "<string>",
    "meta": {
      "title": "<string>",
      "values": [
        "desc",
        "asc"
      ],
      "names": [
        "<string>"
      ]
    }
  },
  "session_id": "<string>",
  "metadata": {},
  "locale": "<string>",
  "user_id": "<string>",
  "dsid": "<string>",
  "query": "<string>"
}
'

import requests

url = "https://api.depict.ai/v2/search/results"

payload = {
    "market": "<string>",
    "tenant": "<string>",
    "cursor": "<string>",
    "limit": 125,
    "filters": [
        {
            "field": "<string>",
            "meta": {
                "min": 123,
                "max": 123,
                "group_title": "<string>",
                "group_expanded": True,
                "type": "range",
                "unit": "<string>",
                "currency": "<string>"
            },
            "id": "<string>"
        }
    ],
    "sort": {
        "field": "<string>",
        "meta": {
            "title": "<string>",
            "values": ["desc", "asc"],
            "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>',
    cursor: '<string>',
    limit: 125,
    filters: [
      {
        field: '<string>',
        meta: {
          min: 123,
          max: 123,
          group_title: '<string>',
          group_expanded: true,
          type: 'range',
          unit: '<string>',
          currency: '<string>'
        },
        id: '<string>'
      }
    ],
    sort: {
      field: '<string>',
      meta: {title: '<string>', values: ['desc', 'asc'], names: ['<string>']}
    },
    session_id: '<string>',
    metadata: {},
    locale: '<string>',
    user_id: '<string>',
    dsid: '<string>',
    query: '<string>'
  })
};

fetch('https://api.depict.ai/v2/search/results', 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/results",
  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>',
    'cursor' => '<string>',
    'limit' => 125,
    'filters' => [
        [
                'field' => '<string>',
                'meta' => [
                                'min' => 123,
                                'max' => 123,
                                'group_title' => '<string>',
                                'group_expanded' => true,
                                'type' => 'range',
                                'unit' => '<string>',
                                'currency' => '<string>'
                ],
                'id' => '<string>'
        ]
    ],
    'sort' => [
        'field' => '<string>',
        'meta' => [
                'title' => '<string>',
                'values' => [
                                'desc',
                                'asc'
                ],
                '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/results"

	payload := strings.NewReader("{\n  \"market\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 125,\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"type\": \"range\",\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        \"desc\",\n        \"asc\"\n      ],\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/results")
  .header("Content-Type", "application/json")
  .body("{\n  \"market\": \"<string>\",\n  \"tenant\": \"<string>\",\n  \"cursor\": \"<string>\",\n  \"limit\": 125,\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"type\": \"range\",\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        \"desc\",\n        \"asc\"\n      ],\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/results")

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  \"cursor\": \"<string>\",\n  \"limit\": 125,\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"meta\": {\n        \"min\": 123,\n        \"max\": 123,\n        \"group_title\": \"<string>\",\n        \"group_expanded\": true,\n        \"type\": \"range\",\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        \"desc\",\n        \"asc\"\n      ],\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

{
  "n_hits": 123,
  "search_request_id": "<string>",
  "displays": [
    {}
  ],
  "sorts": [
    {
      "field": "<string>",
      "order": "asc",
      "meta": {
        "title": "<string>",
        "values": [
          "desc",
          "asc"
        ],
        "names": [
          "<string>"
        ]
      }
    }
  ],
  "filters": [
    {
      "field": "<string>",
      "op": "eq",
      "data": "true",
      "meta": {
        "min": 123,
        "max": 123,
        "group_title": "<string>",
        "group_expanded": true,
        "type": "range",
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "cursor": "<string>",
  "content_search_links": [
    {
      "title": "<string>",
      "description": "<string>",
      "page_url": "<string>",
      "type": "content_link",
      "image_url": "<string>",
      "highlights": [
        {
          "field": "<string>",
          "snippet": "<string>",
          "matched_tokens": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "debug_info": null
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

limit

integer | null

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

Required range: 1 <= x <= 250

filters

SearchFilter · object[] | null

List of filters to apply to the results.

Show child attributes

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.

Show child attributes

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.

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

n_hits

integer

required

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

search_request_id

string

required

displays

Displays · object[]

required

The search results.

sorts

SortModel · object[] | null

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

Show child attributes

filters

SearchFilter · object[] | null

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

Show child attributes

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

content_search_links

ContentLink · object[]

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

Show child attributes

debug_info

unknown