Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Get index stats

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-04"
curl
// EXAMPLE RESPONSE 1: Serverless index (on-demand)
{
  "namespaces": {
    "example-namespace": {
      "vectorCount": 10000
    }
  },
  "indexFullness": 0,
  "totalVectorCount": 10000,
  "dimension": 1024,
  "metric": "cosine",
  "vectorType": "dense",
  "memoryFullness": 0,
  "storageFullness": 0
}

// EXAMPLE RESPONSE 2: Serverless index (dedicated read nodes)
{
  "namespaces": {
    "example-namespace": {
      "vectorCount": 705000
    }
  },
  "indexFullness": 0.01,
  "totalVectorCount": 705000,
  "dimension": 1536,
  "metric": "cosine",
  "vectorType": "dense",
  "memoryFullness": 0.01,
  "storageFullness": 0.01
}

POST /describe_index_stats

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • filter (body, object) — If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See Understanding metadata. Serverless indexes do not support filtering describe_index_stats by metadata.
  • 200 — A successful response.
  • 400 — Bad request. The request body included invalid request parameters.
  • 4XX — An unexpected error response.
  • 5XX — An unexpected error response.
Suggest an edit

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

Export
Documentation menu