The browse facets endpoint lists all the customer-defined facets present in the current index, while the facet options endpoint (shown below) indicates all the facet options (values) available for a given facet group (key), along with counts for the number of items available for each.
This can be useful to validate the integrity of a catalog by checking the number of products present for each brand, or within each group (category) as well as to power facet listings for web interfaces.
The browse facets endpoint can be used with production-level loads. Given customers may potentially define thousands of facets, the full list of facets is sorted ascending alphabetically, and paginated.
The browse facets endpoint does not return individual item results - for this purpose reference the standard browse endpoint.
GET https://ac.cnstrc.com/browse/facets?key=[your API key]&page=1&num_results_per_page=20&fmt_options[show_hidden_facets]=true&fmt_options[show_protected_facets]=true
The URL parameters the endpoint accepts are shown below.
|page||No||1||The page number of the results|
|num_results_per_page||No||20||The number of results per page to return|
|fmt_options[show_hidden_facets]||No||False||Include facets configured as hidden|
|fmt_options[show_protected_facets]||No||False||Include facets configured as protected|