Average bucket aggregation

Average bucket aggregation

A sibling pipeline aggregation which calculates the mean value 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

  1. "avg_bucket": {
  2.   "buckets_path": "sales_per_month>sales",
  3.   "gap_policy": "skip",
  4.   "format": "#,##0.00;(#,##0.00)"
  5. }

Parameters

buckets_path

(Required, string) Path to the buckets to average. For syntax, see buckets_path Syntax.

gap_policy

(Optional, string) Policy to apply when gaps are found in the data. For valid values, see Dealing with gaps in the data. Defaults to skip.

format

(Optional, string) DecimalFormat pattern for the output value. If specified, the formatted value is returned in the aggregation’s value_as_string property.

Response body

value

(float) Mean average value for the metric specified in buckets_path.

value_as_string

(string) Formatted output value for the aggregation. This property is only provided if a format is specified in the request.

Example

The following avg_monthly_sales aggregation uses avg_bucket to calculate average sales per month:

  1. resp = client.search(
  2.     size=0,
  3.     aggs={
  4.         "sales_per_month": {
  5.             "date_histogram": {
  6.                 "field": "date",
  7.                 "calendar_interval": "month"
  8.             },
  9.             "aggs": {
  10.                 "sales": {
  11.                     "sum": {
  12.                         "field": "price"
  13.                     }
  14.                 }
  15.             }
  16.         },
  17.         "avg_monthly_sales": {
  18.             "avg_bucket": {
  19.                 "buckets_path": "sales_per_month>sales",
  20.                 "gap_policy": "skip",
  21.                 "format": "#,##0.00;(#,##0.00)"
  22.             }
  23.         }
  24.     },
  25. )
  26. print(resp)
  1. const response = await client.search({
  2.   size: 0,
  3.   aggs: {
  4.     sales_per_month: {
  5.       date_histogram: {
  6.         field: "date",
  7.         calendar_interval: "month",
  8.       },
  9.       aggs: {
  10.         sales: {
  11.           sum: {
  12.             field: "price",
  13.           },
  14.         },
  15.       },
  16.     },
  17.     avg_monthly_sales: {
  18.       avg_bucket: {
  19.         buckets_path: "sales_per_month>sales",
  20.         gap_policy: "skip",
  21.         format: "#,##0.00;(#,##0.00)",
  22.       },
  23.     },
  24.   },
  25. });
  26. console.log(response);
  1. POST _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.     "avg_monthly_sales": {
  19. // tag::avg-bucket-agg-syntax[]               
  20.       "avg_bucket": {
  21.         "buckets_path": "sales_per_month>sales",
  22.         "gap_policy": "skip",
  23.         "format": "#,##0.00;(#,##0.00)"
  24.       }
  25. // end::avg-bucket-agg-syntax[]               
  26.     }
  27.   }
  28. }

Start of the avg_bucket configuration. Comment is not part of the example.

End of the avg_bucket configuration. Comment is not part of the example.

The request returns the following 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.     "avg_monthly_sales": {
  36.       "value": 328.33333333333333,
  37.       "value_as_string": "328.33"
  38.     }
  39.   }
  40. }