Get index stats

The describe_index_stats operation returns statistics about the contents of an index, including the vector count per namespace and the number of dimensions, and the index fullness.

Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.

For pod-based indexes, the index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use describe_index.

cURL

PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="INDEX_HOST"

curl -X POST "https://$INDEX_HOST/describe_index_stats" \
  -H "Api-Key: $PINECONE_API_KEY"

Response

{
  "namespaces": {
    "ns1": {
      "vectorCount": 4
    },
    "ns2": {
      "vectorCount": 4
    }
  },
  "dimension": 8,
  "indexFullness": 0.00008,
  "totalVectorCount": 8
}

Authorizations

Api-Key · string · header · required

An API Key is required to call Pinecone APIs. Get yours at https://app.pinecone.io/.

Body

application/json

The request for the describe_index_stats operation.

Response

200

application/json

A successful response.

The response for the describe_index_stats operation.