Search rolled-up data | Elasticsearch API documentation

Path parameters

indexstring | array[string] Required
A comma-separated list of data streams and indices used to limit the request. This parameter has the following rules:
- At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using _all are not permitted.
- Multiple non-rollup indices may be specified.
- Only one rollup index may be specified. If more than one are supplied, an exception occurs.
- Wildcard expressions (*) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.

Query parameters

rest_total_hits_as_intboolean
Indicates whether hits.total should be rendered as an integer or an object in the rest search response
typed_keysboolean
Specify whether aggregation and suggester names should be prefixed by their respective types in the response

application/json

BodyRequired

aggregationsobject
Specifies aggregations.
External documentation
queryobject
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
External documentation
sizenumber
Must be zero if set, as rollups work on pre-aggregated data.

Responses

200 application/json
Hide response attributes Show response attributes object
- tooknumber Required
- timed_outboolean Required
- terminated_earlyboolean
- _shardsobject Required
  Hide _shards attributes Show _shards attributes object
  failednumber Required
  successfulnumber Required
  totalnumber Required
  failuresarray[object]
  Hide failures attributes Show failures attributes object
  indexstring
  nodestring
  reasonobject Required
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Hide reason attributes Show reason attributes object
  typestring Required
  The type of error
  reasonstring | null
  A human-readable explanation of the error, in English.
  One of:
  string-1string string-2string | null
  stack_tracestring
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  caused_byobject
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  root_causearray[object]
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  suppressedarray[object]
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  shardnumber Required
  statusstring
  skippednumber
- hitsobject Required
  Hide hits attributes Show hits attributes object
  totalobject | number
  Total hit count information, present only if track_total_hits wasn't false in the search request.
  One of:
  TotalHitsobject number-2number
  hitsarray[object] Required
  Hide hits attributes Show hits attributes object
  _indexstring Required
  _idstring
  _scorenumber | string | null
  One of:
  number-1number string-2string | null
  _explanationobject
  Hide _explanation attributes Show _explanation attributes object
  descriptionstring Required
  detailsarray[object] Required
  valuenumber Required
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  highlightobject
  Hide highlight attribute Show highlight attribute object
  *array[string] Additional properties
  inner_hitsobject
  Hide inner_hits attribute Show inner_hits attribute object
  *object Additional properties
  Hide * attribute Show * attribute object
  hitsobject Required
  matched_queriesarray[string] | object
  One of:
  array-1array[string]object-2object
  _nestedobject
  Hide _nested attributes Show _nested attributes object
  fieldstring Required
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  offsetnumber Required
  _nestedobject
  _ignoredarray[string]
  ignored_field_valuesobject
  Hide ignored_field_values attribute Show ignored_field_values attribute object
  *array[object] Additional properties
  _shardstring
  _nodestring
  _routingstring
  _sourceobject
  _ranknumber
  _seq_nonumber
  _primary_termnumber
  _versionnumber
  sortarray[number | string | boolean | null]
  A field value.
  max_scorenumber | string | null
  One of:
  number-1number string-2string | null
- aggregationsobject

GET /{index}/_rollup_search

GET /sensor_rollup/_rollup_search
{
  "size": 0,
  "aggregations": {
    "max_temperature": {
      "max": {
        "field": "temperature"
      }
    }
  }
}

resp = client.rollup.rollup_search(
    index="sensor_rollup",
    size=0,
    aggregations={
        "max_temperature": {
            "max": {
                "field": "temperature"
            }
        }
    },
)

const response = await client.rollup.rollupSearch({
  index: "sensor_rollup",
  size: 0,
  aggregations: {
    max_temperature: {
      max: {
        field: "temperature",
      },
    },
  },
});

response = client.rollup.rollup_search(
  index: "sensor_rollup",
  body: {
    "size": 0,
    "aggregations": {
      "max_temperature": {
        "max": {
          "field": "temperature"
        }
      }
    }
  }
)

$resp = $client->rollup()->rollupSearch([
    "index" => "sensor_rollup",
    "body" => [
        "size" => 0,
        "aggregations" => [
            "max_temperature" => [
                "max" => [
                    "field" => "temperature",
                ],
            ],
        ],
    ],
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"size":0,"aggregations":{"max_temperature":{"max":{"field":"temperature"}}}}' "$ELASTICSEARCH_URL/sensor_rollup/_rollup_search"

Request example

Search rolled up data stored in `sensor_rollup` with `GET /sensor_rollup/_rollup_search`

{
  "size": 0,
  "aggregations": {
    "max_temperature": {
      "max": {
        "field": "temperature"
      }
    }
  }
}

Response examples (200)

An abbreviated response from `GET /sensor_rollup/_rollup_search` with a `max` aggregation on a `temperature` field. The response provides some metadata about the request (`took`, `_shards`), the search hits (which is always empty for rollup searches), and the aggregation response.

{
  "took" : 102,
  "timed_out" : false,
  "terminated_early" : false,
  "_shards" : {} ,
  "hits" : {
    "total" : {
        "value": 0,
        "relation": "eq"
    },
    "max_score" : 0.0,
    "hits" : [ ]
  },
  "aggregations" : {
    "max_temperature" : {
      "value" : 202.0
    }
  }
}