WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« fieldCaps get »

› ›

fieldStats

edit

fieldStats

edit

client.fieldStats({
  index: string | string[],
  fields: string | string[],
  level: 'indices' | 'cluster',
  ignore_unavailable: boolean,
  allow_no_indices: boolean,
  expand_wildcards: 'open' | 'closed' | 'none' | 'all',
  body: object
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`fields`	`string \| string[]` - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
`level`	`'indices' \| 'cluster'` - Defines if field stats should be returned on a per index level or on a cluster wide level Default: `cluster`
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allow_no_indices` or `allowNoIndices`	`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. Default: `open`
`body`	`object` - Field json objects containing the name and optionally a range to filter out indices result, that have results outside the defined bounds

« fieldCaps get »