Get stats of index
Return statistics for a single index: document count, database size, indexing status, and field distribution.
Authorizations
An API key is a token that you provide when making API calls. Read more about how to secure your project.
Include the API key to the Authorization header, for instance:
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
Path Parameters
Unique identifier of the index.
Query Parameters
If true, adds internalDatabaseSizes to the response.
Specify how to format the sizes:
"raw"(default): format sizes as a number of bytes"human": format sizes as a human-readable string with an appropriate unit.
human, raw Response
The stats of the index.
Stats of an Index, as known to the stats route.
Number of documents in the index
x >= 0Size of the documents database, in bytes.
x >= 0Average size of a document in the documents database.
x >= 0Whether or not the index is currently ingesting document
Association of every field name with the number of times it occurs in the documents.
Size of all the internal databases for the index.
Database names can change from version to version.
Number of embeddings in the index
x >= 0Number of embedded documents in the index
x >= 0