Search rolled-up data Technical preview
The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.
Path parameters
-
Enables searching rolled-up data using the standard Query DSL.
Query parameters
-
rest_total_hits_as_int boolean
Indicates whether hits.total should be rendered as an integer or an object in the rest search response
-
typed_keys boolean
Specify whether aggregation and suggester names should be prefixed by their respective types in the response
Body Required
-
aggregations object
Specifies aggregations.
-
query object
Additional properties are allowed.
-
size number
Must be zero if set, as rollups work on pre-aggregated data.
GET
/{index}/_rollup_search
curl \
-X GET http://api.example.com/{index}/_rollup_search \
-H "Content-Type: application/json" \
-d '{"aggregations":{},"query":{},"size":42.0}'
Request examples
{
"aggregations": {},
"query": {},
"size": 42.0
}
Response examples (200)
{
"took": 42.0,
"timed_out": true,
"terminated_early": true,
"_shards": {
"failed": 42.0,
"successful": 42.0,
"total": 42.0,
"failures": [
{
"index": "string",
"node": "string",
"reason": {
"type": "string",
"reason": "string",
"stack_trace": "string",
"caused_by": {},
"root_cause": [
{}
],
"suppressed": [
{}
]
},
"shard": 42.0,
"status": "string"
}
],
"skipped": 42.0
},
"hits": {
"total": {
"relation": "eq",
"value": 42.0
},
"hits": [
{
"_index": "string",
"_id": "string",
"_score": 42.0,
"_explanation": {
"description": "string",
"details": [
{}
],
"value": 42.0
},
"fields": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"highlight": {
"additionalProperty1": [
"string"
],
"additionalProperty2": [
"string"
]
},
"inner_hits": {
"additionalProperty1": {
"hits": {}
},
"additionalProperty2": {
"hits": {}
}
},
"matched_queries": [
"string"
],
"_nested": {
"field": "string",
"offset": 42.0,
"_nested": {}
},
"_ignored": [
"string"
],
"ignored_field_values": {
"additionalProperty1": [
{}
],
"additionalProperty2": [
{}
]
},
"_shard": "string",
"_node": "string",
"_routing": "string",
"_source": {},
"_rank": 42.0,
"_seq_no": 42.0,
"_primary_term": 42.0,
"_version": 42.0,
"sort": [
42.0
]
}
],
"max_score": 42.0
},
"aggregations": {}
}