Payload field facets

Retrieves facets for the specified payload field.

Path parameters

collection_namestringRequired
Name of the collection to facet in

Headers

api-keystringRequired

Query parameters

timeoutintegerOptional>=1
If set, overrides global timeout for this request. Unit is seconds.
consistencyinteger or enumOptional
Define read consistency guarantees for the operation

Request

This endpoint expects an object.
keystringRequired
Payload key to use for faceting.
shard_keystring or uint64 or list of strings or uint64s or anyOptional
limitintegerOptional>=1
Max number of hits to return. Default is 10.
filterobject or anyOptional

Filter conditions - only consider points that satisfy these conditions.

exactbooleanOptional
Whether to do a more expensive exact count for each of the values in the facet. Default is false.

Response

successful operation
usageobject or anyOptional
timedoubleOptional
Time spent to process this request
statusstringOptional
resultobjectOptional