v1

latestOpenAPI 3.1.02026-07-241765501.1 MB

Searchandising for Browse

Retrieve refined filter rules

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

Retrieve all refined filter rules.

get/v1/refined_filters/{filter_name}/{filter_value}/rules

Path parameters

filter_namestring required

Example:Brand

filter_valuestring required

Example:Nike

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

facet_group_namestring

The name of the facet group to filter by.

target'facet_group' | 'facet_option'

{
  "facet_group_name": "Brand"
}

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'

The attribute to sort by.

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_filter_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
        }
      }
    }
  ]
}