WARNING: Version 2.2 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Extended Stats Aggregation Geo Centroid Aggregation »
Elastic Docs ›Elasticsearch Guide [2.2] ›Aggregations ›Metrics Aggregations

Geo Bounds Aggregation

edit

Geo Bounds Aggregation

edit

A metric aggregation that computes the bounding box containing all geo_point values for a field.

Example:

{
    "query" : {
        "match" : { "business_type" : "shop" }
    },
    "aggs" : {
        "viewport" : {
            "geo_bounds" : {
                "field" : "location", 
                "wrap_longitude" : true 
            }
        }
    }
}

The geo_bounds aggregation specifies the field to use to obtain the bounds

wrap_longitude is an optional parameter which specifies whether the bounding box should be allowed to overlap the international date line. The default value is true

The above aggregation demonstrates how one would compute the bounding box of the location field for all documents with a business type of shop

The response for the above aggregation:

{
    ...

    "aggregations": {
        "viewport": {
            "bounds": {
                "top_left": {
                    "lat": 80.45,
                    "lon": -160.22
                },
                "bottom_right": {
                    "lat": 40.65,
                    "lon": 42.57
                }
            }
        }
    }
}
« Extended Stats Aggregation Geo Centroid Aggregation »