master
Search...
/
Cloud
GitHub
API Reference
Collections
points
POST
Retrieve points
PUT
Upsert points
GET
Retrieve a point
POST
Delete points
PUT
Update vectors
POST
Delete vectors
POST
Set payload
PUT
Overwrite payload
POST
Delete payload
POST
Clear payload
POST
Batch update points
POST
Scroll points
POST
Count points
POST
Facet a payload key with a given filter.
POST
Search points matrix distance pairs
POST
Search points matrix distance offsets
Search
Indexes
Snapshots
Aliases
Distributed
Service
Beta
Cloud
GitHub
API Reference
points
Facet a payload key with a given filter.
POST
http://localhost:6333
/
collections
/
:collection_name
/
facet
Count points that satisfy the given filter for each unique value of a payload key.
Path parameters
collection_name
string
Required
Name of the collection to facet in
Query parameters
timeout
integer
Optional
If set, overrides global timeout for this request. Unit is seconds.
consistency
integer or enum
Optional
Define read consistency guarantees for the operation
Show 2 variants
Request
This endpoint expects an object.
key
string
Required
Payload key to use for faceting.
shard_key
string or integer or list of strings or integers or any
Optional
Show 2 variants
limit
integer
Optional
Max number of hits to return. Default is 10.
filter
object or any
Optional
Filter conditions - only consider points that satisfy these conditions.
Show 2 variants
exact
boolean
Optional
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.
time
double
Optional
Time spent to process this request
status
string
Optional
result
object
Optional
Show property
Built with