Sum bucket aggregation

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

A sum_bucket aggregation looks like this in isolation:

  1. {
  2.   "sum_bucket": {
  3.     "buckets_path": "the_sum"
  4.   }
  5. }

Table 75. sum_bucket Parameters

Parameter NameDescriptionRequiredDefault Value

buckets_path

The path to the buckets we wish to find the sum for (see 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 for more details)

Optional

skip

format

format to apply to the output value of this aggregation

Optional

null

The following snippet calculates the sum of all the total monthly sales buckets:

  1. POST /sales/_search
  2. {
  3.   "size": 0,
  4.   "aggs": {
  5.     "sales_per_month": {
  6.       "date_histogram": {
  7.         "field": "date",
  8.         "calendar_interval": "month"
  9.       },
  10.       "aggs": {
  11.         "sales": {
  12.           "sum": {
  13.             "field": "price"
  14.           }
  15.         }
  16.       }
  17.     },
  18.     "sum_monthly_sales": {
  19.       "sum_bucket": {
  20.         "buckets_path": "sales_per_month>sales" 
  21.       }
  22.     }
  23.   }
  24. }

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:

  1. {
  2.    "took": 11,
  3.    "timed_out": false,
  4.    "_shards": ...,
  5.    "hits": ...,
  6.    "aggregations": {
  7.       "sales_per_month": {
  8.          "buckets": [
  9.             {
  10.                "key_as_string": "2015/01/01 00:00:00",
  11.                "key": 1420070400000,
  12.                "doc_count": 3,
  13.                "sales": {
  14.                   "value": 550.0
  15.                }
  16.             },
  17.             {
  18.                "key_as_string": "2015/02/01 00:00:00",
  19.                "key": 1422748800000,
  20.                "doc_count": 2,
  21.                "sales": {
  22.                   "value": 60.0
  23.                }
  24.             },
  25.             {
  26.                "key_as_string": "2015/03/01 00:00:00",
  27.                "key": 1425168000000,
  28.                "doc_count": 2,
  29.                "sales": {
  30.                   "value": 375.0
  31.                }
  32.             }
  33.          ]
  34.       },
  35.       "sum_monthly_sales": {
  36.           "value": 985.0
  37.       }
  38.    }
  39. }