[[reference-indices-field_usage_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.fieldUsageStats]]
=== client.indices.fieldUsageStats

Returns field usage information for each shard and field of an index.

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

[discrete]
==== Function signature

[source,ts]
----
(IndicesFieldUsageStatsRequest, options?): Promise<IndicesFieldUsageStatsResponse>
----

[discrete]
==== Request

[pass]
++++
<pre>
++++
interface IndicesFieldUsageStatsRequest extends <<RequestBase>> {
  index: <<Indices>>
  allow_no_indices?: boolean
  expand_wildcards?: <<ExpandWildcards>>
  ignore_unavailable?: boolean
  fields?: <<Fields>>
  master_timeout?: <<Duration>>
  timeout?: <<Duration>>
  wait_for_active_shards?: <<WaitForActiveShards>>
}

[pass]
++++
</pre>
++++
[discrete]
==== Response

[pass]
++++
<pre>
++++
type IndicesFieldUsageStatsResponse = IndicesFieldUsageStatsFieldsUsageBody

[pass]
++++
</pre>
++++