View collection statistics

Prerequisites

Before you begin, make sure that you have:

• A cluster

• An API key

• The latest version of the DashVector SDK

Request syntax

GET https://{Endpoint}/v1/collections/{CollectionName}/stats

Request parameters

Example

Replace <your-api-key> with your API key and <your-cluster-endpoint> with your cluster endpoint.

This example queries statistics for a collection named quickstart. To create this collection, see the Create a collection example.

curl -H 'dashvector-auth-token: <your-api-key>' \
  https://<your-cluster-endpoint>/v1/collections/quickstart/stats

Sample response:

{
  "request_id": "14448bcb-c9a3-49a8-9152-0de3990bce59",
  "code": 0,
  "message": "Success",
  "output": {
    "total_doc_count": "26",
    "index_completeness": 1.0,
    "partitions": {
      "default": {
        "total_doc_count": "26"
      }
    }
  }
}

Key fields in the response:

• total_doc_count: The total number of documents across all partitions.

• index_completeness: The indexing completeness of the collection.

• partitions: A per-partition breakdown of document counts.

Response parameters