Skip to main content
POST
Index fullness is also relevant for dedicated read nodes. The response includes memoryFullness and storageFullness alongside indexFullness, which summarizes overall capacity usage. For serverless on-demand indexes, all three values are typically 0 because storage and compute scale automatically. For dedicated indexes, monitor these values and add shards before the index reaches capacity.

Authorizations

Api-Key
string
header
required

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

Headers

X-Pinecone-Api-Version
string
default:2025-10
required

Required date-based version header

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 Understanding metadata.

Serverless indexes do not support filtering describe_index_stats by metadata.

Response

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.

dimension
integer<int64>

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

Example:

1024

indexFullness
number<float>

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

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.

Example:

0.4

totalVectorCount
integer<int64>

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

Example:

80000

metric
string

The metric used to measure similarity.

Example:

"cosine"

vectorType
string

The type of vectors stored in the index.

Example:

"dense"

memory_fullness
number<float>

The amount of memory used by a dedicated index

storage_fullness
number<float>

The amount of storage used by a dedicated index