{"__v":1,"_id":"54db94e7c6a4d40d0034b96e","category":{"__v":7,"_id":"54fdad6e660db63700c23b82","pages":["55fbef82af72eb0d0007df93","55fbf623e013770d008fcba8","5617bd3a26e3db230054fba4","5617c4a6f8c9632100ac74f5","561ed6fd0a04340d00d8a0b0","562156adf4e0352100cbf268","562a5c846049f20d0032520b"],"project":"54d0fd1d095c470d00d1646d","version":"54d0fd1e095c470d00d16470","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-09T14:25:50.133Z","from_sync":false,"order":2,"slug":"api-reference","title":"API Reference"},"editedParams":true,"editedParams2":true,"project":"54d0fd1d095c470d00d1646d","user":"54db646008ea010d00ab1fe1","version":{"__v":20,"_id":"54d0fd1e095c470d00d16470","project":"54d0fd1d095c470d00d1646d","createdAt":"2015-02-03T16:53:50.090Z","releaseDate":"2015-02-03T16:53:50.090Z","categories":["54d0fd1e095c470d00d16471","54d8b5e68934140d00496544","54db6361c6a4d40d0034b8f7","54db638208ea010d00ab1fdd","54db639008ea010d00ab1fde","54db6547c6a4d40d0034b8fd","54db83482092743700ea6ee1","54db84afc6a4d40d0034b93c","54db8805c6a4d40d0034b93f","54db8de9c6a4d40d0034b961","54db931ac6a4d40d0034b96d","54e49219e4365521006fd9ee","54e74fcc652d7c1900cbe737","54e74ffd3c1e111700d05762","54e77e0a523b1b2f00e6f313","54e784affdabe62500fcddcf","54e784fa523b1b2f00e6f319","54e785de8ae8911900cd42c5","54fdad6e660db63700c23b82","54fdff31f7b1202100a25e06"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-11T17:44:07.815Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"[\n  {\n    \"0\": {\n      \"coords\":[41.78583934019979,-90.50017726540011],\n      \"count\":15602,\n      \"stats\": {\n        \"hull\":\"POLYGON ((42.124819 -90.703109, 41.331677 -90.696997, \n                          40.999502 -90.636054, 41.063269 -90.004138, \n                          42.447452 -90.039928, 42.571199 -90.698187, \n                          42.124819 -90.703109))\"\n      },\n      \"fields\":{}\n    }\n  }\n]","language":"json","status":200}]},"auth":"required","params":[{"_id":"54db94e7c6a4d40d0034b974","ref":"","in":"path","required":true,"desc":"Database name","default":"","type":"string","name":"database_name"},{"_id":"54db94e7c6a4d40d0034b973","ref":"","in":"path","required":true,"desc":"Collection name","default":"","type":"string","name":"collection_name"},{"_id":"54db94e7c6a4d40d0034b972","ref":"","in":"path","required":true,"desc":"Zoom level","default":"","type":"int","name":"z"},{"_id":"54db94e7c6a4d40d0034b971","ref":"","in":"path","required":true,"desc":"x tile coordinate","default":"","type":"int","name":"x"},{"_id":"54db94e7c6a4d40d0034b970","ref":"","in":"path","required":true,"desc":"y tile coordinate","default":"","type":"int","name":"y"},{"_id":"54db94e7c6a4d40d0034b96f","ref":"","in":"query","required":false,"desc":"Number of clusters in this. Must be an integer between 1 and 4,","default":"1","type":"int","name":"cluster_qtd"},{"_id":"54db9573b813d12d007dcfe6","ref":"","in":"query","required":false,"desc":"Relational filter in ElasticSearch format","default":"","type":"string","name":"q"},{"_id":"54db9573b813d12d007dcfe5","ref":"","in":"query","required":false,"desc":"Callback of jsonP","default":"","type":"string","name":"callback"}],"url":"/map/:database_name/:collection_name/:z/:x/:y/cluster.json"},"isReference":false,"order":34,"body":"### Sample Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -XGET \\\\\\n\\\"https://api.gogeo.io/1.0/map/my_database/my_collection/2/1/2/cluster.json?mapkey=MAP-KEY\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### Sample Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n    \\\"0\\\": {\\n      \\\"coords\\\":[41.78583934019979,-90.50017726540011],\\n      \\\"count\\\":15602,\\n      \\\"stats\\\": {\\n        \\\"hull\\\":\\\"POLYGON ((42.124819 -90.703109, 41.331677 -90.696997, \\n                          40.999502 -90.636054, 41.063269 -90.004138, \\n                          42.447452 -90.039928, 42.571199 -90.698187, \\n                          42.124819 -90.703109))\\\"\\n      },\\n      \\\"fields\\\":{}\\n    }\\n  }\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nOn map, after rendered it will show an special marker representing a cluster (group of points). This marker shows up the number of points in this cluster, pointing the mouse cursor over the cluster sign will show where these points are arranged. For this is necessary the use of special styles and a javascript plugin developed by goGeo team. See the [**Clustering Service**](http://developers.gogeo.io/v1.0/docs/clustering-service) guide as reference.\n[block:html]\n{\n  \"html\": \"<div class=\\\"panel panel-info teste\\\" >\\n  <div class=\\\"panel-body\\\">\\n    This endpoint requires a MAP key. See <a href=\\\"basic-auth\\\">Basic Authentication</a> for more information about the goGeo authentication system.\\n    <br><br>\\n    If you don't have an access key yet, <a href=\\\"https://console.gogeo.io/signup\\\">sign up</a> and grab yours!\\n  </div>\\n</div>\\n\"\n}\n[/block]\n---\n[block:html]\n{\n  \"html\": \"<div class='div-middle'> \\n  <a href='#'>\\n    Top page &spades; </div>\\n  </a>\\n</div>\\n\\n<div class='div-back'> \\n  <a href='/v1.0/docs/clustering'>\\n    &laquo; Back \\n  </a>\\n</div>\\n\\n<style>\\n\\t.div-back {\\n  \\tpadding-left: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n  \\n  .div-middle {\\n  \\ttext-align: center;\\n\\t\\tmargin-top: -15px;\\n  }\\n  \\n  .div-forward {\\n  \\tfloat: right;\\n    padding-right: 15px;\\n\\t\\tmargin-top: -20px;\\n  }\\n</style>\"\n}\n[/block]","excerpt":"Provide a better visualization of a large amount of Points on a map.","slug":"get-clusters","type":"get","title":"Map clustering service"}

