API での分析結果詳細の取得

REST API を使うと、以下の 2 つのフォーマットで分析結果詳細を取得できます。

  • Tabular Result:ファクトが、ディメンションの組み合わせごとに集計された形で返されます。
  • Grouped Result:ファクトが、指定したディメンションで分割された形で返されます。

Tabular Result

以下に、Tabular Result を取得する例を挙げます。ここでは、2012-12-01 から 2013-01-31 までの集計結果を取得しています。

curl -v -X GET \
  -H "Authorization: Basic {BASE64_ENCODED_APPID_AND_APPKEY}" \
  -H "Accept: application/vnd.kii.TabularAnalyticResult+json" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/analytics/{AGGREGATION_RULE_ID}/data?startDate=2012-12-1&endDate=2013-1-31"

取得は Basic 認証 を使って行います。{BASE64_ENCODED_APPID_AND_APPKEY} には AppID と任意の値をコロン(:) で連結した文字列を Base64 エンコードしたものを入れてください。

Kii Cloud は次のように集計結果を返します。

{
  "labels" : [ {
    "label" : "Gender",
    "type" : "DIMENSION"
  }, {
    "label" : "City",
    "type" : "DIMENSION"
  }, {
    "label" : "Location",
    "type" : "DIMENSION"
  }, {
    "label" : "No. Of Children",
    "type" : "DIMENSION"
  }, {
    "label" : "Age",
    "type" : "DIMENSION"
  }, {
    "label" : "Count",
    "type" : "FACT"
  } ],
  "snapshots" : [ {
    "createdAt" : 1357862400000,
    "data" : [ [ "M", "San Francisco", "US", 1, 40, 1 ],  (...snip...)  , [ "F", "Tokyo", "JP", 2, 39, 2 ] ]
  }, {
    "createdAt" : 1357948800000,
    "data" : [ [ "F", "New York", "US", 3, 35, 2 ],  (...snip...)  , [ "F", "Kyoto", "JP", 0, 18, 1 ] ]

  (... snip ...)

  } ]
}

リクエスト時に、フィルター(e.g,. "age" が 22 であるデータのみを対象とした集計を実施)を指定して取得分析結果の絞り込みを行うこともできます。指定方法などの詳細については、REST API 詳細ドキュメント を参照してください。

Grouped Result

以下に、Grouped Result を取得する例を挙げます。ここでは、ディメンションとして "location" を指定して、2012-12-01 から 2013-01-31 までの集計結果を取得しています(ディメンションの指定には、Aggregation Rule を定義した際に "Name" としてセットした値を使用してください)。

curl -v -X GET \
  -H "Authorization: Basic {BASE64_ENCODED_APPID_AND_APPKEY}" \
  -H "Accept: application/vnd.kii.GroupedAnalyticResult+json" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/analytics/{AGGREGATION_RULE_ID}/data?startDate=2012-12-1&endDate=2013-1-31&group=location"

取得は Basic 認証 を使って行います。{BASE64_ENCODED_APPID_AND_APPKEY} には AppID と任意の値をコロン(:) で連結した文字列を Base64 エンコードしたものを入れてください。

Kii Cloud は次のように集計結果を返します。

{
  "snapshots" : [ {
    "name" : "New York",
    "data" : [ 10, 10, 11,  (...snip...)   , 12 ],
    "pointStart" : 1357862400000,
    "pointInterval" : 86400000
  }, {
    "name" : "Tokyo",
    "data" : [ 5, 8, 10,  (...snip...)   , 15],
    "pointStart" : 1357862400000,
    "pointInterval" : 86400000
 }, {

  (... snip ...)

  } ]
}

集計結果の内訳は以下のとおりです。

  • name:ディメンション(グルーピングキー)の名前
  • data:取得した分析結果を保持する JSON 配列
  • pointStart:データ開始日(UNIX 時間、ミリ秒、UTC)
  • pointInterval:データポイントの間隔(ミリ秒)

リクエスト時に、フィルター(e.g,. "age" が 22 であるデータのみを対象とした集計を実施)を指定して取得分析結果の絞り込みを行うこともできます。指定方法などの詳細については、REST API 詳細ドキュメント を参照してください。