Get the rollup index capabilities

deprecated

GET /{index}/_rollup/data

Get the rollup capabilities of all jobs inside of a rollup index. A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:

What jobs are stored in an index (or indices specified via a pattern)?
What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?

Required authorization

Index privileges: read

Path Parameters

index union Id | [] Id required: Data stream or index to check for rollup capabilities. Wildcard (*) expressions are supported.

Response

application/json

Examples

A successful response from GET /sensor_rollup/_rollup/data. The response contains the rollup job ID, the index that holds the rolled data, and the index pattern that the job was targeting. It also shows a list of fields that contain data eligible for rollup searches. For example, you can use a min, max, or sum aggregation on the temperature field, but only a date_histogram on timestamp.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /sensor_rollup/_rollup/data

JavaScript Elasticsearch JavaScript Client

const response = await client.rollup.getRollupIndexCaps({
  index: "sensor_rollup",
});

Python Elasticsearch Python Client

resp = client.rollup.get_rollup_index_caps(
    index="sensor_rollup",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/sensor_rollup/_rollup/data" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.rollup().getRollupIndexCaps(g -> g
    .index("sensor_rollup")
);

C# Elasticsearch .NET Client

var response = await client.Rollup.GetRollupIndexCapsAsync(index: new[] { "sensor_rollup" });

PHP Elasticsearch PHP Client

$resp = $client->rollup()->getRollupIndexCaps([
    "index" => "sensor_rollup",
]);

Ruby Elasticsearch Ruby Client

response = client.perform_request(
  "GET",
  "/sensor_rollup/_rollup/data",
  {},
)

Response

{
  "sensor_rollup" : {
    "rollup_jobs" : [
      {
        "job_id" : "sensor",
        "rollup_index" : "sensor_rollup",
        "index_pattern" : "sensor-*",
        "fields" : {
          "node" : [
            {
              "agg" : "terms"
            }
          ],
          "temperature" : [
            {
              "agg" : "min"
            },
            {
              "agg" : "max"
            },
            {
              "agg" : "sum"
            }
          ],
          "timestamp" : [
            {
              "agg" : "date_histogram",
              "time_zone" : "UTC",
              "fixed_interval" : "1h",
              "delay": "7d"
            }
          ],
          "voltage" : [
            {
              "agg" : "avg"
            }
          ]
        }
      }
    ]
  }
}