v1

latestOpenAPI 3.1.02026-07-241765501.1 MB

Searchandising for Search

Retrieve refined queries

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: facets.refined_queries(r), searchandising.refined_queries(r).

Retrieve all refined queries.

get/v1/refined_queries

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

response_section'results' | 'facets'

sectionstring

The section of the index to use. Defaults to Products.

Example:Products

querystring[]

A list of queries to filter by

[
  "shoes"
]

phrasestring

Example:shoes

num_results_per_pageinteger

The number of results per page to return.

Example:20

pageinteger

The page of results to return.

Example:1

offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

sort_by'id' | 'created_at' | 'updated_at' | 'last_updated_internally' | 'last_updated_externally'

The attribute to sort by.

Example:id

sort_order'ascending' | 'descending'

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Response

total_countinteger required

Example response

{
  "refined_queries": [
    {
      "slot_rules": [
        {
          "request_tag_value": "premium",
          "active": true,
          "start_time": "2024-03-06T16:05:19",
          "end_time": "2024-03-06T17:05:19",
          "campaign_id": 1,
          "rule": {
            "item_id": "nike-shoes",
            "variation_slice": {
              "color": [
                "red"
              ]
            },
            "position": 1,
            "labels": {
              "promoted": true
            }
          }
        }
      ],
      "variation_slicing_rule": {
        "request_tag_value": "premium",
        "active": true,
        "start_time": "2024-03-06T16:05:19",
        "end_time": "2024-03-06T17:05:19",
        "campaign_id": 1,
        "rule": {
          "facet_names": [
            "color"
          ]
        }
      },
      "whitelist_rule": {
        "request_tag_value": "premium",
        "active": true,
        "start_time": "2024-03-06T16:05:19",
        "end_time": "2024-03-06T17:05:19",
        "campaign_id": 1
      },
      "blacklist_rules": [
        {
          "request_tag_value": "premium",
          "active": true,
          "start_time": "2024-03-06T16:05:19",
          "end_time": "2024-03-06T17:05:19",
          "campaign_id": 1,
          "rule": {
            "item_ids": [
              "nike-shoes"
            ]
          }
        }
      ],
      "boost_rules": [
        {
          "request_tag_value": "premium",
          "active": true,
          "start_time": "2024-03-06T16:05:19",
          "end_time": "2024-03-06T17:05:19",
          "campaign_id": 1,
          "rule": {
            "item_ids": [
              "nike-shoes"
            ],
            "boost": -5
          }
        }
      ],
      "content_rules": [
        {
          "request_tag_value": "premium",
          "active": true,
          "start_time": "2024-03-06T16:05:19",
          "end_time": "2024-03-06T17:05:19",
          "campaign_id": 1,
          "rule": {
            "data": {
              "banner_url": "https://example.com/banner.jpg"
            }
          }
        }
      ],
      "filters_slot_rules": [
        {
          "request_tag_value": "premium",
          "active": true,
          "start_time": "2024-03-06T16:05:19",
          "end_time": "2024-03-06T17:05:19",
          "campaign_id": 1,
          "rule": {
            "position_ranges": [
              {
                "start": 1,
                "end": 3
              }
            ]
          }
        }
      ]
    }
  ]
}