Retrieve facets with their options (values)

Retrieve facets with 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 10
Defaults to 10

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.

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.

Responses

400

Validation Error

Language
Response
Choose an example:
application/json