Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Facets

Retrieve facet options

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

Retrieve facet options for the given facet_name.

get/v1/facets/{facet_name}/options

Path parameters

facet_namestring required
Example:Brand

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

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

Example:Products
num_results_per_pageinteger

The number of results per page to return.

Example:100
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.

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
value_aliasstring

Value alias to filter by.

{
  "value_alias": "blue"
}

Response

OK

total_countinteger required

Total count of facet options.

Example response

{
  "facet_options": [
    {
      "value": "Red",
      "value_alias": "blue",
      "replace_value_alias": true,
      "display_name": "Bright Red",
      "position": 1,
      "data": {
        "hex": "#FF0000"
      }
    }
  ]
}