Get index statistics | Elasticsearch API documentation

Path parameters

indexstring | array[string] Required
A comma-separated list of index names; use _all or empty string to perform the operation on all indices

Query parameters

completion_fieldsstring | array[string]
Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
expand_wildcardsstring | 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.
Values are all, open, closed, hidden, or none.
fielddata_fieldsstring | array[string]
Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
fieldsstring | array[string]
Comma-separated list or wildcard expressions of fields to include in the statistics.
forbid_closed_indicesboolean
If true, statistics are not collected from closed indices.
groupsstring | array[string]
Comma-separated list of search groups to include in the search statistics.
include_segment_file_sizesboolean
If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
include_unloaded_segmentsboolean
If true, the response includes information from segments that are not loaded into memory.
levelstring
Indicates whether statistics are aggregated at the cluster, index, or shard level.
Values are cluster, indices, or shards.

Responses

200 application/json
Hide response attributes Show response attributes object
- indicesobject
  Hide indices attribute Show indices attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  primariesobject
  Hide primaries attributes Show primaries attributes object
  completionobject
  Hide completion attributes Show completion attributes object
  size_in_bytesnumber Required
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  docsobject
  Hide docs attributes Show docs attributes object
  countnumber Required
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  deletednumber
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  fielddataobject
  Hide fielddata attributes Show fielddata attributes object
  evictionsnumber
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  flushobject
  Hide flush attributes Show flush attributes object
  periodicnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  getobject
  Hide get attributes Show get attributes object
  currentnumber Required
  exists_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  exists_time_in_millisnumber
  Time unit for milliseconds
  exists_totalnumber Required
  missing_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  missing_time_in_millisnumber
  Time unit for milliseconds
  missing_totalnumber Required
  timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  time_in_millisnumber
  Time unit for milliseconds
  totalnumber Required
  indexingobject
  Hide indexing attributes Show indexing attributes object
  index_currentnumber Required
  delete_currentnumber Required
  delete_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  delete_time_in_millisnumber
  Time unit for milliseconds
  delete_totalnumber Required
  is_throttledboolean Required
  noop_update_totalnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millisnumber
  Time unit for milliseconds
  index_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  index_time_in_millisnumber
  Time unit for milliseconds
  index_totalnumber Required
  index_failednumber Required
  typesobject
  Hide types attribute Show types attribute object
  *object
  write_loadnumber
  recent_write_loadnumber
  peak_write_loadnumber
  indicesobject Additional properties
  mergesobject
  Hide merges attributes Show merges attributes object
  currentnumber Required
  current_docsnumber Required
  current_sizestring
  current_size_in_bytesnumber Required
  totalnumber Required
  total_auto_throttlestring
  total_auto_throttle_in_bytesnumber Required
  total_docsnumber Required
  total_sizestring
  total_size_in_bytesnumber Required
  total_stopped_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_stopped_time_in_millisnumber
  Time unit for milliseconds
  total_throttled_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_throttled_time_in_millisnumber
  Time unit for milliseconds
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  query_cacheobject
  Hide query_cache attributes Show query_cache attributes object
  cache_countnumber Required
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  cache_sizenumber Required
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  evictionsnumber Required
  Total number of query cache evictions across all shards assigned to selected nodes.
  hit_countnumber Required
  Total count of query cache hits across all shards assigned to selected nodes.
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  miss_countnumber Required
  Total count of query cache misses across all shards assigned to selected nodes.
  total_countnumber Required
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  recoveryobject
  Hide recovery attributes Show recovery attributes object
  current_as_sourcenumber Required
  current_as_targetnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millisnumber
  Time unit for milliseconds
  refreshobject
  Hide refresh attributes Show refresh attributes object
  external_totalnumber Required
  external_total_time_in_millisnumber
  Time unit for milliseconds
  listenersnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  request_cacheobject
  Hide request_cache attributes Show request_cache attributes object
  evictionsnumber Required
  hit_countnumber Required
  memory_sizestring
  memory_size_in_bytesnumber Required
  miss_countnumber Required
  searchobject
  Hide search attributes Show search attributes object
  fetch_currentnumber Required
  fetch_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  fetch_time_in_millisnumber
  Time unit for milliseconds
  fetch_totalnumber Required
  open_contextsnumber
  query_currentnumber Required
  query_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  query_time_in_millisnumber
  Time unit for milliseconds
  query_totalnumber Required
  scroll_currentnumber Required
  scroll_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  scroll_time_in_millisnumber
  Time unit for milliseconds
  scroll_totalnumber Required
  suggest_currentnumber Required
  suggest_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  suggest_time_in_millisnumber
  Time unit for milliseconds
  suggest_totalnumber Required
  groupsobject
  Hide groups attribute Show groups attribute object
  *object
  segmentsobject
  Hide segments attributes Show segments attributes object
  countnumber Required
  Total number of segments across all shards assigned to selected nodes.
  doc_values_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  doc_values_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  file_sizesobject Required
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  Hide file_sizes attribute Show file_sizes attribute object
  *object Additional properties
  fixed_bit_setnumber | string
  One of:
  ByteSizenumber ByteSizestring
  fixed_bit_set_memory_in_bytesnumber Required
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  index_writer_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  index_writer_max_memory_in_bytesnumber
  index_writer_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  max_unsafe_auto_id_timestampnumber Required
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  norms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  norms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  points_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  points_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  stored_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  stored_fields_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  terms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  terms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectory_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectors_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  version_map_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  version_map_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  storeobject
  Hide store attributes Show store attributes object
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  size_in_bytesnumber Required
  Total size, in bytes, of all shards assigned to selected nodes.
  reservednumber | string
  One of:
  ByteSizenumber ByteSizestring
  reserved_in_bytesnumber Required
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  total_data_set_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_data_set_size_in_bytesnumber
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  translogobject
  Hide translog attributes Show translog attributes object
  earliest_last_modified_agenumber Required
  operationsnumber Required
  sizestring
  size_in_bytesnumber Required
  uncommitted_operationsnumber Required
  uncommitted_sizestring
  uncommitted_size_in_bytesnumber Required
  warmerobject
  Hide warmer attributes Show warmer attributes object
  currentnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  bulkobject
  Hide bulk attributes Show bulk attributes object
  total_operationsnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  total_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_size_in_bytesnumber Required
  avg_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  avg_time_in_millisnumber
  Time unit for milliseconds
  avg_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  avg_size_in_bytesnumber Required
  shard_statsobject
  Hide shard_stats attribute Show shard_stats attribute object
  total_countnumber Required
  shardsobject
  Hide shards attribute Show shards attribute object
  *array[object] Additional properties
  Hide * attributes Show * attributes object
  commitobject
  completionobject
  docsobject
  fielddataobject
  flushobject
  getobject
  indexingobject
  mappingsobject
  mergesobject
  shard_pathobject
  query_cacheobject
  recoveryobject
  refreshobject
  request_cacheobject
  retention_leasesobject
  routingobject
  searchobject
  segmentsobject
  seq_noobject
  storeobject
  translogobject
  warmerobject
  bulkobject
  shardsobject Generally available; Added in 7.15.0
  shard_statsobject
  indicesobject Additional properties
  totalobject
  Hide total attributes Show total attributes object
  completionobject
  Hide completion attributes Show completion attributes object
  size_in_bytesnumber Required
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  docsobject
  Hide docs attributes Show docs attributes object
  countnumber Required
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  deletednumber
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  fielddataobject
  Hide fielddata attributes Show fielddata attributes object
  evictionsnumber
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  flushobject
  Hide flush attributes Show flush attributes object
  periodicnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  getobject
  Hide get attributes Show get attributes object
  currentnumber Required
  exists_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  exists_time_in_millisnumber
  Time unit for milliseconds
  exists_totalnumber Required
  missing_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  missing_time_in_millisnumber
  Time unit for milliseconds
  missing_totalnumber Required
  timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  time_in_millisnumber
  Time unit for milliseconds
  totalnumber Required
  indexingobject
  Hide indexing attributes Show indexing attributes object
  index_currentnumber Required
  delete_currentnumber Required
  delete_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  delete_time_in_millisnumber
  Time unit for milliseconds
  delete_totalnumber Required
  is_throttledboolean Required
  noop_update_totalnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millisnumber
  Time unit for milliseconds
  index_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  index_time_in_millisnumber
  Time unit for milliseconds
  index_totalnumber Required
  index_failednumber Required
  typesobject
  Hide types attribute Show types attribute object
  *object
  write_loadnumber
  recent_write_loadnumber
  peak_write_loadnumber
  indicesobject Additional properties
  mergesobject
  Hide merges attributes Show merges attributes object
  currentnumber Required
  current_docsnumber Required
  current_sizestring
  current_size_in_bytesnumber Required
  totalnumber Required
  total_auto_throttlestring
  total_auto_throttle_in_bytesnumber Required
  total_docsnumber Required
  total_sizestring
  total_size_in_bytesnumber Required
  total_stopped_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_stopped_time_in_millisnumber
  Time unit for milliseconds
  total_throttled_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_throttled_time_in_millisnumber
  Time unit for milliseconds
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  query_cacheobject
  Hide query_cache attributes Show query_cache attributes object
  cache_countnumber Required
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  cache_sizenumber Required
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  evictionsnumber Required
  Total number of query cache evictions across all shards assigned to selected nodes.
  hit_countnumber Required
  Total count of query cache hits across all shards assigned to selected nodes.
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  miss_countnumber Required
  Total count of query cache misses across all shards assigned to selected nodes.
  total_countnumber Required
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  recoveryobject
  Hide recovery attributes Show recovery attributes object
  current_as_sourcenumber Required
  current_as_targetnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millisnumber
  Time unit for milliseconds
  refreshobject
  Hide refresh attributes Show refresh attributes object
  external_totalnumber Required
  external_total_time_in_millisnumber
  Time unit for milliseconds
  listenersnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  request_cacheobject
  Hide request_cache attributes Show request_cache attributes object
  evictionsnumber Required
  hit_countnumber Required
  memory_sizestring
  memory_size_in_bytesnumber Required
  miss_countnumber Required
  searchobject
  Hide search attributes Show search attributes object
  fetch_currentnumber Required
  fetch_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  fetch_time_in_millisnumber
  Time unit for milliseconds
  fetch_totalnumber Required
  open_contextsnumber
  query_currentnumber Required
  query_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  query_time_in_millisnumber
  Time unit for milliseconds
  query_totalnumber Required
  scroll_currentnumber Required
  scroll_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  scroll_time_in_millisnumber
  Time unit for milliseconds
  scroll_totalnumber Required
  suggest_currentnumber Required
  suggest_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  suggest_time_in_millisnumber
  Time unit for milliseconds
  suggest_totalnumber Required
  groupsobject
  Hide groups attribute Show groups attribute object
  *object
  segmentsobject
  Hide segments attributes Show segments attributes object
  countnumber Required
  Total number of segments across all shards assigned to selected nodes.
  doc_values_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  doc_values_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  file_sizesobject Required
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  Hide file_sizes attribute Show file_sizes attribute object
  *object Additional properties
  fixed_bit_setnumber | string
  One of:
  ByteSizenumber ByteSizestring
  fixed_bit_set_memory_in_bytesnumber Required
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  index_writer_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  index_writer_max_memory_in_bytesnumber
  index_writer_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  max_unsafe_auto_id_timestampnumber Required
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  norms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  norms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  points_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  points_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  stored_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  stored_fields_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  terms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  terms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectory_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectors_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  version_map_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  version_map_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  storeobject
  Hide store attributes Show store attributes object
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  size_in_bytesnumber Required
  Total size, in bytes, of all shards assigned to selected nodes.
  reservednumber | string
  One of:
  ByteSizenumber ByteSizestring
  reserved_in_bytesnumber Required
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  total_data_set_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_data_set_size_in_bytesnumber
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  translogobject
  Hide translog attributes Show translog attributes object
  earliest_last_modified_agenumber Required
  operationsnumber Required
  sizestring
  size_in_bytesnumber Required
  uncommitted_operationsnumber Required
  uncommitted_sizestring
  uncommitted_size_in_bytesnumber Required
  warmerobject
  Hide warmer attributes Show warmer attributes object
  currentnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  bulkobject
  Hide bulk attributes Show bulk attributes object
  total_operationsnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  total_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_size_in_bytesnumber Required
  avg_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  avg_time_in_millisnumber
  Time unit for milliseconds
  avg_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  avg_size_in_bytesnumber Required
  shard_statsobject
  Hide shard_stats attribute Show shard_stats attribute object
  total_countnumber Required
  uuidstring
  healthstring
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  statusstring
  Values are open or close.
