[[reference-indices-stats]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.indices.stats

Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream’s backing indices.

{ref}/indices-stats.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(IndicesStatsRequest, options?): Promise<IndicesStatsResponse>
----

[discrete]
===== `IndicesStatsRequest`

[source,ts]
----
interface IndicesStatsRequest extends <<shared-type-request-base, RequestBase>> {
  metric?: <<shared-type-metrics, Metrics>>
  index?: <<shared-type-indices, Indices>>
  completion_fields?: <<shared-type-fields, Fields>>
  expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
  fielddata_fields?: <<shared-type-fields, Fields>>
  fields?: <<shared-type-fields, Fields>>
  forbid_closed_indices?: boolean
  groups?: string | string[]
  include_segment_file_sizes?: boolean
  include_unloaded_segments?: boolean
  level?: <<shared-type-level, Level>>
}
----

[discrete]
===== `IndicesStatsResponse`

[source,ts]
----
interface IndicesStatsResponse {
  indices?: Record<string, IndicesStatsIndicesStats>
  _shards: <<shared-type-shard-statistics, ShardStatistics>>
  _all: IndicesStatsIndicesStats
}
----