GroupByGeoDistance groups query results based on geographical locations. You can group query results based on a circular geographical area that consists of a central point and radius. Field values that are within the same range are grouped together. The value range of each group and the number of values in each group are returned.
Request parameters
message GroupByGeoDistance {
optional string field_name = 1;
optional GeoPoint origin = 2;
repeated Range ranges = 3;
optional Aggregations sub_aggs = 4;
optional GroupBys sub_group_bys = 5;
}Parameter | Type | Required | Description |
field_name | string | Yes | The field that is used for aggregation. |
origin | Yes | The longitude and latitude of the central point. | |
ranges | repeated Range | Yes | The range configurations for grouping. The range is a left-closed and right-open interval. Unit: meter. |
sub_aggs | No | The sub-aggregation operation. You can perform the sub-aggregation operation on the grouping results. | |
sub_group_bys | No | The sub-GroupBy operation. You can perform the sub-GroupBy operation on the grouping results. |
Response parameters
message GroupByGeoDistanceResult {
repeated GroupByGeoDistanceResultItem group_by_geo_distance_result_items = 1;
}Parameter | Type | Required | Description |
group_by_geo_distance_result_items | repeated GroupByGeoDistanceResultItem | Yes | The information about groups returned. |