Skip to main content
GET
/
indexes
/
{indexUid}
/
stats
cURL
curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/stats'
{
  "numberOfDocuments": 10,
  "rawDocumentDbSize": 10,
  "avgDocumentSize": 10,
  "numberOfEmbeddings": 10,
  "numberOfEmbeddedDocuments": 10,
  "isIndexing": true,
  "fieldDistribution": {
    "genre": 10,
    "author": 9
  }
}

Authorizations

​
Authorization
string
header
required

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:

-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

const client = new MeiliSearch({
  host: 'MEILISEARCH_URL',
  apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});

Path Parameters

​
indexUid
string
required

Unique identifier of the index.

Response

The stats of the index.

Stats of an Index, as known to the stats route.

​
numberOfDocuments
integer<u-int64>
required

Number of documents in the index

Required range: x >= 0
​
rawDocumentDbSize
integer<u-int64>
required

Size of the documents database, in bytes.

Required range: x >= 0
​
avgDocumentSize
integer<u-int64>
required

Average size of a document in the documents database.

Required range: x >= 0
​
isIndexing
boolean
required

Whether or not the index is currently ingesting document

​
fieldDistribution
object
required

Association of every field name with the number of times it occurs in the documents.

​
numberOfEmbeddings
integer<u-int64> | null

Number of embeddings in the index

Required range: x >= 0
​
numberOfEmbeddedDocuments
integer<u-int64> | null

Number of embedded documents in the index

Required range: x >= 0