Sign in

v17

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-2575397522.8 KB
Points

Facet a payload key with a given filter.

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

post/collections/{collection_name}/facet

Path parameters

collection_namestring required

Name of the collection to facet in

Query parameters

integer
OR
'majority' | 'quorum' | 'all'

  • majority - send N/2+1 random request and return points, which present on all of them

  • quorum - send requests to all nodes and return points which present on majority of nodes

  • all - send requests to all nodes and return points which present on all nodes

Define read consistency guarantees for the operation

timeoutinteger

If set, overrides global timeout for this request. Unit is seconds.

Request body

keystring required

Payload key to use for faceting.

limitinteger nullable

Max number of hits to return. Default is 10.

exactboolean nullable

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

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

{
  "time": 0.002,
  "status": "ok"
}