はじめに
Piano Insight APIが使用されるのは主に次のような動機からです：
a) 特定の目的がある（例：「先週Facebookから来たユーザのうち、スポーツに興味のあるユーザはどのくらいいるのか？」
b) トラフィックやユーザグループの潜在的なパターンを見つけるためのデータ分析
どちらの場合もその目的を達成するためには、使用するツールおよびリクエストと応答に使用できるデータを理解しておく必要があります。このページではデータ側（ツールではなく）についての概要およびPiano Insight APIの/trafficファミリーにおいて使用できる一般的なパターンをご紹介します。Piano Insight APIを理解することはPiano Insightワークスペースを使いこなすことにも繋がります。
このWikiページはPiano Insight APIを使用するためのツールについての説明ではありません。ツールについての説明はこちらをご参照ください。
概念図
リクエスト側: ドリルダウンフィルタ
さまざまなトラフィックフィルタが使用できますが、重要なのは以下のフィルタです：
-
event
-
keyword
-
custom
-
user
使用できるすべてのフィルタは トラフィックフィルター に記載されています。
概要説明
これらのフィルタは"type"の値（名前）として指定します。
|
それぞれのフィルタで使用できる要素について以下で説明します。
Event
Piano Insightのトラッキングスクリプトにより、メタデータとして各イベント(event)に付与されるデータ。使用できるグループはこちらに記載しています：
-
Event groups
Keyword
Contentを中心とした、各ページに付与されたメタデータ 。各ページはPiano Insightのクローラによってクロールされ、Piano Insightのシステムにフィードされます。使用できるグループはこちらに記載しています：
-
Content profiles ページの "グループ名"の項
次の各Wikiページではコンテンツに追加のメタデータを付与する方法について解説しています
-
Document parsing ー コンテンツに情報を付記する方法
-
Custom taxonomies ー コンテンツにコンセプトタグを付与するためにカスタムタクソノミーを使用する方法
-
/profile/content/external/update ー コンテントプロファイルにサードパーティーの構造化データを付与するためのAPI
Custom
カスタムパラメータは各イベントに対して付加されるメタデータで、Piano Insightのトラッキングスクリプトにおいて、sendPageViewEvent() とともに setCustomParameters() を使用することによって与えることができます。
-
カスタムパラメータ
User
ユーザはイベントやコンテンツを消費する対象であるため、ユーザフィルタは上記のいずれかのグループに対してユーザの関わり方を絞るものです。
"engagement"フィルタは"frequency"（頻度）フィルタとも呼ばれ、指定の期間にユーザがどれだけある指標に対して関わりを持ったかを指定します。
例）過去30日間に2～6ヶ国に旅行したユーザ
"filters":[
{"type":"time", "start":"-30d", "filter":
{"type":"user", "having":
{ "type":"event", "group":"country", "min":2, "max":6 }
}
}
]
ここまではフィルタの種類について説明してきましたが、次に出力として得られる情報について説明します。
レスポンス側：出力フォーマット
各APIコールについては詳細の説明をこのwikiに掲載しています：
-
/traffic
-
最も基本的で集約されたデータ出力 (PV, UU, ActiveTime, ...)
-
-
/traffic/event
-
上記と同じイベントの指標を扱いますが、一つあるいは複数のeventグループのレベルを扱います
-
-
/traffic/keyword
-
上記と同じイベントの指標を扱いますが、一つあるいは複数のcontentグループのレベルを扱います
-
-
/traffic/custom
-
上記と同じイベントの指標を扱いますが、一つあるいは複数のcustomグループのレベルを扱います
-
-
/traffic/user
-
上記と同じイベントの指標を扱いますが、一つあるいは複数のuserグループのレベルを扱います
-
これらのAPIコールは応答のフォーマット、言い換えると興味の対象を制御するものです。
それぞれの /traffic API は異なる切り口と指標を扱うもので、フィルタ種別と同様に分類されています。
リクエストとレスポンスの例は Piano Insight API の各APIコールの説明のページをご参照ください。