Search for facet values

Searches for values of a specified facet attribute.

• By default, facet values are sorted by decreasing count. You can adjust this with the sortFacetValueBy parameter.
• Searching for facet values doesn’t work if you have more than 65 searchable facets and searchable attributes combined.

Authorizations

x-algolia-application-id

string

headerrequired

Your Algolia application ID.

x-algolia-api-key

string

headerrequired

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName

string

required

Name of the index on which to perform the operation.

facetName

string

required

Facet attribute in which to search for values.

This attribute must be included in the attributesForFaceting index setting with the searchable() modifier.

Body

application/json

params

string

default:

Search parameters as a URL-encoded query string.

facetQuery

string

default:

Text to search inside the facet's values.

maxFacetHits

integer

default: 10

Maximum number of facet values to return when searching for facet values.

Required range: x < 100

Response

200 - application/json

facetHits

object[]

required

Matching facet values.

Show child attributes

facetHits.value

string

required

Facet value.

facetHits.highlighted

string

required

Highlighted attribute value, including HTML tags.

facetHits.count

integer

required

Number of records with this facet value. The count may be approximated.

exhaustiveFacetsCount

boolean

required

Whether the facet count is exhaustive (true) or approximate (false). For more information, see Why are my facet and hit counts not accurate.

processingTimeMS

integer

Time the server took to process the request, in milliseconds.