{"_id":"56e30dd0d46bc30e007bb986","category":{"_id":"56e1ccc4e416450e00b9e48c","project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","pages":["56e1cdd892bf640e00b5564b","56e1cdfde416450e00b9e490","56e1ce4892bf640e00b5564e","56e1ce81e416450e00b9e494","56e1ceebe416450e00b9e497","56e1cf39cd6a8d0e00d12176","56e30b4b51857d0e008e77a3","56e30bd26e602e0e00700b16","56e30dd0d46bc30e007bb986","56e30e3d872bb20e0051ba39","56e30f91cb6ef20e0084f23c"],"__v":11,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-10T19:36:36.026Z","from_sync":false,"order":16,"slug":"aggregations-facets-vector-services-guide","title":"Aggregations & Facets Vector Services Guide"},"editedParams2":true,"parentDoc":null,"user":"562654b6f3adc80d0048611b","__v":1,"project":"55faeacad0e22017005b8265","editedParams":true,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":34,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-11T18:26:24.841Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n    \"responseDate\": \"2015-11-11T17:55:56Z\",\n    \"geom\": {\n        \"coordinates\": [\n            [\n                [\n                    -77.794631,\n                    38.371776\n                ],\n                [\n                    -77.794631,\n                    39.37037\n                ],\n                [\n                    -76.42958,\n                    39.37037\n                ],\n                [\n                    -76.42958,\n                    38.371776\n                ],\n                [\n                    -77.794631,\n                    38.371776\n                ]\n            ]\n        ],\n        \"type\": \"Polygon\"\n    },\n    \"query\": \"item_type:tweet\",\n    \"startDate\": \"2015-09-03T12:07:16.179Z\",\n    \"endDate\": \"2015-09-07T20:07:16.208Z\",\n    \"totalItems\": 116733,\n    \"aggregations\": [\n        {\n            \"name\": \"geohash:4\",\n            \"terms\": [\n                {\n                    \"term\": \"dqcj\",\n                    \"count\": 33368,\n                    \"aggregations\": [\n                        {\n                            \"name\": \"date_hist:d\",\n                            \"terms\": [\n                                {\n                                    \"term\": \"2015-09-03T00:00:00.000Z\",\n                                    \"count\": 3067,\n                                    \"aggregations\": [\n                                        {\n                                            \"name\": \"terms:ingest_source\",\n                                            \"terms\": [\n                                                {\n                                                    \"term\": \"Gnip - Twitter\",\n                                                    \"count\": 3067,\n                                                    \"aggregations\": null\n                                                }\n                                            ]\n                                        }\n                                    ]\n                                },\n                                ...\n                            ]\n                        }\n                    ]\n                },\n                ...\n            ]\n        }\n    ]\n}","language":"json","status":200,"name":""}]},"settings":"56e2c496d64add20007dceba","examples":{"codes":[{"code":"Request:\n  GET /insight-vector/api/agregation?aggs=:aggs&query=:query&left=:left&right=:right&upper=:upper&lower=:lower&startDate=:startDate&endDate=:endDate&count=:count\n\nHeaders:\n  Authorization: Bearer {token}\n\n\nResponse (success):\n  200 OK","language":"text"},{"code":"https://vector.geobigdata.io/insight-vector/api/aggregation?aggs=geohash:4;date_hist:d;terms:ingest_source&query=item_type:tweet&left=-77.794631&right=-76.429580&upper=39.370370&lower=38.371776&startDate=2015-09-03T12:07:16.179Z&endDate=2015-09-07T20:07:16.208Z&count=5","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"56e30dd0d46bc30e007bb98f","ref":"","in":"query","required":true,"desc":"The aggregation definitions.","default":"geohash:4;date_hist:d;terms:ingest_source","type":"string","name":"aggs"},{"_id":"56e30dd0d46bc30e007bb98e","ref":"","in":"query","required":false,"desc":"The Elasticsearch query string to constrain the document set.","default":"item_type:tweet","type":"string","name":"query"},{"_id":"56e30dd0d46bc30e007bb98d","ref":"","in":"query","required":true,"desc":"The west most X-coordinate for the bounding box.","default":"-77.794631","type":"string","name":"left"},{"_id":"56e30dd0d46bc30e007bb98c","ref":"","in":"query","required":true,"desc":"The east most X-coordinate for the bounding box.","default":"-76.429580","type":"string","name":"right"},{"_id":"56e30dd0d46bc30e007bb98b","ref":"","in":"query","required":true,"desc":"The north most Y-coordinate for the bounding box.","default":"39.370370","type":"string","name":"upper"},{"_id":"56e30dd0d46bc30e007bb98a","ref":"","in":"query","required":true,"desc":"The south most Y-coordinate for the bounding box.","default":"38.371776","type":"string","name":"lower"},{"_id":"56e30dd0d46bc30e007bb989","ref":"","in":"query","required":false,"desc":"ISO-8601-formatted or \"now\" expression formatted date string for the start of a date range; startDate runs a query against the field item_date. Note: For more information on the syntax, check the [Query Syntax](vector-query-syntax-query-fields-and-type-suffixes) page. If no date range is provided, then all items within the AOI will be included.","default":"2015-09-03T12:07:16.179Z","type":"string","name":"startDate"},{"_id":"56e30dd0d46bc30e007bb988","ref":"","in":"query","required":false,"desc":"ISO-8601-formatted or \"now\" expression formatted date string for the end of a date range; endDate runs a query against the field item_date. Note: For more information on the syntax, check the [Query Syntax](vector-query-syntax-query-fields-and-type-suffixes) page. If no date range is provided, then all items within the AOI will be included. The date range is inclusive at both ends.","default":"2015-09-03T12:52:33.208Z","type":"string","name":"endDate"},{"_id":"56e30dd0d46bc30e007bb987","ref":"","in":"query","required":false,"desc":"The number of buckets to return per aggregation","default":"10","type":"int","name":"count"}],"url":"/insight-vector/api/aggregation?"},"isReference":false,"order":6,"body":"For more information on aggregations parameters and definitions, check the [Aggregations Overview](doc:vector-services-aggregations-reference-overview).\n\nFor examples of how to form an aggregation query, check the [Aggregation Example Query Constructions](doc:vector-services-example-query-constructions#section-aggregations-with-bounding-box).","excerpt":"Groups vector items for a given aggregation definition and bounding box.","slug":"aggs-query","type":"endpoint","title":"Aggregation (bounding box)"}

