Index rollups API

Introduced 1.0

Creates or updates an index rollup job. You must provide the and primary_term parameters.

Request

You can specify the following options.

Example response

  1. {
  2.   "_id": "<rollup_id>",
  3.   "_version": 3,
  4.   "_seq_no": 1,
  6.   "rollup": {
  7.     "rollup_id": "<rollup_id>",
  8.     "enabled": true,
  9.     "schedule": {
  10.       "interval": {
  11.         "start_time": 1680159934649,
  12.         "period": 1,
  13.         "unit": "Days",
  14.       }
  15.     },
  16.     "last_updated_time": 1680159934649,
  17.     "enabled_time": 1680159934649,
  18.     "description": "Example rollup job",
  19.     "schema_version": 17,
  20.     "source_index": "nyc-taxi-data",
  21.     "target_index": "rollup-nyc-taxi-data",
  22.     "metadata_id": null,
  23.     "page_size": 200,
  24.     "delay": 0,
  25.     "continuous": false,
  26.     "dimensions": [
  27.       {
  28.         "date_histogram": {
  29.           "fixed_interval": "1h",
  30.           "source_field": "tpep_pickup_datetime",
  31.           "target_field": "tpep_pickup_datetime",
  32.           "timezone": "America/Los_Angeles"
  33.         }
  34.       },
  35.       {
  36.         "terms": {
  37.           "source_field": "PULocationID",
  39.         }
  40.       }
  41.     ],
  42.       {
  43.         "source_field": "passenger_count",
  44.         "metrics": [
  45.           {
  46.             "avg": {}
  47.           },
  48.           {
  49.             "sum": {}
  50.           },
  51.           {
  52.             "max": {}
  53.           },
  54.           {
  55.             "min": {}
  56.           },
  57.           {
  58.             "value_count": {}
  59.           }
  60.         ]
  61.       }
  62.     ]
  63.   }
  64. }

Returns all information about an index rollup job based on the rollup_id.

Request

  1. GET _plugins/_rollup/jobs/<rollup_id>

Example response

Introduced 1.0

Deletes an index rollup job based on the rollup_id.

Request

  1. DELETE _plugins/_rollup/jobs/<rollup_id>

Example response

  1. 200 OK

Start or stop an index rollup job.

Request

Example response

  1. 200 OK

Introduced 1.0

Returns detailed metadata information about the index rollup job and its current progress.

Request

Example response