NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

indices.stats

edit

indices.stats

edit

client.indices.stats({
  index: string | string[],
  metric: string | string[],
  completion_fields: string | string[],
  fielddata_fields: string | string[],
  fields: string | string[],
  groups: string | string[],
  level: 'cluster' | 'indices' | 'shards',
  types: string | string[],
  include_segment_file_sizes: boolean
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`metric`	`string \| string[]` - Limit the information returned the specific metrics.
`completion_fields` or `completionFields`	`string \| string[]` - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
`fielddata_fields` or `fielddataFields`	`string \| string[]` - A comma-separated list of fields for `fielddata` index metric (supports wildcards)
`fields`	`string \| string[]` - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
`groups`	`string \| string[]` - A comma-separated list of search groups for `search` index metric
`level`	`'cluster' \| 'indices' \| 'shards'` - Return stats aggregated at cluster, index or shard level Default: `indices`
`types`	`string \| string[]` - A comma-separated list of document types for the `indexing` index metric
`include_segment_file_sizes` or `includeSegmentFileSizes`	`boolean` - Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)

« indices.split indices.updateAliases »