You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

/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

Parameters

Parameters

Detail

id

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

filter

Filter used in the KPI.

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

Date time definition used in the KPI.

{
        "dateInterval": {
               "interval": {
                       "from":{"year":"2014","month":"1","day":"22"},
                       "to":{"year":"2014","month":"1","day":"25"},
                       "type": "absolute"
               },
               "aggregationType": "DAY"
        }
}

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/88738/map

The JSON format response (points):

{
  "title": "this is title"
  "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" : -69.9667,
      "latitude" : 12.5,
      "properties" : {
        "ratio" : 0.6693351621423395,
        "name" : "Aruba",
        "value" : "187,484,830",
        "context" : {
          "identifierQuery" : "[L_COUNTRY_OR_AREA={Aruba}]",
          "dataLink" : "1_1205372548"
        }
      }
    },
    {
      "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"
  }
}
}
  • No labels