---
title: "Get Results"
method: POST
path: "/v3/search/results"
tags: ["Search", "V3"]
---

# Get Results

`POST /v3/search/results`

## Query parameters

- `port` integer, nullable

## Request body

- SearchRequestV3
  - `cursor` string, nullable — Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.
  - `limit` integer, nullable — Used for cursor-based pagination. Maximum number of results per response.
  - `page` integer, nullable — Used for Page-based pagination. 1-based index
  - `hits_per_page` integer, nullable — Used for Page-based pagination. If using page-based pagination, this is a required field.
  - `market` string, required
  - `filters` SearchFilter[], nullable — List of filters to apply to the results.
    - `field` string, required
    - `op` 'eq' | 'neq' | 'in' | 'nin' | 'leq' | 'geq' | 'inrange', required
    - `data` union
      - 'true' | 'false'
      - number
      - integer
      - string
      - union[]
        - union
          - 'true' | 'false'
          - number
          - integer
          - string
      - array[]
        - string[]
    - `meta` union
      - RangeFilterMeta
        - `group_title` string, nullable
        - `group_expanded` boolean, nullable
        - `type` 'range'
        - `min` number, required
        - `max` number, required
        - `unit` string, nullable
        - `currency` string, nullable
      - ValuesFilterMeta
        - `group_title` string, nullable
        - `group_expanded` boolean, nullable
        - `type` 'radio' | 'checkbox' | 'checkbox-grid' | 'checkbox-color', required
        - `values` union[], required
          - union
            - 'true' | 'false'
            - number
            - integer
            - string
        - `counts` integer[], required
        - `names` string[], nullable, required
        - `swatches` string[], nullable
      - HierarchicalValuesFilterMeta
        - `group_title` string, nullable
        - `group_expanded` boolean, nullable
        - `type` 'checkbox-hierarchical'
        - `values` array[], required
          - string[]
        - `counts` integer[], required
        - `names` string[], nullable
    - `id` string, nullable
  - `sort` SortModelInput
    - `field` string, required
    - `order` 'asc' | 'desc', required
    - `meta` SortMeta
      - `title` string, required
      - `values` SortingOrder[]
      - `names` string[], nullable
  - `session_id` string, nullable — Session identifier
  - `metadata` object, nullable — Metadata that can be used to modify the behaviour of the search.
  - `merchant` string, required
  - `locale` string, required
  - `query` string, nullable — The search query.

## Response `200`

Successful Response

- SearchResponse
  - `n_hits` integer, required — Total number of results for this query. Not necessarily exact.
  - `sorts` SortModelOutput[], nullable — Available methods for sorting the response. Any element from this list can be sent as `sort` in subsequent requests.
    - `field` string, required
    - `order` 'asc' | 'desc', required
    - `meta` SortMeta
      - `title` string, required
      - `values` SortingOrder[]
      - `names` string[], nullable
  - `filters` SearchFilter[], nullable — Available filters that can be used for filtering in the subsequent request.
    - `field` string, required
    - `op` 'eq' | 'neq' | 'in' | 'nin' | 'leq' | 'geq' | 'inrange', required
    - `data` union
      - 'true' | 'false'
      - number
      - integer
      - string
      - union[]
        - union
          - 'true' | 'false'
          - number
          - integer
          - string
      - array[]
        - string[]
    - `meta` union
      - RangeFilterMeta
        - `group_title` string, nullable
        - `group_expanded` boolean, nullable
        - `type` 'range'
        - `min` number, required
        - `max` number, required
        - `unit` string, nullable
        - `currency` string, nullable
      - ValuesFilterMeta
        - `group_title` string, nullable
        - `group_expanded` boolean, nullable
        - `type` 'radio' | 'checkbox' | 'checkbox-grid' | 'checkbox-color', required
        - `values` union[], required
          - union
            - 'true' | 'false'
            - number
            - integer
            - string
        - `counts` integer[], required
        - `names` string[], nullable, required
        - `swatches` string[], nullable
      - HierarchicalValuesFilterMeta
        - `group_title` string, nullable
        - `group_expanded` boolean, nullable
        - `type` 'checkbox-hierarchical'
        - `values` array[], required
          - string[]
        - `counts` integer[], required
        - `names` string[], nullable
    - `id` string, nullable
  - `search_request_id` string, required
  - `cursor` string, nullable — Cursor that can be used in the next request to get subsequent results. If this is not set, there are no more results.
  - `content_search_links` EngineSearchConfigContentLink[] — List of links to content pages that match the search query.
    - `type` 'content_link'
    - `title` string, required — Title for the content page
    - `description` string, nullable, required — Short human-readable description for the content page
    - `image_url` string, nullable — URL for the content page image
    - `page_url` string, required — URL for the content page
    - `highlights` TypesenseHighlights[] — Highlights that show why the search query matched this content page
      - `field` string, required
      - `snippet` string, required
      - `matched_tokens` string[], required
  - `displays` object[], required — The search results.
  - `debug_info` unknown

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/depict/apis/depict-api.md) · [All operations](https://skmtc.net/depict/apis/depict-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/depict/depict-api/revisions/aad86b1030c7/schema)
