API Reference

API Reference Points

Payload field facets

POST

http://localhost:6333/collections/:collection_name/facet

POST

/collections/:collection_name/facet

1 curl -X POST http://localhost:6333/collections/collection_name/facet \
2      -H "api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "key": "key"
6 }'

200Successful

1 {
2   "usage": {
3     "cpu": 1,
4     "payload_io_read": 1,
5     "payload_io_write": 1,
6     "payload_index_io_read": 1,
7     "payload_index_io_write": 1,
8     "vector_io_read": 1,
9     "vector_io_write": 1
10   },
11   "time": 0.002,
12   "status": "ok",
13   "result": {
14     "hits": [
15       {
16         "value": "value",
17         "count": 1
18       }
19     ]
20   }
21 }

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 any or null

timedouble or null

Time spent to process this request

statusstring or null

resultobject or null

Was this page helpful?

Search points