mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 17:34:17 -04:00
108 lines
3 KiB
Markdown
108 lines
3 KiB
Markdown
---
|
||
navigation_title: "Sum bucket"
|
||
mapped_pages:
|
||
- https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html
|
||
---
|
||
|
||
# Sum bucket aggregation [search-aggregations-pipeline-sum-bucket-aggregation]
|
||
|
||
|
||
A sibling pipeline aggregation which calculates the sum across all buckets of a specified metric in a sibling aggregation. The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.
|
||
|
||
## Syntax [_syntax_24]
|
||
|
||
A `sum_bucket` aggregation looks like this in isolation:
|
||
|
||
```js
|
||
{
|
||
"sum_bucket": {
|
||
"buckets_path": "the_sum"
|
||
}
|
||
}
|
||
```
|
||
|
||
$$$sum-bucket-params$$$
|
||
|
||
| Parameter Name | Description | Required | Default Value |
|
||
| --- | --- | --- | --- |
|
||
| `buckets_path` | The path to the buckets we wish to find the sum for (see [`buckets_path` Syntax](/reference/data-analysis/aggregations/pipeline.md#buckets-path-syntax) for more details) | Required | |
|
||
| `gap_policy` | The policy to apply when gaps are found in the data (see [Dealing with gaps in the data](/reference/data-analysis/aggregations/pipeline.md#gap-policy) for more details) | Optional | `skip` |
|
||
| `format` | [DecimalFormat pattern](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/DecimalFormat.html) for theoutput value. If specified, the formatted value is returned in the aggregation’s`value_as_string` property. | Optional | `null` |
|
||
|
||
The following snippet calculates the sum of all the total monthly `sales` buckets:
|
||
|
||
```console
|
||
POST /sales/_search
|
||
{
|
||
"size": 0,
|
||
"aggs": {
|
||
"sales_per_month": {
|
||
"date_histogram": {
|
||
"field": "date",
|
||
"calendar_interval": "month"
|
||
},
|
||
"aggs": {
|
||
"sales": {
|
||
"sum": {
|
||
"field": "price"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"sum_monthly_sales": {
|
||
"sum_bucket": {
|
||
"buckets_path": "sales_per_month>sales" <1>
|
||
}
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
1. `buckets_path` instructs this sum_bucket aggregation that we want the sum of the `sales` aggregation in the `sales_per_month` date histogram.
|
||
|
||
|
||
And the following may be the response:
|
||
|
||
```console-result
|
||
{
|
||
"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
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"sum_monthly_sales": {
|
||
"value": 985.0
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
|