rest-api-spec.api.indices.field_usage_stats.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.16.0

{
  "indices.field_usage_stats": {
    "documentation": {
      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/field-usage-stats.html",
      "description": "Returns the field usage stats for each field of an index"
    },
    "stability": "experimental",
    "visibility": "public",
    "headers": {
      "accept": [
        "application/json"
      ]
    },
    "url": {
      "paths": [
        {
          "path": "/{index}/_field_usage_stats",
          "methods": [
            "GET"
          ],
          "parts": {
            "index": {
              "type": "string",
              "description": "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
            }
          }
        }
      ]
    },
    "params": {
      "fields":{
        "type":"list",
        "description":"A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards)"
      },
      "ignore_unavailable": {
        "type": "boolean",
        "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
      },
      "allow_no_indices": {
        "type": "boolean",
        "description": "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": {
        "type": "enum",
        "options": [
          "open",
          "closed",
          "hidden",
          "none",
          "all"
        ],
        "default": "open",
        "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
      }
    }
  }
}