- _shardsobject Required
  Hide _shards attributes Show _shards attributes object
  failednumber Required
  successfulnumber Required
  totalnumber Required
  failuresarray[object]
  Hide failures attributes Show failures attributes object
  indexstring
  nodestring
  reasonobject Required
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Hide reason attributes Show reason attributes object
  typestring Required
  The type of error
  reasonstring | null
  A human-readable explanation of the error, in English.
  One of:
  string-1string string-2string | null
  stack_tracestring
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  caused_byobject
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  root_causearray[object]
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  suppressedarray[object]
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  shardnumber Required
  statusstring
  skippednumber
- _allobject Required Additional properties
  Hide _all attributes Show _all attributes object
  primariesobject
  Hide primaries attributes Show primaries attributes object
  completionobject
  Hide completion attributes Show completion attributes object
  size_in_bytesnumber Required
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  size
  size_in_bytesnumber Required
  docsobject
  Hide docs attributes Show docs attributes object
  countnumber Required
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  deletednumber
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  fielddataobject
  Hide fielddata attributes Show fielddata attributes object
  evictionsnumber
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  memory_size
  memory_size_in_bytesnumber Required
  flushobject
  Hide flush attributes Show flush attributes object
  periodicnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  getobject
  Hide get attributes Show get attributes object
  currentnumber Required
  exists_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  exists_time_in_millisnumber
  Time unit for milliseconds
  exists_totalnumber Required
  missing_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  missing_time_in_millisnumber
  Time unit for milliseconds
  missing_totalnumber Required
  timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  time_in_millisnumber
  Time unit for milliseconds
  totalnumber Required
  indexingobject
  Hide indexing attributes Show indexing attributes object
  index_currentnumber Required
  delete_currentnumber Required
  delete_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  delete_time_in_millisnumber
  Time unit for milliseconds
  delete_totalnumber Required
  is_throttledboolean Required
  noop_update_totalnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millisnumber
  Time unit for milliseconds
  index_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  index_time_in_millisnumber
  Time unit for milliseconds
  index_totalnumber Required
  index_failednumber Required
  typesobject
  Hide types attribute Show types attribute object
  *object
  write_loadnumber
  recent_write_loadnumber
  peak_write_loadnumber
  indicesobject Additional properties
  mergesobject
  Hide merges attributes Show merges attributes object
  currentnumber Required
  current_docsnumber Required
  current_sizestring
  current_size_in_bytesnumber Required
  totalnumber Required
  total_auto_throttlestring
  total_auto_throttle_in_bytesnumber Required
  total_docsnumber Required
  total_sizestring
  total_size_in_bytesnumber Required
  total_stopped_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_stopped_time_in_millisnumber
  Time unit for milliseconds
  total_throttled_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_throttled_time_in_millisnumber
  Time unit for milliseconds
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  query_cacheobject
  Hide query_cache attributes Show query_cache attributes object
  cache_countnumber Required
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  cache_sizenumber Required
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  evictionsnumber Required
  Total number of query cache evictions across all shards assigned to selected nodes.
  hit_countnumber Required
  Total count of query cache hits across all shards assigned to selected nodes.
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  miss_countnumber Required
  Total count of query cache misses across all shards assigned to selected nodes.
  total_countnumber Required
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  recoveryobject
  Hide recovery attributes Show recovery attributes object
  current_as_sourcenumber Required
  current_as_targetnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millisnumber
  Time unit for milliseconds
  refreshobject
  Hide refresh attributes Show refresh attributes object
  external_totalnumber Required
  external_total_time_in_millisnumber
  Time unit for milliseconds
  listenersnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  request_cacheobject
  Hide request_cache attributes Show request_cache attributes object
  evictionsnumber Required
  hit_countnumber Required
  memory_sizestring
  memory_size_in_bytesnumber Required
  miss_countnumber Required
  searchobject
  Hide search attributes Show search attributes object
  fetch_currentnumber Required
  fetch_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  fetch_time_in_millisnumber
  Time unit for milliseconds
  fetch_totalnumber Required
  open_contextsnumber
  query_currentnumber Required
  query_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  query_time_in_millisnumber
  Time unit for milliseconds
  query_totalnumber Required
  scroll_currentnumber Required
  scroll_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  scroll_time_in_millisnumber
  Time unit for milliseconds
  scroll_totalnumber Required
  suggest_currentnumber Required
  suggest_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  suggest_time_in_millisnumber
  Time unit for milliseconds
  suggest_totalnumber Required
  groupsobject
  Hide groups attribute Show groups attribute object
  *object
  segmentsobject
  Hide segments attributes Show segments attributes object
  countnumber Required
  Total number of segments across all shards assigned to selected nodes.
  doc_values_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  doc_values_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  file_sizesobject Required
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  Hide file_sizes attribute Show file_sizes attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  descriptionstring Required
  size_in_bytesnumber Required
  min_size_in_bytesnumber
  max_size_in_bytesnumber
  average_size_in_bytesnumber
  countnumber
  fixed_bit_setnumber | string
  One of:
  ByteSizenumber ByteSizestring
  fixed_bit_set_memory_in_bytesnumber Required
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  index_writer_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  index_writer_max_memory_in_bytesnumber
  index_writer_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  max_unsafe_auto_id_timestampnumber Required
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  norms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  norms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  points_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  points_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  stored_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  stored_fields_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  terms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  terms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectory_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectors_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  version_map_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  version_map_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  storeobject
  Hide store attributes Show store attributes object
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  size_in_bytesnumber Required
  Total size, in bytes, of all shards assigned to selected nodes.
  reservednumber | string
  One of:
  ByteSizenumber ByteSizestring
  reserved_in_bytesnumber Required
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  total_data_set_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_data_set_size_in_bytesnumber
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  translogobject
  Hide translog attributes Show translog attributes object
  earliest_last_modified_agenumber Required
  operationsnumber Required
  sizestring
  size_in_bytesnumber Required
  uncommitted_operationsnumber Required
  uncommitted_sizestring
  uncommitted_size_in_bytesnumber Required
  warmerobject
  Hide warmer attributes Show warmer attributes object
  currentnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  bulkobject
  Hide bulk attributes Show bulk attributes object
  total_operationsnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  total_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_size_in_bytesnumber Required
  avg_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  avg_time_in_millisnumber
  Time unit for milliseconds
  avg_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  avg_size_in_bytesnumber Required
  shard_statsobject
  Hide shard_stats attribute Show shard_stats attribute object
  total_countnumber Required
  shardsobject
  Hide shards attribute Show shards attribute object
  *array[object] Additional properties
  Hide * attributes Show * attributes object
  commitobject
  Hide commit attributes Show commit attributes object
  generationnumber Required
  idstring Required
  num_docsnumber Required
  user_dataobject Required
  completionobject
  Hide completion attributes Show completion attributes object
  size_in_bytesnumber Required
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  size
  fieldsobject
  docsobject
  Hide docs attributes Show docs attributes object
  countnumber Required
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  deletednumber
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  fielddataobject
  Hide fielddata attributes Show fielddata attributes object
  evictionsnumber
  memory_size
  memory_size_in_bytesnumber Required
  fieldsobject
  flushobject
  Hide flush attributes Show flush attributes object
  periodicnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millis
  getobject
  Hide get attributes Show get attributes object
  currentnumber Required
  exists_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  exists_time_in_millis
  exists_totalnumber Required
  missing_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  missing_time_in_millis
  missing_totalnumber Required
  timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  time_in_millis
  totalnumber Required
  indexingobject
  Hide indexing attributes Show indexing attributes object
  index_currentnumber Required
  delete_currentnumber Required
  delete_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  delete_time_in_millis
  delete_totalnumber Required
  is_throttledboolean Required
  noop_update_totalnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millis
  index_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  index_time_in_millis
  index_totalnumber Required
  index_failednumber Required
  typesobject
  write_loadnumber
  recent_write_loadnumber
  peak_write_loadnumber
  mappingsobject
  Hide mappings attributes Show mappings attributes object
  total_countnumber Required
  total_estimated_overhead
  total_estimated_overhead_in_bytesnumber Required
  mergesobject
  Hide merges attributes Show merges attributes object
  currentnumber Required
  current_docsnumber Required
  current_sizestring
  current_size_in_bytesnumber Required
  totalnumber Required
  total_auto_throttlestring
  total_auto_throttle_in_bytesnumber Required
  total_docsnumber Required
  total_sizestring
  total_size_in_bytesnumber Required
  total_stopped_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_stopped_time_in_millis
  total_throttled_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_throttled_time_in_millis
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millis
  shard_pathobject
  Hide shard_path attributes Show shard_path attributes object
  data_pathstring Required
  is_custom_data_pathboolean Required
  state_pathstring Required
  query_cacheobject
  Hide query_cache attributes Show query_cache attributes object
  cache_countnumber Required
  cache_sizenumber Required
  evictionsnumber Required
  hit_countnumber Required
  memory_size_in_bytesnumber Required
  miss_countnumber Required
  total_countnumber Required
  recoveryobject
  Hide recovery attributes Show recovery attributes object
  current_as_sourcenumber Required
  current_as_targetnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millis
  refreshobject
  Hide refresh attributes Show refresh attributes object
  external_totalnumber Required
  external_total_time_in_millis
  listenersnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millis
  request_cacheobject
  Hide request_cache attributes Show request_cache attributes object
  evictionsnumber Required
  hit_countnumber Required
  memory_sizestring
  memory_size_in_bytesnumber Required
  miss_countnumber Required
  retention_leasesobject
  Hide retention_leases attributes Show retention_leases attributes object
  primary_termnumber Required
  versionnumber Required
  leasesarray[object] Required
  routingobject
  Hide routing attributes Show routing attributes object
  nodestring Required
  primaryboolean Required
  relocating_node
  statestring Required
  Values are UNASSIGNED, INITIALIZING, STARTED, or RELOCATING.
  searchobject
  Hide search attributes Show search attributes object
  fetch_currentnumber Required
  fetch_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  fetch_time_in_millis
  fetch_totalnumber Required
  open_contextsnumber
  query_currentnumber Required
  query_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  query_time_in_millis
  query_totalnumber Required
  scroll_currentnumber Required
  scroll_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  scroll_time_in_millis
  scroll_totalnumber Required
  suggest_currentnumber Required
  suggest_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  suggest_time_in_millis
  suggest_totalnumber Required
  groupsobject
  segmentsobject
  Hide segments attributes Show segments attributes object
  countnumber Required
  Total number of segments across all shards assigned to selected nodes.
  doc_values_memory
  doc_values_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  file_sizesobject Required
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  fixed_bit_set
  fixed_bit_set_memory_in_bytesnumber Required
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  index_writer_memory
  index_writer_max_memory_in_bytesnumber
  index_writer_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  max_unsafe_auto_id_timestampnumber Required
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  memory
  memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  norms_memory
  norms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  points_memory
  points_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  stored_memory
  stored_fields_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  terms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  terms_memory
  term_vectory_memory
  term_vectors_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  version_map_memory
  version_map_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  seq_noobject
  Hide seq_no attributes Show seq_no attributes object
  global_checkpointnumber Required
  local_checkpointnumber Required
  max_seq_nonumber Required
  storeobject
  Hide store attributes Show store attributes object
  size
  size_in_bytesnumber Required
  Total size, in bytes, of all shards assigned to selected nodes.
  reserved
  reserved_in_bytesnumber Required
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  total_data_set_size
  total_data_set_size_in_bytesnumber
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  translogobject
  Hide translog attributes Show translog attributes object
  earliest_last_modified_agenumber Required
  operationsnumber Required
  sizestring
  size_in_bytesnumber Required
  uncommitted_operationsnumber Required
  uncommitted_sizestring
  uncommitted_size_in_bytesnumber Required
  warmerobject
  Hide warmer attributes Show warmer attributes object
  currentnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millis
  bulkobject
  Hide bulk attributes Show bulk attributes object
  total_operationsnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millis
  total_size
  total_size_in_bytesnumber Required
  avg_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  avg_time_in_millis
  avg_size
  avg_size_in_bytesnumber Required
  shardsobject Generally available; Added in 7.15.0
  Hide shards attribute Show shards attribute object
  *object Additional properties
  shard_statsobject
  Hide shard_stats attribute Show shard_stats attribute object
  total_countnumber Required
  indicesobject Additional properties
  totalobject
  Hide total attributes Show total attributes object
  completionobject
  Hide completion attributes Show completion attributes object
  size_in_bytesnumber Required
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  size
  size_in_bytesnumber Required
  docsobject
  Hide docs attributes Show docs attributes object
  countnumber Required
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  deletednumber
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  fielddataobject
  Hide fielddata attributes Show fielddata attributes object
  evictionsnumber
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  memory_size
  memory_size_in_bytesnumber Required
  flushobject
  Hide flush attributes Show flush attributes object
  periodicnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  getobject
  Hide get attributes Show get attributes object
  currentnumber Required
  exists_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  exists_time_in_millisnumber
  Time unit for milliseconds
  exists_totalnumber Required
  missing_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  missing_time_in_millisnumber
  Time unit for milliseconds
  missing_totalnumber Required
  timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  time_in_millisnumber
  Time unit for milliseconds
  totalnumber Required
  indexingobject
  Hide indexing attributes Show indexing attributes object
  index_currentnumber Required
  delete_currentnumber Required
  delete_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  delete_time_in_millisnumber
  Time unit for milliseconds
  delete_totalnumber Required
  is_throttledboolean Required
  noop_update_totalnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millisnumber
  Time unit for milliseconds
  index_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  index_time_in_millisnumber
  Time unit for milliseconds
  index_totalnumber Required
  index_failednumber Required
  typesobject
  Hide types attribute Show types attribute object
  *object
  write_loadnumber
  recent_write_loadnumber
  peak_write_loadnumber
  indicesobject Additional properties
  mergesobject
  Hide merges attributes Show merges attributes object
  currentnumber Required
  current_docsnumber Required
  current_sizestring
  current_size_in_bytesnumber Required
  totalnumber Required
  total_auto_throttlestring
  total_auto_throttle_in_bytesnumber Required
  total_docsnumber Required
  total_sizestring
  total_size_in_bytesnumber Required
  total_stopped_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_stopped_time_in_millisnumber
  Time unit for milliseconds
  total_throttled_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_throttled_time_in_millisnumber
  Time unit for milliseconds
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  query_cacheobject
  Hide query_cache attributes Show query_cache attributes object
  cache_countnumber Required
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  cache_sizenumber Required
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  evictionsnumber Required
  Total number of query cache evictions across all shards assigned to selected nodes.
  hit_countnumber Required
  Total count of query cache hits across all shards assigned to selected nodes.
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  miss_countnumber Required
  Total count of query cache misses across all shards assigned to selected nodes.
  total_countnumber Required
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  recoveryobject
  Hide recovery attributes Show recovery attributes object
  current_as_sourcenumber Required
  current_as_targetnumber Required
  throttle_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  throttle_time_in_millisnumber
  Time unit for milliseconds
  refreshobject
  Hide refresh attributes Show refresh attributes object
  external_totalnumber Required
  external_total_time_in_millisnumber
  Time unit for milliseconds
  listenersnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  request_cacheobject
  Hide request_cache attributes Show request_cache attributes object
  evictionsnumber Required
  hit_countnumber Required
  memory_sizestring
  memory_size_in_bytesnumber Required
  miss_countnumber Required
  searchobject
  Hide search attributes Show search attributes object
  fetch_currentnumber Required
  fetch_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  fetch_time_in_millisnumber
  Time unit for milliseconds
  fetch_totalnumber Required
  open_contextsnumber
  query_currentnumber Required
  query_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  query_time_in_millisnumber
  Time unit for milliseconds
  query_totalnumber Required
  scroll_currentnumber Required
  scroll_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  scroll_time_in_millisnumber
  Time unit for milliseconds
  scroll_totalnumber Required
  suggest_currentnumber Required
  suggest_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  suggest_time_in_millisnumber
  Time unit for milliseconds
  suggest_totalnumber Required
  groupsobject
  Hide groups attribute Show groups attribute object
  *object
  segmentsobject
  Hide segments attributes Show segments attributes object
  countnumber Required
  Total number of segments across all shards assigned to selected nodes.
  doc_values_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  doc_values_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  file_sizesobject Required
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  Hide file_sizes attribute Show file_sizes attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  descriptionstring Required
  size_in_bytesnumber Required
  min_size_in_bytesnumber
  max_size_in_bytesnumber
  average_size_in_bytesnumber
  countnumber
  fixed_bit_setnumber | string
  One of:
  ByteSizenumber ByteSizestring
  fixed_bit_set_memory_in_bytesnumber Required
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  index_writer_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  index_writer_max_memory_in_bytesnumber
  index_writer_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  max_unsafe_auto_id_timestampnumber Required
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  norms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  norms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  points_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  points_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  stored_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  stored_fields_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  terms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  terms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectory_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectors_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  version_map_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  version_map_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  storeobject
  Hide store attributes Show store attributes object
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  size_in_bytesnumber Required
  Total size, in bytes, of all shards assigned to selected nodes.
  reservednumber | string
  One of:
  ByteSizenumber ByteSizestring
  reserved_in_bytesnumber Required
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  total_data_set_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_data_set_size_in_bytesnumber
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  translogobject
  Hide translog attributes Show translog attributes object
  earliest_last_modified_agenumber Required
  operationsnumber Required
  sizestring
  size_in_bytesnumber Required
  uncommitted_operationsnumber Required
  uncommitted_sizestring
  uncommitted_size_in_bytesnumber Required
  warmerobject
  Hide warmer attributes Show warmer attributes object
  currentnumber Required
  totalnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  bulkobject
  Hide bulk attributes Show bulk attributes object
  total_operationsnumber Required
  total_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_time_in_millisnumber
  Time unit for milliseconds
  total_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_size_in_bytesnumber Required
  avg_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  avg_time_in_millisnumber
  Time unit for milliseconds
  avg_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  avg_size_in_bytesnumber Required
  shard_statsobject
  Hide shard_stats attribute Show shard_stats attribute object
  total_countnumber Required
  uuidstring
  healthstring
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  statusstring
  Values are open or close.