getMap clustering service

Provide a better visualization of a large amount of Points on a map.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

database_name:
required
string
Database name
collection_name:
required
string
Collection name
z:
required
integer
Zoom level
x:
required
integer
x tile coordinate
y:
required
integer
y tile coordinate

Query Params

cluster_qtd:
integer1
Number of clusters in this. Must be an integer between 1 and 4,
q:
string
Relational filter in ElasticSearch format
callback:
string
Callback of jsonP

Result Format


Documentation

### Sample Request [block:code] { "codes": [ { "code": "curl -XGET \\\n\"https://api.gogeo.io/1.0/map/my_database/my_collection/2/1/2/cluster.json?mapkey=MAP-KEY\"", "language": "curl" } ] } [/block] ### Sample Response [block:code] { "codes": [ { "code": "[\n {\n \"0\": {\n \"coords\":[41.78583934019979,-90.50017726540011],\n \"count\":15602,\n \"stats\": {\n \"hull\":\"POLYGON ((42.124819 -90.703109, 41.331677 -90.696997, \n 40.999502 -90.636054, 41.063269 -90.004138, \n 42.447452 -90.039928, 42.571199 -90.698187, \n 42.124819 -90.703109))\"\n },\n \"fields\":{}\n }\n }\n]", "language": "json" } ] } [/block] On map, after rendered it will show an special marker representing a cluster (group of points). This marker shows up the number of points in this cluster, pointing the mouse cursor over the cluster sign will show where these points are arranged. For this is necessary the use of special styles and a javascript plugin developed by goGeo team. See the [**Clustering Service**](http://developers.gogeo.io/v1.0/docs/clustering-service) guide as reference. [block:html] { "html": "<div class=\"panel panel-info teste\" >\n <div class=\"panel-body\">\n This endpoint requires a MAP key. See <a href=\"basic-auth\">Basic Authentication</a> for more information about the goGeo authentication system.\n <br><br>\n If you don't have an access key yet, <a href=\"https://console.gogeo.io/signup\">sign up</a> and grab yours!\n </div>\n</div>\n" } [/block] --- [block:html] { "html": "<div class='div-middle'> \n <a href='#'>\n Top page &spades; </div>\n </a>\n</div>\n\n<div class='div-back'> \n <a href='/v1.0/docs/clustering'>\n &laquo; Back \n </a>\n</div>\n\n<style>\n\t.div-back {\n \tpadding-left: 15px;\n\t\tmargin-top: -20px;\n }\n \n .div-middle {\n \ttext-align: center;\n\t\tmargin-top: -15px;\n }\n \n .div-forward {\n \tfloat: right;\n padding-right: 15px;\n\t\tmargin-top: -20px;\n }\n</style>" } [/block]

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