Versions Compared

Old Version 20

changes.mady.by.user Kanako Higashi

Saved on

compared with

New Version 21

changes.mady.by.user Kanako Higashi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageja

/api/reports/views/:id/map

このメソッドは、データと指定されたマップのメタデータを返します。このメソッドは、指定されたマップのデータとメタデータを返します。

リソース情報

リソースURL 

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

HTTPメソッド

GET

リクエストパラメータ

リクエストパラメーター

パラメーター

詳細

例

id

マップビューのID。このIDは マップビューのID。このIDは /api/reports/:id レスポンスの一部です。

1234

filter（任意）フィルタが次のような構造を持つKPIで使用しました：

(オプション) 次の構造でマップで使用されるフィルター:

名
説明
drilldown

ドリルダウンが属性コードと次のような構造で定義されました：属性コードと次の構造で定義されたドリルダウン:

名
説明
opフィルタ操作タイプ

フィルター操作タイプ - サポートされている値のリスト

をご参照してください。

を参照してください。

value/values（任意）選択した「op」に依存します。フィルタの値または値を格納します。

(オプション) 選択した "op" によって異なります。フィルターの1つまたは複数の値が含まれます。

countOp

(任意) Used with COUNT operation. Specifies the second operation used together with count.オプション) COUNT操作で使用されます。 countと一緒に使用される2番目の操作を指定します。

サポートされている値Supported values: EQ, NEQ, GT, GTE, LT, LTE




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（任意）日付と時間の定義が次のような構造を持つKPIで使用しました。

(オプション) 次の構造でマップで使用される日時の定義:

名説明
dateInterval

（任意）値をフィルタリングする日付間隔。構造は次の通りです：(オプション) 値をフィルタリングする日付間隔。構造は次の通りです:

名
説明
aggregationTypeインターバル日付期間は 日付間隔期間 - サポートされる値のリストをご参照してください。 サポートされている値のリストを参照してください。
interval

次のような構造のインターバルの定義次の構造の間隔定義:

名
説明
typeインターバルタイプ 間隔のタイプ - サポートされている値のリストをご参照してください。を参照してください。
fromインターバル開始値間隔開始値 - サポートされている値のリストを参照してください。
toインターバル終了値間隔終了値 - サポートされている値のリストを参照してください。



timeInterval

（任意）値をフィルタリングする時間間隔。構造は次の通りです：(オプション) 値をフィルタリングするための時間間隔。構造は次の通りです:

名
説明
aggregationTypeタイムインターバル期間は- サポートされる値のリストをご参照してください。時間間隔期間 - サポートされている値のリストを参照してください。
interval

次のような構造のインターバルの定義：次の構造の間隔定義:

名
説明
typeインターバルタイプ 間隔のタイプ - サポートされている値のリストをご参照してください。を参照してください。
fromインターバル開始値間隔開始値 - サポートされている値のリストを参照してください。
toインターバル終了値間隔終了値 - サポートされている値のリストを参照してください。






Code Block
{
   "dateInterval": {
      "interval": {
          "from":{"year":"2014","month":"1","day":"22"},
          "to":{"year":"2014","month":"1","day":"25"},
          "type": "absolute"
      },
      "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


レスポンス構造

JSONレスポンスには、1つのJSONオブジェクトが含まれています。ポイントベースのマップとシェイプベースのマップでは、レスポンスが異なります。

ポイントベースのマップ

名説明NameDescription
content.options

マップの構成

名説明

Configuration of the map

NameDescription
indicator

Name of the used indicator使用されたインジケーターの名前

colorColor of the indicator in HEX format

HEX形式のインジケーターの色


content.points

Array of GEO points where each point has following structure各ポイントが次の構造を持つGEOポイントの配列:

Name名Description説明
latitudeLatitude of the GEO pointGEOポイントの緯度
longitudeLongitude of the GEO pointGEOポイントの経度
properties


Name名Description説明
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マップで使用される色の配列。各グレードには以下のプロパティがあります:

Name名Description説明
ColorColor of the shape (HEX format形の色 (HEX形式)
FromMinimum value of the interval間隔の最小値
ToMaximum value of the interval間隔の最大値



content.shapes.features

Array of GEO shapes where each shape has following structure各形状が次の構造を持つGEO形状の配列:

Name名Description説明
geometryArray of coordinates which define the shape.

形状を定義する座標の配列。

type"Feature"
properties


Name
名
Description
説明
color
Color of the text
テキスト色
name
Name of the point
ポイントの名前
context.dataLink
Unique identifier of the context element

コンテキスト要素の一意の識別子

context.indentifierQuery
Query used to display the value for this point

このポイントの値を表示するために使用されるクエリ

(

e.g

例."[L_COUNTRY_NAME={Albania}]"

caption
Caption of the point
ポイントのキャプション
value
Value of the indicator
インジケーターの値



サンプルリクエスト/レスポンス

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

JSONフォーマットのレスポンス JSON形式のレスポンス (ポイント):

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