GET /{index}/_stats

GET _stats/fielddata?human&fields=my_join_field#question

resp = client.indices.stats(
    metric="fielddata",
    human=True,
    fields="my_join_field",
)

const response = await client.indices.stats({
  metric: "fielddata",
  human: "true",
  fields: "my_join_field",
});

response = client.indices.stats(
  metric: "fielddata",
  human: "true",
  fields: "my_join_field"
)

$resp = $client->indices()->stats([
    "metric" => "fielddata",
    "human" => "true",
    "fields" => "my_join_field",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_stats/fielddata?human&fields=my_join_field#question"

Path parameters

Query parameters

Responses

sizenumber | string

memory_sizenumber | string

memory_sizenumber | string

doc_values_memorynumber | string

fixed_bit_setnumber | string

index_writer_memorynumber | string

memorynumber | string

norms_memorynumber | string

points_memorynumber | string

stored_memorynumber | string

terms_memorynumber | string

term_vectory_memorynumber | string

version_map_memorynumber | string

sizenumber | string

reservednumber | string

total_data_set_sizenumber | string

total_sizenumber | string

avg_sizenumber | string

sizenumber | string

memory_sizenumber | string

memory_sizenumber | string

doc_values_memorynumber | string

fixed_bit_setnumber | string

index_writer_memorynumber | string

memorynumber | string

norms_memorynumber | string

points_memorynumber | string

stored_memorynumber | string

terms_memorynumber | string

term_vectory_memorynumber | string

version_map_memorynumber | string

sizenumber | string

reservednumber | string

total_data_set_sizenumber | string

total_sizenumber | string

avg_sizenumber | string

reasonstring | null

sizenumber | string

memory_sizenumber | string

memory_sizenumber | string

doc_values_memorynumber | string

fixed_bit_setnumber | string

index_writer_memorynumber | string

memorynumber | string

norms_memorynumber | string

points_memorynumber | string

stored_memorynumber | string

terms_memorynumber | string

term_vectory_memorynumber | string

version_map_memorynumber | string

sizenumber | string

reservednumber | string

total_data_set_sizenumber | string

total_sizenumber | string

avg_sizenumber | string

sizenumber | string

memory_sizenumber | string

memory_sizenumber | string

doc_values_memorynumber | string

fixed_bit_setnumber | string

index_writer_memorynumber | string

memorynumber | string

norms_memorynumber | string

points_memorynumber | string

stored_memorynumber | string

terms_memorynumber | string

term_vectory_memorynumber | string

version_map_memorynumber | string

sizenumber | string

reservednumber | string

total_data_set_sizenumber | string

total_sizenumber | string

avg_sizenumber | string