Search for facet values

curl --request POST \ --url https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/facets/lorem/query \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --header 'x-algolia-api-key: ALGOLIA_API_KEY' \ --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \ --data ' { "params": "hitsPerPage=2&getRankingInfo=1", "facetQuery": "george", "maxFacetHits": 10 } '

{ "exhaustiveFacetsCount": true, "facetHits": [ { "count": 123, "highlighted": "<em>George</em> <em>Clo</em>oney", "value": "Mobile phone" } ], "processingTimeMS": 20 }

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

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

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.

indexName

string

required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

Body

application/json

facetQuery

string

default:""

Text to search inside the facet's values.

Example:

"george"

maxFacetHits

integer

default:10

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

Required range: x <= 100

params

string

default:""

Search parameters as a URL-encoded query string.

Example:

"hitsPerPage=2&getRankingInfo=1"

Response

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.

facetHits

facetHits · object[]

required

Matching facet values.

Show child attributes

processingTimeMS

integer

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

Example:

20