分析API

分析画面で閲覧可能な情報を取得するためのAPI

リクエストヘッダー

リクエストヘッダーはこちらをご確認ください。

HTTPリクエスト
GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/aggregations?<query>
URLパラメータ
フィールド タイプ 説明 サンプル 必要性
merchant_id String マーチャントID nttsmc 必須
クエリパラメータ
フィールド タイプ 説明 サンプル
media_id String メディアID *****
target String 取得情報の種類 下表参照
interval String 取得期間の単位 下表参照
group String 取得情報の分類方法 下表参照
from String 取得開始日時 20180101000000
to String 取得終了日時 20181231235959
取得方法の種類(target)について
フィールド 説明
play_count 再生数(回)
device_count 端末数
session_count セッション数
play_time 再生時間(秒)
average_play_time 平均再生時間(秒)
player_count プレイヤー表示数(回)
key_delivery_count DRMキー取得数(回)

targetを省略した場合はデフォルト値のplay_countが適用される。

取得期間の単位(interval)について
フィールド 説明
month 月毎
day 日毎
hour 時間毎
minute 分毎

intervalを省略した場合はデフォルト値のdayが適用される。 DRMキー取得数のみ、時間毎、分毎の取得ができない。

取得情報の分類方法(group)について
フィールド 説明
all 統合
country 国別
player プレイヤー別
site サイト別
device デバイス別
os OS別
percentage 割合

groupを省略した場合はallが適用される。 DRMキー取得数のみ、all以外の取得ができない。

レスポンス
フィールド 説明
date 取得対象日時
group 取得情報の分類

レスポンスの例

HTTP/1.1 200 OK
{
  [
    {
      "date": "2018/12/01 14:34",
      "all": 10
    },
    {
      "date": "2018/12/01 14:35",
      "all": 12
    },
    ...
  ]
}