/api/reports/views/:id/map
This method returns data and metadata of specified map.
Resource Information
Resource URL | |
HTTP Method |
|
Request Parameters
Parameters | Detail | Example | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ID of the map view. This ID is a part of the | 1234 | ||||||||||||||||||||||||||||||||||
| (Optional) Filter used in the map with following structure:
| { "drilldown": { "L_COUNTRY_OR_AREA": { "op": "EQ", "value": "Slovakia" }, "L_TYPE": { "op": "IN", "values": [ "Type 1", "Type 2", "Type 3" ] }, "L_DATE": { "op": "NOT_NULL" }, "L_PRODUCT":{ "op":"COUNT", "countOp":"LTE", "value":"816" } } } | ||||||||||||||||||||||||||||||||||
| (Optional) Date and time definition used in the map with following structure:
| { "dateInterval": { "interval": { "from": "actualYear-1y", "to": "actualYear-1d", "type": "custom" }, "aggregationType": "DAY" }, "timeInterval": { "interval": { "from":{"hour":"14","minute":"15","second":"16"}, "to":{"hour":"20","minute":"0","second":"0"}, "type": "absolute" }, "aggregationType": "SECOND" } } |
Response Structure
JSON response contains one JSON object. The response is different for point-based map and for shaped-base map.
Point-based map
Name | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
content.options | Configuration of the map
| ||||||||||||||||||||||||||
content.points | Array of GEO points where each point has following structure:
|
Shape-based map
Name | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
content.options | Configuration of the map
| ||||||||||||||||||||||
content.shapes.features | Array of GEO shapes where each shape has following structure:
|
Sample request/response
Using curl
:
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/reports/views/1234/map
The JSON format response (points):
{ "title": "<div class=\"cleverTitle\"><\/div>" "content": { "points" : [ { "longitude" : 45, "latitude" : 40, "properties" : { "ratio" : 0.6323828313278139, "name" : "Armenia", "value" : "-7,142,253,000", "context" : { "identifierQuery" : "[L_COUNTRY_OR_AREA={Armenia}]", "dataLink" : "1_1097087486" } } }, { "longitude" : 133, "latitude" : -27, "properties" : { "ratio" : 0, "name" : "Australia", "value" : "-132,579,546,390", "context" : { "identifierQuery" : "[L_COUNTRY_OR_AREA={Australia}]", "dataLink" : "1_-2097652575" } } } ], "options" : { "indicator" : "Value", "color" : "#4379bd" } } }