{"_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":2,"project":"55faeacad0e22017005b8265","user":"56267741db1eda0d001c3dbb","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":32,"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"],"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":11,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Facets Overview\"\n}\n[/block]\nIn order for users to easily reference vector fields, facets are available. Users are able to query the available vector fields globally or within a specific area.\n\n<h2>Facet API Parameters</h2>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Data Type\",\n    \"h-2\": \"Parameter Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"fields\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Query\",\n    \"0-3\": \"A comma-delimited list of fields to include.\\nExample:\\nitem_date,source,item_type\",\n    \"2-0\": \"right\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Query\",\n    \"2-3\": \"The rightmost X-coordinate for the bounding box\",\n    \"3-0\": \"upper\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Query\",\n    \"3-3\": \"The highest Y-coordinate for the bounding box\",\n    \"4-0\": \"lower\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Query\",\n    \"4-3\": \"The lowest Y-coordinate for the bounding box\",\n    \"7-0\": \"count\",\n    \"7-1\": \"String\",\n    \"7-2\": \"Query\",\n    \"7-3\": \"The number of buckets to return per aggregation, default 10\",\n    \"1-0\": \"left\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Query\",\n    \"1-3\": \"The leftmost X-coordinate for the bounding box\",\n    \"5-0\": \"startDate\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Query\",\n    \"5-3\": \"ISO-8601-formatted date string for the start of a date range; startDate runs a query against the field item_date\\nNote: 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.\",\n    \"6-0\": \"endDate\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Query\",\n    \"6-3\": \"ISO-8601-formatted date string for the end of a date range; endDate runs a query against the field item_date\\nNote: 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.\"\n  },\n  \"cols\": 4,\n  \"rows\": 8\n}\n[/block]\n<h2>Associated API calls</h2>\n[List Fields](doc:facets-fields)\n[Facet Search](doc:facets-search)","excerpt":"Overview of the Facets API","slug":"facets-course","type":"basic","title":"Facets Course"}

Facets Course

Overview of the Facets API

[block:api-header] { "type": "basic", "title": "Facets Overview" } [/block] In order for users to easily reference vector fields, facets are available. Users are able to query the available vector fields globally or within a specific area. <h2>Facet API Parameters</h2> [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Data Type", "h-2": "Parameter Type", "h-3": "Description", "0-0": "fields", "0-1": "String", "0-2": "Query", "0-3": "A comma-delimited list of fields to include.\nExample:\nitem_date,source,item_type", "2-0": "right", "2-1": "String", "2-2": "Query", "2-3": "The rightmost X-coordinate for the bounding box", "3-0": "upper", "3-1": "String", "3-2": "Query", "3-3": "The highest Y-coordinate for the bounding box", "4-0": "lower", "4-1": "String", "4-2": "Query", "4-3": "The lowest Y-coordinate for the bounding box", "7-0": "count", "7-1": "String", "7-2": "Query", "7-3": "The number of buckets to return per aggregation, default 10", "1-0": "left", "1-1": "String", "1-2": "Query", "1-3": "The leftmost X-coordinate for the bounding box", "5-0": "startDate", "5-1": "String", "5-2": "Query", "5-3": "ISO-8601-formatted date string for the start of a date range; startDate runs a query against the field item_date\nNote: 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.", "6-0": "endDate", "6-1": "String", "6-2": "Query", "6-3": "ISO-8601-formatted date string for the end of a date range; endDate runs a query against the field item_date\nNote: 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." }, "cols": 4, "rows": 8 } [/block] <h2>Associated API calls</h2> [List Fields](doc:facets-fields) [Facet Search](doc:facets-search)