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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /my-index-000001/_field_usage_stats

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.fieldUsageStats({
  index: "my-index-000001",
});

Python Elasticsearch Python Client

resp = client.indices.field_usage_stats(
    index="my-index-000001",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/my-index-000001/_field_usage_stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().fieldUsageStats(f -> f
    .index("my-index-000001")
);

C# Elasticsearch .NET Client

var response = await client.Indices.FieldUsageStatsAsync(indices: new[] { "my-index-000001" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->fieldUsageStats([
    "index" => "my-index-000001",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.field_usage_stats(
  index: "my-index-000001"
)

Response

An abbreviated response from GET /my-index-000001/_field_usage_stats. The all_fields object reports the sums of the usage counts for all fields in the index (on the listed shard).

{
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "my-index-000001": {
    "shards": [
      {
        "tracking_id": "MpOl0QlTQ4SYYhEe6KgJoQ",
        "tracking_started_at_millis": 1625558985010,
        "routing": {
          "state": "STARTED",
          "primary": true,
          "node": "gA6KeeVzQkGURFCUyV-e8Q",
          "relocating_node": null
        },
        "stats": {
          "all_fields": {
            "any": "6",
            "inverted_index": {
              "terms": 1,
              "postings": 1,
              "proximity": 1,
              "positions": 0,
              "term_frequencies": 1,
              "offsets": 0,
              "payloads": 0
            },
            "stored_fields": 2,
            "doc_values": 1,
            "points": 0,
            "norms": 1,
            "term_vectors": 0,
            "knn_vectors": 0
          },
          "fields": {
            "_id": {
              "any": 1,
              "inverted_index": {
                "terms": 1,
                "postings": 1,
                "proximity": 1,
                "positions": 0,
                "term_frequencies": 1,
                "offsets": 0,
                "payloads": 0
              },
              "stored_fields": 1,
              "doc_values": 0,
              "points": 0,
              "norms": 0,
              "term_vectors": 0,
              "knn_vectors": 0
            },
            "_source": {},
            "context": {},
            "message.keyword": {}
          }
        }
      }
    ]
  }
}

Get field usage stats

Required authorization

Authentication

Path parameters

Query parameters

Response