Points

Facet a payload key with a given filter.

Changed on Oct 22, 2026

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

post/collections/{collection_name}/facet

Request

Base URL
http://localhost:6333
Auth
- API key in header api-key
- or HTTP bearer
- or none
TypeScript
https://skmtc.dev/qdrant/apis/qdrant-api/docs/collections/:collection_name/facet/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

collection_namestring required

Name of the collection to facet in

Query parameters

integer

'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"
}

Changes

Oct 22, 2026c93be9a86fe5 Revision changes
- info
  added to the //////////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
Aug 5, 2026d08b1f613f29 Revision changes
- breaking
  the ////////// request property's min was increased to 1.00
- info
  added to the //////////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the /////////// request property anyOf list
- info
  added to the ///////// request property anyOf list
- info
  added to the /////// request property anyOf list
- info
  added to the ///////// request property anyOf list
- info
  added to the /////// request property anyOf list
- info
  added to the ///////// request property anyOf list
- info
  added to the /////// request property anyOf list

Operation history (8 revisions)