OpenSearch/rest-api-spec/api/indices.stats.json

{
  "indices.stats": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-stats.html",
    "methods": ["GET"],
    "url": {
      "path": "/_stats",
      "paths": [
        "/_stats",
        "/_stats/{metric}",
        "/{index}/_stats",
        "/{index}/_stats/{metric}"
      ],
      "parts": {
        "index": {
          "type" : "list",
          "description" : "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
        },
        "metric" : {
          "type" : "list",
          "options" : ["_all", "completion", "docs", "fielddata", "filter_cache", "flush", "get", "id_cache", "indexing", "merge", "percolate", "query_cache", "refresh", "search", "segments", "store", "warmer", "suggest"],
          "description" : "Limit the information returned the specific metrics."
        }
      },
      "params": {
        "completion_fields": {
          "type" : "list",
          "description" : "A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)"
        },
        "fielddata_fields": {
          "type" : "list",
          "description" : "A comma-separated list of fields for `fielddata` index metric (supports wildcards)"
        },
        "fields": {
          "type" : "list",
          "description" : "A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)"
        },
        "groups": {
          "type" : "list",
          "description" : "A comma-separated list of search groups for `search` index metric"
        },
        "human": {
            "type": "boolean",
            "description": "Whether to return time and byte values in human-readable format.",
            "default": false
        },
        "level": {
          "type" : "enum",
          "description": "Return stats aggregated at cluster, index or shard level",
          "options" : ["cluster", "indices", "shards"],
          "default" : "indices"
        },
        "types" : {
          "type" : "list",
          "description" : "A comma-separated list of document types for the `indexing` index metric"
        }
      },
      "body": null
    }
  }
}