{"_id":"56e1ce81e416450e00b9e494","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"},"parentDoc":null,"__v":3,"project":"55faeacad0e22017005b8265","user":"56267741db1eda0d001c3dbb","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"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"],"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-10T19:44:01.390Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"| Table of Contents |\n| --- |\n| [Facets Vector Services API Parameters](#section-api-parameters) |\n| [Facets Vector Services Parameter Limits](#section-parameter-limits) |\n| [Associated API Calls for Facets Vector Services](#section-associated-api-calls-for-facets-vector-services) |\n\nThese endpoints work in any application.\n\n#API Parameters#\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| count  | Integer | Query | The number of buckets to return per aggregation, default 10. | Optional |\n| endDate | String | Query | 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. | Optional |\n| fields | String | Query | The comma-separated list of fields to return for the items. Example: `item_date,source,item_type` | Required |\n| left | String | Query | The leftmost X-coordinate for the bounding box; longitude in decimal degrees of the lower left bounding box corner. | Required |\n| lower | String | Query | The lowest Y-coordinate for the bounding box; latitude in decimal degrees of the lower left bounding box corner. | Required |\n| right | String | Query | The rightmost X-coordinate for the bounding box; longitude in decimal degrees of the upper right bounding box corner. | Required |\n| startDate | String | Query | 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. | Optional |\n| upper | String | Query | The highest Y-coordinate for the bounding box; latitude in decimal degrees of the upper right bounding box corner. | Required |\n\n#Parameter Limits#\n| Parameters | Limits |\n| --- | --- |\n| fields | Possible field options are: attributes, format, geom, geom_type,  : id, ingest_attributes, ingest_date, ingest_source, item_date, item_type, name, original_crs, source, text. *Note: geom will always display, even if not specified.* |\n| left | Between -180 and 180 degrees inclusive. |\n| lower | Between -90 and 90 degrees inclusive. |\n|right | Between -180 and 180 degrees inclusive. |\n| upper | Between -90 and 90 degrees inclusive. |\n\n#Associated API Calls for Facets Vector Services#\n[List Fields](doc:facets-fields)\n[Facet Search](doc:facets-search)","excerpt":"Overview of the Facets API","slug":"vector-services-facets-reference-overview","type":"basic","title":"Vector Services Facets Reference Overview"}

Vector Services Facets Reference Overview

Overview of the Facets API

| Table of Contents | | --- | | [Facets Vector Services API Parameters](#section-api-parameters) | | [Facets Vector Services Parameter Limits](#section-parameter-limits) | | [Associated API Calls for Facets Vector Services](#section-associated-api-calls-for-facets-vector-services) | These endpoints work in any application. #API Parameters# | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | count | Integer | Query | The number of buckets to return per aggregation, default 10. | Optional | | endDate | String | Query | 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. | Optional | | fields | String | Query | The comma-separated list of fields to return for the items. Example: `item_date,source,item_type` | Required | | left | String | Query | The leftmost X-coordinate for the bounding box; longitude in decimal degrees of the lower left bounding box corner. | Required | | lower | String | Query | The lowest Y-coordinate for the bounding box; latitude in decimal degrees of the lower left bounding box corner. | Required | | right | String | Query | The rightmost X-coordinate for the bounding box; longitude in decimal degrees of the upper right bounding box corner. | Required | | startDate | String | Query | 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. | Optional | | upper | String | Query | The highest Y-coordinate for the bounding box; latitude in decimal degrees of the upper right bounding box corner. | Required | #Parameter Limits# | Parameters | Limits | | --- | --- | | fields | Possible field options are: attributes, format, geom, geom_type, : id, ingest_attributes, ingest_date, ingest_source, item_date, item_type, name, original_crs, source, text. *Note: geom will always display, even if not specified.* | | left | Between -180 and 180 degrees inclusive. | | lower | Between -90 and 90 degrees inclusive. | |right | Between -180 and 180 degrees inclusive. | | upper | Between -90 and 90 degrees inclusive. | #Associated API Calls for Facets Vector Services# [List Fields](doc:facets-fields) [Facet Search](doc:facets-search)