POST
/
describe_index_stats
curl --request POST \
     --url https://index_name-project_id.svc.environment.pinecone.io/describe_index_stats \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

{
  "namespaces": {
    "": {
      "vectorCount": 50000
    },
    "example-namespace-2": {
      "vectorCount": 30000
    }
  },
  "dimension": 1024,
  "index_fullness": 0.4
}
curl --request POST \
     --url https://index_name-project_id.svc.environment.pinecone.io/describe_index_stats \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

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 DescribeIndexStats 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

A successful response.

The response for the DescribeIndexStats operation.

​
namespaces
object

A mapping for each <a href='https://docs.pinecone.io/docs/namespaces'>namespace</a> 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

The dimension of the indexed vectors.

Example:

1024

​
indexFullness
number

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

Example:

0.4

​
totalVectorCount
integer

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

Example:

80000