Body Required

• cron string Required

  A cron string which defines the intervals when the rollup job should be executed. When the interval triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated to the time interval of the data being rolled up. For example, you may wish to create hourly rollups of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The cron pattern is defined just like a Watcher cron schedule.

• groups object Required

  Additional properties are allowed.

  Hide groups attributes Show groups attributes object

  • date_histogram object

    Additional properties are allowed.

    Hide date_histogram attributes Show date_histogram attributes object

    • delay string

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • field string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • format string
    • interval string

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • calendar_interval string

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • fixed_interval string

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • time_zone string
  • histogram object

    Additional properties are allowed.

    Hide histogram attributes Show histogram attributes object

    • fields string | array[string] Required
    • interval number Required

      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.

  • terms object

    Additional properties are allowed.

    Hide terms attribute Show terms attribute object

    • fields string | array[string] Required
• index_pattern string Required

  The index or index pattern to roll up. Supports wildcard-style patterns (logstash-*). The job attempts to rollup the entire index or index-pattern.

• metrics array[object]

  Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined on a per-field basis and for each field you configure which metric should be collected.

  Hide metrics attributes Show metrics attributes object

  • field string Required

    Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

  • metrics array[string] Required

    An array of metrics to collect for the field. At least one metric must be configured.

    Values are min, max, sum, avg, or value_count.

• page_size number Required

  The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends to execute faster, but requires more memory during processing. This value has no effect on how the data is rolled up; it is merely used for tweaking the speed or memory cost of the indexer.

• rollup_index string Required
• timeout string

  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

• headers object