# Get field usage stats

**GET /{index}/_field_usage_stats**

Get field usage information for each shard and field of an index.
Field usage statistics are automatically captured when queries are running on a cluster.
A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.

The response body reports the per-shard usage count of the data structures that back the fields in the index.
A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.

## Required authorization

* Index privileges: `manage`



## Servers
- http://api.example.com: http://api.example.com ()


## Authentication methods
- Api key auth
- Basic auth
- Bearer auth


## Parameters

### Path parameters
- **index** (string | array[string])
  Comma-separated list or wildcard expression of index names used to limit the request.

### Query parameters
- **allow_no_indices** (boolean)
  If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
  This behavior applies even if the request targets other open indices.
  For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
- **expand_wildcards** (string | array[string])
  Type of index that wildcard patterns can match.
  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
  Supports comma-separated values, such as `open,hidden`.

  Supported values include:
    - `all`: Match any data stream or index, including hidden ones.
    - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.
    - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
    - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.
    - `none`: Wildcard expressions are not accepted.

- **ignore_unavailable** (boolean)
  If `true`, missing or closed indices are not included in the response.
- **fields** (string | array[string])
  Comma-separated list or wildcard expressions of fields to include in the statistics.


## Responses
### 200


#### Body: application/json (object)
- **_shards** (object)



[Powered by Bump.sh](https://bump.sh)