Get stat of an index

GET /indexes/{indexUid}/stats

Api key

Get stats of an index.

Path parameters

indexUid string Required

Index Unique Identifier

Responses

• 200 application/json

Ok
Hide response attributes Show response attributes object
- numberOfDocuments integer Required
  
  Number of documents contained in the index.
- isIndexing boolean Required
  
  Whether or not the index is currently ingesting document
- fieldDistribution object Required
  
  How many documents contains a field
  
  Hide fieldDistribution attribute Show fieldDistribution attribute
  
  Additional properties: integer
- Additional properties are NOT allowed
• 401 application/json

Unauthorized
Hide response attributes Show response attributes object
- message string Required
- code string Required
- type string Required
- link string Required
• 404

Not Found

GET /indexes/{indexUid}/stats

curl \
 -X GET https://example.meilisearch.com:7700/indexes/movies/stats \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "numberOfDocuments": 10,
  "isIndexing": true,
  "fieldDistribution": {
    "genre": 10,
    "author": 9
  }
}

Response examples (401)

{
  "message": "The Authorization header is missing. It must use the bearer authorization method.",
  "code": "missing_authorization_header",
  "type": "auth",
  "link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}