Facet a payload key with a given filter.

POST
Count points that satisfy the given filter for each unique value of a payload key.

Path parameters

collection_namestringRequired
Name of the collection to facet in

Query parameters

timeoutintegerOptional
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 integer or list of strings or integers or anyOptional
limitintegerOptional
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

This endpoint returns an object.
timedoubleOptional
Time spent to process this request
statusstringOptional
resultobjectOptional