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

curl --request POST \
  --url https://index_name-project_id.svc.environment.pinecone.io/describe_index_stats \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json'

Authorizations

Api-Key

string

header

required

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

Body

application/json

The request for the describe_index_stats operation.

filter

object

If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See https://www.pinecone.io/docs/metadata-filtering/.

Response

200

application/json

A successful response.

The response for the describe_index_stats operation.

namespaces

object

A mapping for each namespace in the index from the namespace name to a summary of its contents. If a metadata filter expression is present, the summary will reflect only vectors matching that expression.

Show child attributes

namespaces.{key}

object

A summary of the contents of a namespace.

Show child attributes

namespaces.{key}.vectorCount

integer

The number of vectors stored in this namespace. Note that updates to this field may lag behind updates to the underlying index and corresponding query results, etc.

dimension

integer

The dimension of the indexed vectors.

indexFullness

number

The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%.

totalVectorCount

integer