AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityExperimental since 6.3This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.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.
A date histogram group aggregates a date field into time-based buckets.
This group is mandatory; you currently cannot roll up documents without a timestamp and a date_histogram group.
delayuniononeOf
How long to wait before rolling up new documents.
By default, the indexer attempts to roll up all data that is available.
However, it is not uncommon for data to arrive out of order.
The indexer is unable to deal with data that arrives after a time-span has been rolled up.
You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive.
Values:-10
fieldstringrequired
The date field that is to be rolled up.
formatstring
intervaluniononeOf
Values:-10
calendar_intervaluniononeOf
The interval of time buckets to be generated when rolling up.
Values:-10
fixed_intervaluniononeOf
The interval of time buckets to be generated when rolling up.
Values:-10
time_zonestring
Defines what time_zone the rollup documents are stored as.
Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone.
By default, rollup documents are stored in UTC.
histogramobject
The histogram group aggregates one or more numeric fields into numeric histogram intervals.
fieldsuniononeOfrequired
The set of fields that you wish to build histograms for.
All fields specified must be some kind of numeric.
Order does not matter.
One of:string[]orstring
intervalnumberrequired
The interval of histogram buckets to be generated when rolling up.
For example, a value of 5 creates buckets that are five units wide (0-5, 5-10, etc).
Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval.
termsobject
The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point.
The indexer enumerates and stores all values of a field for each time-period.
This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse.
fieldsuniononeOfrequired
The set of fields that you wish to collect terms for.
This array can contain fields that are both keyword and numerics.
Order does not matter.
One of:string[]orstring
idstringrequired
index_patternstringrequired
metricsobject[]required
fieldstringrequired
The field to collect metrics for. This must be a numeric of some kind.
metricsenum[]required
An array of metrics to collect for the field. At least one metric must be configured.
Values:minmaxsumavgvalue_count
page_sizenumberrequired
rollup_indexstringrequired
timeoutuniononeOfrequired
Values:-10
statsobjectrequired
Transient statistics about the rollup job, such as how many documents have been processed and how many rollup summary docs have been indexed.
These stats are not persisted.
If a node is restarted, these stats are reset.
documents_processednumberrequired
index_failuresnumberrequired
index_time_in_msnumberrequired
index_totalnumberrequired
pages_processednumberrequired
rollups_indexednumberrequired
search_failuresnumberrequired
search_time_in_msnumberrequired
search_totalnumberrequired
trigger_countnumberrequired
processing_time_in_msnumberrequired
processing_totalnumberrequired
statusobjectrequired
The current status of the indexer for the rollup job.