{"_id":"56e30f91cb6ef20e0084f23c","__v":1,"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":17,"slug":"aggregations-facets-vector-services-guide","title":"Aggregations & Facets Vector Services Guide"},"project":"55faeacad0e22017005b8265","user":"562654b6f3adc80d0048611b","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"},"editedParams":true,"editedParams2":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-11T18:33:53.707Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","code":"{\n  \"geom\": {\n    \"type\": \"Polygon\",\n    \"coordinates\": [\n      [\n        [\n          32.3964,\n          34.7208\n        ],\n        [\n          32.3964,\n          42.631\n        ],\n        [\n          37.2633,\n          42.631\n        ],\n        [\n          37.2633,\n          34.7208\n        ],\n        [\n          32.3964,\n          34.7208\n        ]\n      ]\n    ]\n  },\n  \"responseDate\": \"2017-04-20T12:59:40Z\",\n  \"totalItems\": 103992,\n  \"facets\": [\n    {\n      \"fieldName\": \"source\",\n      \"terms\": [\n        {\n          \"term\": \"bing\",\n          \"count\": 24665\n        },\n        {\n          \"term\": \"Bing\",\n          \"count\": 4551\n        }\n      ]\n    },\n    {\n      \"fieldName\": \"item_type\",\n      \"terms\": [\n        {\n          \"term\": \"Road\",\n          \"count\": 43829\n        },\n        {\n          \"term\": \"GBDXCatalogRecord\",\n          \"count\": 11593\n        }\n      ]\n    },\n    {\n      \"fieldName\": \"format\",\n      \"terms\": [\n        {\n          \"term\": \"OSM\",\n          \"count\": 92283\n        },\n        {\n          \"term\": \"shapefile\",\n          \"count\": 116\n        }\n      ]\n    }\n  ],\n  \"startDate\": \"2014-09-03T12:07:16.179Z\",\n  \"endDate\": \"2015-09-03T12:52:33.208Z\"\n}","language":"json"}]},"settings":"56e2c496d64add20007dceba","examples":{"codes":[{"code":"Request:\n  GET /insight-vector/api/facets?fields=:fields&left=:left&right=:right&upper=:upper&lower=:lower&startDate=:startDate&endDate=:endDate&count=:count\n\nHeaders:\n  Authorization: Bearer {token}\n  Accept: application/json\n\n\nResponse (success):\n  200 OK","language":"text"},{"code":"https://vector.geobigdata.io/insight-vector/api/facets?fields=source,item_type,format&left=32.3964&right=37.2633&upper=42.631&lower=34.7208&startDate=2014-09-03T12:07:16.179Z&endDate=2015-09-03T12:52:33.208Z&count=2","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"56e30f91cb6ef20e0084f244","ref":"","in":"query","required":true,"desc":"A comma-delimited list of fields to include. Example: item_date,source,item_type","default":"source,item_type,format","type":"string","name":"fields"},{"_id":"56e30f91cb6ef20e0084f243","ref":"","in":"query","required":true,"desc":"Longitude in decimal degrees of the lower left bounding box corner","default":"32.3964","type":"string","name":"left"},{"_id":"56e30f91cb6ef20e0084f242","ref":"","in":"query","required":true,"desc":"Longitude in decimal degrees of the upper right bounding box corner","default":"37.2633","type":"string","name":"right"},{"_id":"56e30f91cb6ef20e0084f241","ref":"","in":"query","required":true,"desc":"Latitude in decimal degrees of the upper right bounding box corner","default":"42.631","type":"string","name":"upper"},{"_id":"56e30f91cb6ef20e0084f240","ref":"","in":"query","required":true,"desc":"Latitude in decimal degrees of the lower left bounding box corner","default":"34.7208","type":"string","name":"lower"},{"_id":"56e30f91cb6ef20e0084f23f","ref":"","in":"query","required":false,"desc":"ISO-8601-formatted date string for the start of a date range; startDate runs a query against the field item_date Note: The date range can be specified with ISO-8601 date strings or with expressions using the term \"now\" to indicate the current date. The date expressions can include simple \"date math\" by appending \"+\" or \"-\" along with a numeral and a unit. For example, to set the start date to one day ago, the start date expression would read \"now-1d\". The units supported are \"y\" (year), \"M\" (month), \"w\" (week), \"d\" (day), \"h\" (hour), \"m\" (minute), and \"s\" (second). The date range is inclusive at both ends. If no date range is provided, then all items within the AOI will be included.","default":"2014-09-03T12:07:16.179Z","type":"string","name":"startDate"},{"_id":"56e30f91cb6ef20e0084f23e","ref":"","in":"query","required":false,"desc":"ISO-8601-formatted date string for the end of a date range; endDate runs a query against the field item_date Note: The date range can be specified with ISO-8601 date strings or with expressions using the term \"now\" to indicate the current date. The date expressions can include simple \"date math\" by appending \"+\" or \"-\" along with a numeral and a unit. For example, to set the start date to one day ago, the start date expression would read \"now-1d\". The units supported are \"y\" (year), \"M\" (month), \"w\" (week), \"d\" (day), \"h\" (hour), \"m\" (minute), and \"s\" (second). The date range is inclusive at both ends. If no date range is provided, then all items within the AOI will be included.","default":"2015-09-03T12:52:33.208Z","type":"string","name":"endDate"},{"_id":"56e30f91cb6ef20e0084f23d","ref":"","in":"query","required":false,"desc":"The number of buckets to return per aggregation","default":"10","type":"int","name":"count"}],"url":"/insight-vector/api/facets?"},"isReference":false,"order":10,"body":"","excerpt":"The Facet Search  is used to retrieve a listing of available values (up to the value of the “count” parameter) for the given fields in items within the given AOI and within the given date range.","slug":"facets-search","type":"endpoint","title":"Facet Search"}

getFacet Search

The Facet Search is used to retrieve a listing of available values (up to the value of the “count” parameter) for the given fields in items within the given AOI and within the given date range.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

fields:
required
stringsource,item_type,format
A comma-delimited list of fields to include. Example: item_date,source,item_type
left:
required
string32.3964
Longitude in decimal degrees of the lower left bounding box corner
right:
required
string37.2633
Longitude in decimal degrees of the upper right bounding box corner
upper:
required
string42.631
Latitude in decimal degrees of the upper right bounding box corner
lower:
required
string34.7208
Latitude in decimal degrees of the lower left bounding box corner
startDate:
string2014-09-03T12:07:16.179Z
ISO-8601-formatted date string for the start of a date range; startDate runs a query against the field item_date Note: The date range can be specified with ISO-8601 date strings or with expressions using the term "now" to indicate the current date. The date expressions can include simple "date math" by appending "+" or "-" along with a numeral and a unit. For example, to set the start date to one day ago, the start date expression would read "now-1d". The units supported are "y" (year), "M" (month), "w" (week), "d" (day), "h" (hour), "m" (minute), and "s" (second). The date range is inclusive at both ends. 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 date string for the end of a date range; endDate runs a query against the field item_date Note: The date range can be specified with ISO-8601 date strings or with expressions using the term "now" to indicate the current date. The date expressions can include simple "date math" by appending "+" or "-" along with a numeral and a unit. For example, to set the start date to one day ago, the start date expression would read "now-1d". The units supported are "y" (year), "M" (month), "w" (week), "d" (day), "h" (hour), "m" (minute), and "s" (second). The date range is inclusive at both ends. If no date range is provided, then all items within the AOI will be included.
count:
integer10
The number of buckets to return per aggregation

Examples


Result Format


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