Downsample an index

POST /{index}/_downsample/{target_index}

Downsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:

When running in aggregate mode, it pre-calculates and stores statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval and their dimensions.
When running in last_value mode, it keeps the last value for each metric in the configured interval and their dimensions.

For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. All documents within an hour interval are summarized and stored as a single document in the downsample index.

Note

Only indices in a time series data stream are supported. Neither field nor document level security can be defined on the source index. The source index must be read-only (index.blocks.write: true).

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /my-time-series-index/_downsample/my-downsampled-time-series-index
{
  "fixed_interval": "1d"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.downsample({
  index: "my-time-series-index",
  target_index: "my-downsampled-time-series-index",
  config: {
    fixed_interval: "1d",
  },
});

Python Elasticsearch Python Client

resp = client.indices.downsample(
    index="my-time-series-index",
    target_index="my-downsampled-time-series-index",
    config={
        "fixed_interval": "1d"
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-time-series-index/_downsample/my-downsampled-time-series-index" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fixed_interval": "1d"
  }'

Java Elasticsearch Java Client

client.indices().downsample(d -> d
    .index("my-time-series-index")
    .targetIndex("my-downsampled-time-series-index")
    .config(c -> c
        .fixedInterval(f -> f
            .time("1d")
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .DownsampleAsync(index: "my-time-series-index", targetIndex: "my-downsampled-time-series-index", d1 => d1
        .Config(d2 => d2
            .FixedInterval("1d")
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->downsample([
    "index" => "my-time-series-index",
    "target_index" => "my-downsampled-time-series-index",
    "body" => [
        "fixed_interval" => "1d",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.indices.downsample(
  index: "my-time-series-index",
  target_index: "my-downsampled-time-series-index",
  body: {
    "fixed_interval": "1d"
  }
)

Response

No example

Downsample an index

Authentication

Path parameters

Request body

Response

Authentication

Path parameters

Request body { }

Response

Request body