Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

Get index stats

Return statistics about the contents of an index, including the vector count per namespace, the number of dimensions, and the index fullness.

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

curl
# To get the unique host for an index,
# see https://docs.pinecone.io/guides/manage-data/target-an-index
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_HOST="YOUR_INDEX_HOST"

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

POST /describe_index_stats

200
{
  "dimension": 1024,
  "indexFullness": 0.4,
  "namespaces": {
    "": {
      "vectorCount": 50000
    },
    "example-namespace-2": {
      "vectorCount": 30000
    }
  },
  "totalVectorCount": 80000
}
400
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
4XX
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
5XX
{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "<string>"
    }
  ]
}
Api-Keystringrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2026-07
filter?object

If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See Understanding metadata. Serverless and Starter indexes do not support filtering describe_index_stats by metadata, and reject a request carrying a non-empty filter.

200 — 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.

Typeobject
dimension?integer

The dimension of the indexed vectors. Not specified if sparse index.

Example: 1024

Typeinteger
indexFullness?number

Example: 0.4

Typenumber

The fullness of the index, reported to a granularity of 1% and capped at 1.0. Always 0 for indexes with on-demand read capacity. Serverless indexes scale automatically as needed, so index fullness is relevant only 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.

totalVectorCount?integer

The total number of vectors in the index, regardless of whether a metadata filter expression was passed

Example: 80000

Typeinteger
metric?string

The metric used to measure similarity.

Example: cosine

Typestring
vectorType?string

The type of vectors stored in the index.

Example: dense

Typestring
memoryFullness?number

The amount of memory used by a dedicated index

Typenumber
storageFullness?number

The amount of storage used by a dedicated index

Typenumber
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu