Get a list of the possible facets for a specific search
1 min read
This guide uses Intelligent Search API v1. If you are migrating from Intelligent Search API (Legacy), see Migrating to Intelligent Search API v1.
Facets represent the combination of filters that are selected in a search. To retrieve a list of possible facets for a specific search, use the GET List filters for a search (v1) endpoint. You can filter the endpoint response by defining the search's facets and the term's locale and query.
A facet value is only returned in the response if at least one of the products returned in the query has this value.
All information is synced with the Catalog. Therefore, if a specification is configured non-filterable, it will not be returned by the Search API.
Response body example:
_36{_36 "facets": [_36 {_36 "type": "TEXT",_36 "name": "string",_36 "hidden": false,_36 "quantity": 0,_36 "values": [_36 {_36 "id": "string",_36 "quantity": 0,_36 "name": "string",_36 "key": "string",_36 "value": "string",_36 "selected": false_36 }_36 ]_36 }_36 ],_36 "sampling": false,_36 "breadcrumb": [_36 {_36 "name": "string",_36 "href": "string"_36 }_36 ],_36 "queryArgs": {_36 "query": "string",_36 "selectedFacets": [_36 {_36 "key": "string",_36 "value": "string"_36 }_36 ]_36 }_36}