Count points

POST

Counts the number of points that match a specified filtering condition.

Path parameters

collection_namestringRequired

Name of the collection to count in

Query parameters

timeoutintegerOptional

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

Request

This endpoint expects an object.

shard_keystring or uint64 or list of strings or uint64s or anyOptional

Specify in which shards to look for the points, if not specified - look in all shards

filterobject or anyOptional

Look only for points which satisfies this conditions

exactbooleanOptional

If true, count exact number of points. If false, count approximate number of points faster. Approximate count might be unreliable during the indexing process. Default: true

Response

successful operation

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

Payload field facets

Up Next

Built with

1	# Count total number of points in a collection
2	curl -X POST \
3	'http://localhost:6333/collections/collection_name/points/count' \
4	--header 'api-key: <api-key-value>' \
5	--header 'Content-Type: application/json' \
6	--data-raw '{
7	"exact": true
8	}'
9
10	# Count points satisfying a filter condition
11	curl -X POST \
12	'http://localhost:6333/collections/collection_name/points/count' \
13	--header 'api-key: <api-key-value>' \
14	--header 'Content-Type: application/json' \
15	--data-raw '{
16	"filter": {
17	"must": [
18	{
19	"key": "color",
20	"match": {
21	"value": "red"
22	}
23	}
24	]
25	},
26	"exact": true
27	}'

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"count": 1
6	}
7	}