POST /1/indexes/{indexName}/facets/{facetName}/query
Searches for values of a specified facet attribute.
- By default, facet values are sorted by decreasing count.
You can adjust this with the
sortFacetValueByparameter. - Searching for facet values doesn't work if you have more than 65 searchable facets and searchable attributes combined.
Servers
- https://{appId}.algolia.net
- https://{appId}-1.algolianet.com
- https://{appId}-2.algolianet.com
- https://{appId}-3.algolianet.com
- https://{appId}-dsn.algolia.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
facetName |
String | Yes |
Facet attribute in which to search for values. This attribute must be included in the |
indexName |
String | Yes |
Name of the index on which to perform the operation. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
params |
String | No |
Search parameters as a URL-encoded query string. |
facetQuery |
String | No |
Text to search inside the facet's values. |
maxFacetHits |
Integer | No |
Maximum number of facet values to return when searching for facet values. Default value: 10 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.