{"_id":"58b01e003529383900a75918","__v":1,"category":{"_id":"56e1c96b2506700e00de6e83","version":"55faeacad0e22017005b8268","__v":38,"pages":["56e1ca17cd6a8d0e00d12163","56e1cb0fe416450e00b9e485","56e1cba3cd6a8d0e00d1216c","56e1cc1ae63f910e00e5986b","56e1d0b0cd6a8d0e00d1217f","56e1d15ce416450e00b9e4a3","56e1d23292bf640e00b55663","56e1d296bc46be0e002af287","56e1d305cd6a8d0e00d1218c","56e1d373e416450e00b9e4ab","56e1d38a92bf640e00b55669","56e1d44dbc46be0e002af28e","56e2cb174cd67e220032d655","56e2cf9c1067950e006a16c8","56e2d5ff3987d729008695a0","56e2ddea8ffe6020004c53b2","56e2df768ffe6020004c53bd","56e2e1201067950e006a16f1","56e2e3888ffe6020004c53c5","56e2e53f1067950e006a1702","56e2e9773987d729008695cf","56e2ec731bffb72b00d0562e","56e2ed25b9c88f2900864aab","56e2f0314cd67e220032d6b9","56e2f3c43987d729008695ed","56e2fc3fb9c88f2900864ad7","56e2fe0d3987d7290086960b","56e30180f1ad030e00e72fa7","56e302c228f99e2000a5ffa6","56e3040c6e602e0e00700af6","56e304c5d46bc30e007bb958","56e30650d46bc30e007bb965","56e307456e602e0e00700b08","56e3086251857d0e008e778d","56e3096251857d0e008e7796","56e30a16d46bc30e007bb973","56e30aafd46bc30e007bb97c","56e30aeb51857d0e008e779f"],"project":"55faeacad0e22017005b8265","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-10T19:22:19.658Z","from_sync":false,"order":16,"slug":"read-query-vector-services-guide","title":"Read & Query Vector Services Guide"},"project":"55faeacad0e22017005b8265","user":"56267741db1eda0d001c3dbb","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":35,"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","5a009de510890d001c2aabfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-24T11:50:24.168Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"Request:\n  GET /insight-vector/api/index/aggregation/:index?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/index/aggregation/vector-web-s?aggs=terms:ingest_source&query=test&left=-180&right=180&upper=90&lower=-90&startDate=now-3M&endDate=now&count=10","language":"http"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"responseDate\": \"2017-04-26T13:36:43Z\",\n  \"geom\": {\n    \"type\": \"Polygon\",\n    \"coordinates\": [\n      [\n        [\n          -180,\n          -90\n        ],\n        [\n          -180,\n          90\n        ],\n        [\n          180,\n          90\n        ],\n        [\n          180,\n          -90\n        ],\n        [\n          -180,\n          -90\n        ]\n      ]\n    ]\n  },\n  \"query\": \"test\",\n  \"startDate\": \"now-3M\",\n  \"endDate\": \"now\",\n  \"totalItems\": 45,\n  \"aggregations\": [\n    {\n      \"name\": \"terms:ingest_source\",\n      \"terms\": [\n        {\n          \"term\": \"HGTD-test\",\n          \"count\": 26,\n          \"aggregations\": null\n        },\n        {\n          \"term\": \"REST API test source\",\n          \"count\": 18,\n          \"aggregations\": null\n        },\n        {\n          \"term\": \"Vector REST API\",\n          \"count\": 1,\n          \"aggregations\": null\n        }\n      ]\n    }\n  ]\n}","language":"json","status":200}]},"settings":"56e2c496d64add20007dceba","auth":"required","params":[{"_id":"58b0204b3529383900a75922","ref":"","in":"path","required":true,"desc":"The Elasticsearch index within which the desired vectors are stored.","default":"","type":"string","name":"index"},{"_id":"56e30dd0d46bc30e007bb98f","ref":"","in":"query","required":true,"desc":"The aggregation definitions.","default":"geohash:4;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":"","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/index/aggregation/:index?"},"isReference":false,"order":47,"body":"For more information on aggregations parameters and definitions, check the [Vector Services Aggregations Reference Overview](doc:vector-services-aggregations-reference-overview).\n\nFor examples of how to form an aggregation query, check the [Index Query Examples](doc:vector-services-example-query-constructions#section-index-query).","excerpt":"Groups vector items for a given index, aggregation definition, date range, and bounding box.","slug":"index-query-aggregation-by-bounding-box","type":"endpoint","title":"Index Query: Aggregation by Bounding Box"}

getIndex Query: Aggregation by Bounding Box

Groups vector items for a given index, aggregation definition, date range, and bounding box.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

index:
required
string
The Elasticsearch index within which the desired vectors are stored.

Query Params

aggs:
required
stringgeohash:4;terms:ingest_source
The aggregation definitions.
query:
string
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 [Vector Services Aggregations Reference Overview](doc:vector-services-aggregations-reference-overview). For examples of how to form an aggregation query, check the [Index Query Examples](doc:vector-services-example-query-constructions#section-index-query).

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 }}