2015-05-21 05:39:38 -04:00
|
|
|
[[search-aggregations-pipeline-min-bucket-aggregation]]
|
2015-04-30 09:41:01 -04:00
|
|
|
=== Min Bucket Aggregation
|
2015-04-30 06:24:36 -04:00
|
|
|
|
2016-08-12 18:42:19 -04:00
|
|
|
A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation
|
|
|
|
and outputs both the value and the key(s) of the bucket(s). The specified metric must be numeric and the sibling aggregation must
|
2015-04-30 06:24:36 -04:00
|
|
|
be a multi-bucket aggregation.
|
|
|
|
|
2015-05-01 16:04:55 -04:00
|
|
|
==== Syntax
|
|
|
|
|
2017-04-05 06:39:37 -04:00
|
|
|
A `min_bucket` aggregation looks like this in isolation:
|
2015-05-01 16:04:55 -04:00
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------------------------------
|
|
|
|
{
|
2020-07-20 15:59:00 -04:00
|
|
|
"min_bucket": {
|
|
|
|
"buckets_path": "the_sum"
|
|
|
|
}
|
2015-05-01 16:04:55 -04:00
|
|
|
}
|
|
|
|
--------------------------------------------------
|
2017-05-01 13:30:51 -04:00
|
|
|
// NOTCONSOLE
|
2015-05-01 16:04:55 -04:00
|
|
|
|
2019-04-30 10:19:09 -04:00
|
|
|
[[min-bucket-params]]
|
2015-05-01 16:04:55 -04:00
|
|
|
.`min_bucket` Parameters
|
2019-04-30 10:19:09 -04:00
|
|
|
[options="header"]
|
2015-05-01 16:04:55 -04:00
|
|
|
|===
|
|
|
|
|Parameter Name |Description |Required |Default Value
|
2015-08-31 07:47:40 -04:00
|
|
|
|`buckets_path` |The path to the buckets we wish to find the minimum for (see <<buckets-path-syntax>> for more
|
2015-05-06 07:54:42 -04:00
|
|
|
details) |Required |
|
|
|
|
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
|
2017-03-01 08:46:49 -05:00
|
|
|
details)|Optional | `skip`
|
2017-04-05 06:39:37 -04:00
|
|
|
|`format` |format to apply to the output value of this aggregation |Optional |`null`
|
2015-05-01 16:04:55 -04:00
|
|
|
|===
|
|
|
|
|
2015-04-30 06:24:36 -04:00
|
|
|
The following snippet calculates the minimum of the total monthly `sales`:
|
|
|
|
|
2019-09-05 10:11:25 -04:00
|
|
|
[source,console]
|
2015-04-30 06:24:36 -04:00
|
|
|
--------------------------------------------------
|
2016-08-12 18:42:19 -04:00
|
|
|
POST /sales/_search
|
2015-04-30 06:24:36 -04:00
|
|
|
{
|
2020-07-20 15:59:00 -04:00
|
|
|
"size": 0,
|
|
|
|
"aggs": {
|
|
|
|
"sales_per_month": {
|
|
|
|
"date_histogram": {
|
|
|
|
"field": "date",
|
|
|
|
"calendar_interval": "month"
|
|
|
|
},
|
|
|
|
"aggs": {
|
|
|
|
"sales": {
|
|
|
|
"sum": {
|
|
|
|
"field": "price"
|
|
|
|
}
|
2015-04-30 06:24:36 -04:00
|
|
|
}
|
2020-07-20 15:59:00 -04:00
|
|
|
}
|
|
|
|
},
|
|
|
|
"min_monthly_sales": {
|
|
|
|
"min_bucket": {
|
|
|
|
"buckets_path": "sales_per_month>sales" <1>
|
|
|
|
}
|
2015-04-30 06:24:36 -04:00
|
|
|
}
|
2020-07-20 15:59:00 -04:00
|
|
|
}
|
2015-04-30 06:24:36 -04:00
|
|
|
}
|
|
|
|
--------------------------------------------------
|
2016-08-12 18:42:19 -04:00
|
|
|
// TEST[setup:sales]
|
2015-04-30 06:24:36 -04:00
|
|
|
|
2017-04-05 06:39:37 -04:00
|
|
|
<1> `buckets_path` instructs this min_bucket aggregation that we want the minimum value of the `sales` aggregation in the
|
2015-04-30 06:24:36 -04:00
|
|
|
`sales_per_month` date histogram.
|
|
|
|
|
|
|
|
And the following may be the response:
|
|
|
|
|
2019-09-06 16:09:09 -04:00
|
|
|
[source,console-result]
|
2015-04-30 06:24:36 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
{
|
2016-08-12 18:42:19 -04:00
|
|
|
"took": 11,
|
|
|
|
"timed_out": false,
|
|
|
|
"_shards": ...,
|
|
|
|
"hits": ...,
|
2015-04-30 06:24:36 -04:00
|
|
|
"aggregations": {
|
|
|
|
"sales_per_month": {
|
|
|
|
"buckets": [
|
|
|
|
{
|
|
|
|
"key_as_string": "2015/01/01 00:00:00",
|
|
|
|
"key": 1420070400000,
|
|
|
|
"doc_count": 3,
|
|
|
|
"sales": {
|
2016-08-12 18:42:19 -04:00
|
|
|
"value": 550.0
|
2015-04-30 06:24:36 -04:00
|
|
|
}
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"key_as_string": "2015/02/01 00:00:00",
|
|
|
|
"key": 1422748800000,
|
|
|
|
"doc_count": 2,
|
|
|
|
"sales": {
|
2016-08-12 18:42:19 -04:00
|
|
|
"value": 60.0
|
2015-04-30 06:24:36 -04:00
|
|
|
}
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"key_as_string": "2015/03/01 00:00:00",
|
|
|
|
"key": 1425168000000,
|
|
|
|
"doc_count": 2,
|
|
|
|
"sales": {
|
2016-08-12 18:42:19 -04:00
|
|
|
"value": 375.0
|
2015-04-30 06:24:36 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
]
|
|
|
|
},
|
|
|
|
"min_monthly_sales": {
|
|
|
|
"keys": ["2015/02/01 00:00:00"], <1>
|
2016-08-12 18:42:19 -04:00
|
|
|
"value": 60.0
|
2015-04-30 06:24:36 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------------------------------
|
2016-08-12 18:42:19 -04:00
|
|
|
// TESTRESPONSE[s/"took": 11/"took": $body.took/]
|
|
|
|
// TESTRESPONSE[s/"_shards": \.\.\./"_shards": $body._shards/]
|
|
|
|
// TESTRESPONSE[s/"hits": \.\.\./"hits": $body.hits/]
|
2015-04-30 06:24:36 -04:00
|
|
|
|
|
|
|
<1> `keys` is an array of strings since the minimum value may be present in multiple buckets
|