Get rollup job information

GET /_rollup/job/{id}
GET /_rollup/job

Auth Deprecated

Get the configuration, stats, and status of rollup jobs.

Note

This API returns only active (both STARTED and STOPPED) jobs. If a job was created, ran for a while, then was deleted, the API does not return any details about it. For details about a historical rollup job, the rollup capabilities API may be more useful.

Required privileges

Cluster privileges monitor_rollup

Path parameters

id string optional

Identifier for the rollup job. If it is _all or omitted, the API returns all rollup jobs.

Leave it out to use /_rollup/job.

Response

application/json

jobs object[] required

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _rollup/job/sensor

JavaScript Elasticsearch JavaScript Client

const response = await client.rollup.getJobs({
  id: "sensor",
});

Python Elasticsearch Python Client

resp = client.rollup.get_jobs(
    id="sensor",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_rollup/job/sensor" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.rollup().getJobs(g -> g
    .id("sensor")
);

C# Elasticsearch .NET Client

var response = await client.Rollup
    .GetJobsAsync(d1 => d1
        .Id("sensor")
    );

PHP Elasticsearch PHP Client

$resp = $client->rollup()->getJobs([
    "id" => "sensor",
]);

Ruby Elasticsearch Ruby Client

response = client.perform_request(
  "GET",
  "/_rollup/job/sensor",
  {},
)

Response

A successful response from GET _rollup/job/sensor.

{
  "jobs": [
    {
      "config": {
        "id": "sensor",
        "index_pattern": "sensor-*",
        "rollup_index": "sensor_rollup",
        "cron": "*/30 * * * * ?",
        "groups": {
          "date_histogram": {
            "fixed_interval": "1h",
            "delay": "7d",
            "field": "timestamp",
            "time_zone": "UTC"
          },
          "terms": {
            "fields": [
              "node"
            ]
          }
        },
        "metrics": [
          {
            "field": "temperature",
            "metrics": [
              "min",
              "max",
              "sum"
            ]
          },
          {
            "field": "voltage",
            "metrics": [
              "avg"
            ]
          }
        ],
        "timeout": "20s",
        "page_size": 1000
      },
      "status": {
        "job_state": "stopped"
      },
      "stats": {
        "pages_processed": 0,
        "documents_processed": 0,
        "rollups_indexed": 0,
        "trigger_count": 0,
        "index_failures": 0,
        "index_time_in_ms": 0,
        "index_total": 0,
        "search_failures": 0,
        "search_time_in_ms": 0,
        "search_total": 0,
        "processing_time_in_ms": 0,
        "processing_total": 0
      }
    }
  ]
}