Versions Compared

Old Version 15

changes.mady.by.user Ondrej Špalek

Saved on

compared with

New Version 16

changes.mady.by.user Ondrej Špalek

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

/api/reports/views/:id/map

This method returns data and metadata of specified map.

Resource Information

Resource URL

https://service.belladati.com/api/reports/views/:id/map

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

id

ID of the map view. This ID is a part of the /api/reports/:id response.

1234

filter

(Optional) Filter used in the map with following structure:

Name
Description
drilldown

Drilldown defined with attribute code and following structure:

Name
Description
opFilter operation type - please see list of supported values.
value/values(Optional) Depends on selected "op". Contains value or values for filter.


Code Block
{
   "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"
      }
   }
}

dateTimeDefinition

(Optional) Date and time definition used in the map with following structure:

NameDescription
dateInterval

(Optional) Date interval to filter values. Has following structure:

Name
Description
aggregationTypeDate interval period - please see list of supported values.
interval

Interval definition with following structure:

Name
Description
typeInterval type - please see list of supported values.
fromInterval start value - please see Setting Date Interval
toInterval end value - please see Setting Date Interval
timeInterval

(Optional) Time interval to filter values. Has following structure:

Name
Description
aggregationTypeTime interval period - please see list of supported values.
interval

Interval definition with following structure:

Name
Description
typeInterval type - please see list of supported values.
fromInterval start value - please see Setting Date Interval
toInterval end value - please see Setting Date Interval


 

Code Block
{
   "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

NameDescription
content.options

Configuration of the map

NameDescription
indicator

Name of the used indicator

colorColor of the indicator in HEX format
content.points

Array of GEO points where each point has following structure:

NameDescription
latitudeLatitude of the GEO point
longitudeLongitude of the GEO point
properties
NameDescription
backgroundColorBackground color
colorColor of the text
nameName of the point
context.dataLinkUnique identifier of the context element
context.indentifierQuery

Query used to display the value for this point

(e.g."[L_COUNTRY_NAME={Albania}]"

captionCaption of the point
valueValue of the indicator
rationSize of the point
 
 

Shape-based map

NameDescription
content.options

Configuration of the map

NameDescription
indicator

Name of the used indicator

grades

Array of colors used in the map. Each grade has following properties:

NameDescription
ColorColor of the shape (HEX format)
FromMinimum value of the interval
ToMaximum value of the interval
content.shapes.features

Array of GEO shapes where each shape has following structure:

NameDescription
geometryArray of coordinates which define the shape.
type"Feature"
properties
NameDescription
colorColor of the text
nameName of the point
context.dataLinkUnique identifier of the context element
context.indentifierQuery

Query used to display the value for this point

(e.g."[L_COUNTRY_NAME={Albania}]"

captionCaption of the point
valueValue of the indicator

Sample request/response

Using curl:

Code Block
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):

Code Block
javascript
javascript
{
  "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"
    }
  }
}

...