Stats

The /stats route gives extended information and metrics about indexes and the Meilisearch database.

Get stats of an index

GET

/indexes/{index_uid}/stats

Get stats of an index. The index uid is required.

Fields returned

numberOfDocuments

The numberOfDocuments field shows the total number of documents in an index.

isIndexing

The isIndexing field returns a Boolean. If true, the index is still processing documents and attempts to search will result in undefined behavior. If false, the index has finished processing and you can start searching.

fieldDistribution

The fieldDistribution object shows every field in the individual index or the entire database along with the total number of documents in the index that contain that field.

fieldDistribution is not impacted by searchableAttributes or displayedAttributes. Meaning, if one of the fields is not displayed or searchable, it will still be displayed in the fieldDistribution object.

Example

curl \
  -X GET 'http://localhost:7700/indexes/movies/stats'

client.index('movies').getStats()

client.index('movies').get_stats()

$client->index('movies')->stats();

client.index("movies").getStats();

client.index('movies').stats

client.Index("movies").GetStats()

await client.Index("movies").GetStatsAsync();

let stats: IndexStats = client
  .index("movies")
  .get_stats()
  .await
  .unwrap();

client.index("movies").stats { (result) in
    switch result {
    case .success(let stat):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').getStats();

Response: 200 Ok

{
  "numberOfDocuments": 19654,
  "isIndexing": false,
  "fieldDistribution": {
    "poster": 19654,
    "release_date": 19654,
    "title": 19654,
    "id": 19654,
    "overview": 19654
  }
}

Get stats of all indexes

GET

/stats

Get stats of all indexes.

Fields returned

In addition to all fields returned by GET /indexes/{index_uid}/stats, GET /stats returns the following instance-level fields:

databaseSize

The databaseSize field shows the size of the database in bytes.

lastUpdate

The lastUpdate field shows when the last update was made to the database in the RFC 3339 format.

Example

curl \
  -X GET 'http://localhost:7700/stats'

client.stats()

client.get_all_stats()

$client->stats();

client.getStats();

client.stats

client.GetStats()

await client.GetStatsAsync();

let stats: ClientStats = client
  .get_stats()
  .await
  .unwrap();

client.allStats { (result) in
    switch result {
    case .success(let allStats):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.getAllStats();

Response: 200 Ok

{
  "databaseSize": 447819776,
  "lastUpdate": "2019-11-15T11:15:22.092896Z",
  "indexes": {
    "movies": {
      "numberOfDocuments": 19654,
      "isIndexing": false,
      "fieldDistribution": {
        "poster": 19654,
        "overview": 19654,
        "title": 19654,
        "id": 19654,
        "release_date": 19654
      }
    },
    "books": {
      "numberOfDocuments": 5,
      "isIndexing": false,
      "fieldDistribution": {
        "id": 5,
        "title": 5,
        "author": 5,
        "price": 5, 
        "genres": 5
      }
    }
  }
}