getAggregation (bounding box)

Groups vector items for a given aggregation definition and bounding box.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

aggs:
required
stringgeohash:4;date_hist:d;terms:ingest_source
The aggregation definitions.
query:
stringitem_type:tweet
The Elasticsearch query string to constrain the document set.
left:
required
string-77.794631
The west most X-coordinate for the bounding box.
right:
required
string-76.429580
The east most X-coordinate for the bounding box.
upper:
required
string39.370370
The north most Y-coordinate for the bounding box.
lower:
required
string38.371776
The south most Y-coordinate for the bounding box.
startDate:
string2015-09-03T12:07:16.179Z
ISO-8601-formatted or "now" expression formatted date string for the start of a date range; startDate runs a query against the field item_date. Note: For more information on the syntax, check the [Query Syntax](vector-query-syntax-query-fields-and-type-suffixes) page. If no date range is provided, then all items within the AOI will be included.
endDate:
string2015-09-03T12:52:33.208Z
ISO-8601-formatted or "now" expression formatted date string for the end of a date range; endDate runs a query against the field item_date. Note: For more information on the syntax, check the [Query Syntax](vector-query-syntax-query-fields-and-type-suffixes) page. If no date range is provided, then all items within the AOI will be included. The date range is inclusive at both ends.
count:
integer10
The number of buckets to return per aggregation

Examples


Result Format


Documentation

For more information on aggregations parameters and definitions, check the [Aggregations Overview](doc:vector-services-aggregations-reference-overview). For examples of how to form an aggregation query, check the [Aggregation Example Query Constructions](doc:vector-services-example-query-constructions#section-aggregations-with-bounding-box).

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}