Retrieve facet options (values) by facet name

Retrieve facet options for end users.

Query Params
string
required
length between 1 and 100

The key of the index to use.

string
length between 1 and 100

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

integer
1 to 250000
Defaults to 100000

The number of results per page to return.

integer
≄ 1

The page of results to return.

integer
≄ 0

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

date-time

A date time representing the current moment in time when applying filtering by product age. Used to emulate "past/future" requests. Requires authentication.

fmt_options
object

An object containing options to format different aspect of the response.

string

The url or app location where the request originated.

string
length between 1 and 100

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

string
required

The name of the facet.

us
array of strings

A customer defined context (such as vip-club-member) used to evaluate redirect or refined tag rules. Pass multiple segments by passing multiple us arguments.

us
string

A customer generated anonymized identifier for a user on a customer website. It should only be sent for logged in customers and helps Constructor to tie multiple client and session IDs together to form a behavioral data profile across devices.

integer

An integer representing the users session number (starting with 1), incremented after a 30 minute period of inactivity.

string

A globally unique identifier for the user browser (or mobile application instance) making the request.

Headers
string

Backend only. The token that Constructor gives you for a backend integration. Send it on every request from your servers. Never send it from a browser or an app, because anyone can read it there. See Required parameters.

string

The User-Agent of the end user's device. A browser sends it for you. In a backend integration, forward the value from the end user's browser. In a native app, use the format on Required parameters.

string

Backend only. The IPv4 address of the end user's device. Send one address, not a comma-separated chain. IPv6 addresses are not supported. Constructor reads this header only when the request also has a valid x-cnstrc-token. See Required parameters.

Responses

400

Validation Error

Language
LoadingLoading…
Response
Choose an example:
application/json