OpenSearch/docs/reference/aggregations/pipeline/min-bucket-aggregation.asci...

118 lines
3.3 KiB
Plaintext
Raw Normal View History

[[search-aggregations-pipeline-min-bucket-aggregation]]
=== Min Bucket Aggregation
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
be a multi-bucket aggregation.
2015-05-01 16:04:55 -04:00
==== Syntax
A `min_bucket` aggregation looks like this in isolation:
2015-05-01 16:04:55 -04:00
[source,js]
--------------------------------------------------
{
"min_bucket": {
"buckets_path": "the_sum"
}
}
--------------------------------------------------
// NOTCONSOLE
2015-05-01 16:04:55 -04:00
[[min-bucket-params]]
2015-05-01 16:04:55 -04:00
.`min_bucket` Parameters
[options="header"]
2015-05-01 16:04:55 -04:00
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |The path to the buckets we wish to find the minimum for (see <<buckets-path-syntax>> for more
details) |Required |
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
details)|Optional | `skip`
|`format` |format to apply to the output value of this aggregation |Optional |`null`
2015-05-01 16:04:55 -04:00
|===
The following snippet calculates the minimum of the total monthly `sales`:
[source,console]
--------------------------------------------------
POST /sales/_search
{
"size": 0,
"aggs" : {
"sales_per_month" : {
"date_histogram" : {
"field" : "date",
"calendar_interval" : "month"
},
"aggs": {
"sales": {
"sum": {
"field": "price"
}
}
}
},
"min_monthly_sales": {
"min_bucket": {
"buckets_path": "sales_per_month>sales" <1>
}
}
}
}
--------------------------------------------------
// TEST[setup:sales]
<1> `buckets_path` instructs this min_bucket aggregation that we want the minimum value of the `sales` aggregation in the
`sales_per_month` date histogram.
And the following may be the response:
[source,js]
--------------------------------------------------
{
"took": 11,
"timed_out": false,
"_shards": ...,
"hits": ...,
"aggregations": {
"sales_per_month": {
"buckets": [
{
"key_as_string": "2015/01/01 00:00:00",
"key": 1420070400000,
"doc_count": 3,
"sales": {
"value": 550.0
}
},
{
"key_as_string": "2015/02/01 00:00:00",
"key": 1422748800000,
"doc_count": 2,
"sales": {
"value": 60.0
}
},
{
"key_as_string": "2015/03/01 00:00:00",
"key": 1425168000000,
"doc_count": 2,
"sales": {
"value": 375.0
}
}
]
},
"min_monthly_sales": {
"keys": ["2015/02/01 00:00:00"], <1>
"value": 60.0
}
}
}
--------------------------------------------------
// TESTRESPONSE[s/"took": 11/"took": $body.took/]
// TESTRESPONSE[s/"_shards": \.\.\./"_shards": $body._shards/]
// TESTRESPONSE[s/"hits": \.\.\./"hits": $body.hits/]
<1> `keys` is an array of strings since the minimum value may be present in multiple buckets