Bucket Selector Aggregationedit

This functionality is experimental and may be changed or removed completely in a future release.
A parent pipeline aggregation which executes a script which determines whether the current bucket will be retained
in the parent multi-bucket aggregation. The specified metric must be numeric and the script must return a boolean value.
If the script language is expression
then a numeric return value is permitted. In this case 0.0 will be evaluated as false
and all other values will evaluate to true.
Note: The bucket_selector aggregation, like all pipeline aggregations, executions after all other sibling aggregations. This means that using the bucket_selector aggregation to filter the returned buckets in the response does not save on execution time running the aggregations.
Syntaxedit
A bucket_selector
aggregation looks like this in isolation:
{ "bucket_selector": { "buckets_path": { "my_var1": "the_sum","my_var2": "the_value_count" }, "script": "my_var1 > my_var2" } }
Here, |
Table 12. bucket_selector
Parameters
Parameter Name | Description | Required | Default Value |
| The script to run for this aggregation. The script can be inline, file or indexed. (see Scripting for more details) | Required | |
| A map of script variables and their associated path to the buckets we wish to use for the variable
(see the section called “ | Required | |
| The policy to apply when gaps are found in the data (see the section called “Dealing with gaps in the dataedit” for more details) | Optional, defaults to |
The following snippet only retains buckets where the total sales for the month is less than or equal to 50:
{ "aggs" : { "sales_per_month" : { "date_histogram" : { "field" : "date", "interval" : "month" }, "aggs": { "total_sales": { "sum": { "field": "price" } } "sales_bucket_filter": { "bucket_selector": { "buckets_path": { "totalSales": "total_sales" }, "script": "totalSales <= 50" } } } } } }
And the following may be the response: