Documentation Powered by ReDoc

ULIZA Video Analytics (Basic) API 仕様書 (v1.3.0)

本書は ULIZA Video Analytics (Basic) が提供する API 仕様について記述しています。ULIZA Video Analytics (Basic) の管理画面の操作方法については ULIZA Video Analytics (Basic) User Guide を参照してください。

レスポンスの時間が長く、408 Request Timeout が返却された場合は、データの取得期間および取得件数を小さくするか、時間をおいてから API を実行してください。

なお、本書に掲載しているコードサンプル（Request samples）は、具体的な実装例を示すことで開発者を支援することを目的としていますが、掲載しているコードがすべての環境において正常に動作することを保証するものではありませんまた、コードサンプル内で使用している関数やライブラリの安全性に関して、弊社は何ら責任を負うものではありません。

注意

本書に記述している API を利用するには、対応するオプション（「ULIZA FLEX II - マルチ WebAPI オプション」など）のご契約が必要となります。詳細については お問い合わせ ください。

CHANGELOG

バージョン 改版日 改版内容
v1.0.0 2020/10/30 初版
v1.0.1 2020/11/18 a. サービス利用制限の仕様を 1 時間あたりの WebAPI 実行可能数から 1 分あたりの WebAPI 実行可能数に変更
v1.1.0 2021/01/27 a. 視聴状況情報取得 API を追加
v1.2.0 2021/06/09 a. アクティブユーザー数取得 API のレスポンスに titles (コンテンツタイトル別のアクティブユーザー数) を追加
b. コンテンツタイトル・ユーザー ID 別視聴データ取得 API を追加
v1.3.0 2021/09/29 a. 時間帯別視聴データ取得 API、コンテンツカテゴリ別視聴データ取得 API、コンテンツタイトル別視聴データ取得 API、OS別視聴データ取得 API、視聴環境別視聴データ取得 API、配信サイト/アプリ別視聴データ取得 API、地域別視聴データ取得 API、視聴データ取得 API のレスポンスに show_count (表示回数) および show_user_count (表示ユーザー数) を追加
b. コンテンツタイトル・ユーザー ID 別視聴データ取得 API、ユーザー ID 別視聴データ取得 API、視聴履歴取得 API のレスポンスに show_count (表示回数) を追加
c. filters パラメータの item に player_version を追加

Authentication

特に断りのない限り、本書に記載されている全ての API に対するリクエストの Authorization ヘッダに下記の形式で有効な API 認証キーを含める必要があります。API 認証キーの取得方法については ULIZA プロダクトアカウント User Guide を参照してください。リクエストに有効な API 認証キーが含まれていない場合は、401 Unauthorized が返却されます。

Authorization: Bearer <api-credential>

API Limits

特に断りのない限り、本書に記載されている全ての API に対して、ULIZA プロダクトアカウントごとに、下記のサービス利用制限が設けられます。制限を超えて API を実行した場合は、429 Too Many Requests が返却されます。

サービス利用制限 制限値
1 分あたりの WebAPI 実行可能数 3
1 ヶ月あたりの WebAPI 実行可能数 50,000
同時 WebAPI 実行可能数 1

Realtime

リアルタイムデータ取得系 API について以下に記述します。

アクティブユーザー数取得 API

アクティブユーザー数を取得します。この API は、LIVE コンテンツの再生を集計する設定がされている場合のみ使用できます。また、この API は、1 ヶ月あたりの WebAPI 実行可能数 のみ制限され、他の制限は受けません。 Authorization ヘッダに有効な API 認証キーを含めず、login_id のクエリパラメータを指定してください。

query Parameters
login_id
required
string <= 30 characters [0-9a-zA-Z-_]+@[0-9a-zA-Z-_]+$

集計対象のログイン ID を指定します。

minutes
integer [ -360 .. -1 ]

データを取得する期間の開始時刻を現在の ～ 分前表記 (-X 分) で指定します。指定した時刻から現在の 1 分前までの取得可能なデータを全て返します。このクエリパラメータを指定しない場合は、指定した時刻から現在の 1 分前までの取得可能な最新のデータのみを返します。ただし、現在とは API を実行した時刻を指します。

sort_key
string
Default: "hour_minute"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • hour_minute ： 時刻
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC

Responses

Response Schema: application/json
Array of objects

アクティブユーザー数データ

Request samples 

curl \
'https://analytics-api.p.uliza.jp/v1/realtime/user-counts?login_id=admin@sample'

Response samples

Content type
application/json
{
  • "data":
    [
    ]
}

Datetime

視聴データ取得系 API について以下に記述します。

時間帯別視聴データ取得 API

時間帯別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
granularity
string
Default: "hourly"

結果を集計する粒度を指定します。使用可能な粒度名は以下の通りです。

  • monthly : 月毎の粒度で集計した結果を返却します
  • daily : 日毎の粒度で集計した結果を返却します
  • hourly : 時毎の粒度で集計した結果を返却します
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

日時別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/datetime/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Category

視聴データ取得系 API について以下に記述します。

コンテンツカテゴリ別視聴データ取得 API

コンテンツカテゴリ別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

コンテンツカテゴリ別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/category/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Title

視聴データ取得系 API について以下に記述します。

コンテンツタイトル別視聴データ取得 API

コンテンツタイトル別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

コンテンツタイトル別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/title/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

コンテンツタイトル・ユーザー ID 別視聴データ取得 API

コンテンツタイトル、ユーザー ID 別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "content_category"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合はsort_keyとsort_orderを必ず両方指定してください。

  • content_category : 視聴したコンテンツのカテゴリ
  • content_title : 視聴したコンテンツのタイトル
  • content_type : 視聴したコンテンツのタイプ
  • user_id : 視聴したユーザーID
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

コンテンツタイトル・ユーザー ID 別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/title/userid/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Userid

視聴データ取得系 API について以下に記述します。

ユーザーID別視聴データ取得 API

ユーザーID別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合はsort_keyとsort_orderを必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

ユーザーID別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/userid/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Os

視聴データ取得系 API について以下に記述します。

OS別視聴データ取得 API

OS別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

OS別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/os/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Environment

視聴データ取得系 API について以下に記述します。

視聴環境別視聴データ取得 API

視聴環境別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

視聴環境別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/environment/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Site

視聴データ取得系 API について以下に記述します。

配信サイト/アプリ別視聴データ取得 API

配信サイト/アプリ別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

配信サイト/アプリ別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/site/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Region

視聴データ取得系 API について以下に記述します。

地域別視聴データ取得 API

地域別の視聴情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

地域別データ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/region/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

History

視聴データ取得系 API について以下に記述します。

視聴履歴取得 API

コンテンツの全ての視聴履歴を取得します。視聴履歴は指定した期間における新しい順にデータが返却されます。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

視聴履歴

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/history?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Data

視聴データ取得系 API について以下に記述します。

視聴データ取得 API

指定されたディメンション別のメトリクス情報を取得します。ディメンションは集計対象の項目を指し、メトリクスはディメンションごとに集計された結果の数値を指します。例えば、ディメンションにコンテンツタイトル、メトリクスに再生開始数を指定するとコンテンツタイトル別の再生開始数のデータを取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目から取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。1 回のリクエストで取得できるデータの最大件数は 5,000 件です。

sort_key
string
Default: "playback_count"

ソートの第 1 キーを指定します。 metrics と同一の文字列を指定してください。使用可能なキー名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
sort_order
string
Default: "DESC"

第 1 キーでのソート順を指定します。使用可能な順序名は以下の通りです。 ソート順を指定する場合は sort_key と sort_order を必ず両方指定してください。

  • ASC
  • DESC
dimensions
string
Default: "content_title"

取得するデータのディメンションを指定します。使用可能なディメンションは以下の通りです。 取得するデータの種類を指定する場合は dimensions と metrics を必ず両方指定してください。

  • date_time : 日時（YYYY-MM-DD HH:MM形式）
  • date_hour : 日付と時間（YYYY-MM-DD HH形式）
  • date : 日付（YYYY-MM-DD形式）
  • year_month : 年月（YYYY-MM形式）
  • hour_minute : 時刻（HH:MM形式）
  • year : 年（YYYY形式）
  • month : 月（MM形式）
  • day : 日（DD形式）
  • hour : 時（HH形式）
  • minute : 分（MM形式）
  • content_category : コンテンツカテゴリ
  • content_title : コンテンツタイトル
  • user_id : ユーザーID
  • os : 視聴したOS
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）
  • site : 視聴したサイト
  • country : 視聴した国
  • region : 視聴した地域
metrics
string
Default: "playback_count"

取得するデータのメトリクスを指定します。使用可能なメトリクスは以下の通りです。 取得するデータの種類を指定する場合は dimensions と metrics を必ず両方指定してください。

  • ad_playback_count : 広告再生開始数
  • avg_played_percent : 平均視聴割合
  • avg_played_time : 平均視聴時間
  • avg_staytime : 平均滞在時間
  • error_count :　エラー回数
  • show_count : 表示回数
  • playback_count : 再生開始数
  • play_count :　再生回数
  • total_played_time :　総視聴時間
  • total_staytime : 総滞在時間
  • show_user_count :　表示ユーザー数
  • user_count :　視聴ユーザー数
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数のオブジェクトを指定した場合の各条件は AND で結合されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、 value は 00 - 23 を文字列で指定します。
  • user_id : ユーザーIDを指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • content_type: コンテンツタイプを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • VOD
    • LIVE
    • DVR
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • play_status : 視聴状況を指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • unviewed : 視聴割合が 0% の VOD コンテンツの再生セッションのみに絞り込みます。
    • partial : 視聴割合が 1% から 94% の VOD コンテンツの再生セッションのみに絞り込みます。
    • complete : 視聴割合が 95% 以上の VOD コンテンツの再生セッションのみに絞り込みます。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

クエリパラメー dimensions と metrics で指定したデータ

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/data?start_interval=-30&end_interval=-1&start_with=1&end_with=100'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Engagement

視聴データ取得系 API について以下に記述します。

視聴率情報取得 API

VODコンテンツの再生位置別の視聴率情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

APIの仕様もしくはリクエスト時の指定によりソートされた結果の視聴率情報の配列内の 1 要素を 1 件として上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。 start_with と end_with の指定により 1 回のリクエストで取得できるデータの最大件数は 100 件です。

end_with
integer >= 1
Default: 100

APIの仕様もしくはリクエスト時の指定によりソートされた結果の視聴率情報の配列内の 1 要素を 1 件として上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。 start_with と end_with の指定により 1 回のリクエストで取得できるデータの最大件数は 100 件です。

filters
string<JSON>

コンテンツの詳細検索条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数個指定した場合の各条件は AND で結合されます。各キーが指定した値に完全一致するコンテンツのみが返却されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、valueは 00 - 23 を文字列で指定します。
  • user_id : ユーザーID を指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • audience_granularity : 視聴率情報を取得するために使用する尺に対する視聴率情報収集粒度を指定します。この item を指定した場合は、 value は 1 - 100 を文字列で指定します。

value は配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

condition に指定できる文字列は以下です。

  • equals : 完全一致。
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

視聴率情報

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/engagement/audience-rating/data?start_interval=-30&end_interval=-1'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

リアクション情報取得 API

VODコンテンツの再生位置別のリアクション情報を取得します。

query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果のリアクション情報の配列内の 1 要素を 1 件として上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。 1 回のリクエストで取得できるデータの最大件数は 100 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果のリアクション情報の配列内の 1 要素を 1 件として上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。 1 回のリクエストで取得できるデータの最大件数は 100 件です。

group_per
string
Default: "id"

結果を集計する際のグループを指定します。使用可能なグループ名は以下の通りです。

  • label : ボタンラベル毎に結果を集計します。
  • id : ボタンID 毎に結果を集計します。
filters
string<JSON>

データの詳細絞り込み条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数個指定した場合の各条件は AND で結合されます。各キーが指定した値に完全一致するコンテンツのみが返却されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、valueは 00 - 23 を文字列で指定します。
  • user_id : ユーザーID を指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、 condition には equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • reaction_granularity : リアクション情報を取得するために使用する尺に対するリアクション情報収集粒度を指定します。この item を指定した場合は、 value は 1 - 200 を文字列で指定します。

valueは配列内に必ず文字列で指定してください。大文字小文字は区別されます。condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

conditionに指定できる文字列は以下です。

  • equals : 完全一致
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

リアクション情報

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/engagement/reaction/data?startInterval=-30&endInterval=-1'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Situation

視聴データ取得系 API について以下に記述します。

視聴状況情報取得 API

VODコンテンツの再生位置別の視聴状況情報を取得します。

path Parameters
parameter
required
string

取得したい視聴状況情報を以下から選択して指定してください。

  • playback_rate : コンテンツを視聴した際に使用された倍速値を取得します。
  • bitrate : コンテンツを視聴した際に使用されたビットレート（bps）を取得します。ビットレート切り替え機能を使用できない配信方式、および再生環境でコンテンツを再生した場合は、「null」が取得されます。
  • subtitle : コンテンツを視聴した際に使用された字幕を取得します。字幕機能を使用していないプレイヤーでコンテンツを再生した場合は、「undefined」が取得されます。
  • screen_status : コンテンツを視聴した際のスクリーン状態（インライン、もしくはフルスクリーン）を取得します。
  • playback_status : コンテンツを視聴した際の再生状態（フォアグラウンド、もしくはバックグラウンド）を取得します。ULIZA Player (HTML5) でコンテンツを再生した場合は、「undefined」が取得されます。
query Parameters
start_interval
integer [ -731 .. 0 ]
Default: -30

データを取得する期間の開始日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

end_interval
integer [ -731 .. 0 ]
Default: -1

データを取得する期間の終了日を ～ 日前表記 (-X日) で指定します。 期間を指定する場合は start_interval と end_interval を必ず両方指定してください。1 回のリクエストで取得できるデータの取得期間は最大で 3 か月までです。

start_with
integer >= 1
Default: 1

API の仕様もしくはリクエスト時の指定によりソートされた結果の視聴状況情報の配列内の 1 要素を 1 件として上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。 1 回のリクエストで取得できるデータの最大件数は 100 件です。

end_with
integer >= 1
Default: 100

API の仕様もしくはリクエスト時の指定によりソートされた結果の視聴状況情報の配列内の 1 要素を 1 件として上位何件目まで取得するかを指定します。 件数を指定する場合は start_with と end_with を必ず両方指定してください。 1 回のリクエストで取得できるデータの最大件数は 100 件です。

filters
string<JSON>

コンテンツの詳細検索条件を JSON 形式の文字列で指定します（値は URL エンコードする必要があります）。以下の 3 つのキーを指定したオブジェクトを配列内に記載してください。配列に複数個指定した場合の各条件は AND で結合されます。各キーが指定した値に完全一致するコンテンツのみが返却されます。

  • item ： 絞り込む項目名
  • value ： 絞り込む値
  • condition ： 絞り込む方式

itemに指定できる文字列は以下です。

  • hour : 時間帯を指定します。この item を指定した場合は、valueは 00 - 23 を文字列で指定します。
  • user_id : ユーザーID を指定します。
  • content_category ： コンテンツカテゴリを指定します。
  • content_title ： コンテンツタイトルを指定します。
  • delivery_format ： 配信フォーマットを指定します。この item を指定した場合は、conditionには equals のみ指定でき、 value には以下が指定できます。
    • MP4
    • HLS
    • DASH
  • os : 視聴した OS を指定します。
  • playback_env : 視聴した環境（ブラウザ/アプリケーション名）を指定します。
  • region : 視聴した地域を指定します。
  • site : 視聴したサイトのドメインを指定します。
  • player_name : 視聴したプレイヤーを指定します。
  • player_version : 視聴したプレイヤーバージョンを指定します。
  • audience_granularity : 視聴率情報を取得するために使用する尺に対する視聴率情報収集粒度を指定します。この item を指定した場合は、 value は 1 - 100 を文字列で指定します。

value は配列内に必ず文字列で指定してください。大文字小文字は区別されます。 condition が equals の場合のみ複数個指定でき、複数個指定した場合は OR で結合されます。

condition に指定できる文字列は以下です。

  • equals : 完全一致。
  • contains ： 部分一致
  • starts_with ： 前方一致
  • ends_with ： 後方一致
  • matches : 正規表現に一致

例えば、OSが「Windows」もしくは「Android」で視聴されたコンテンツタイトルに「news」を含むコンテンツの視聴履歴を取得するには、以下の JSON 形式の文字列を URL エンコードした値を指定します。

[
{
  "item": "os",
  "value": ["Windows", "Android"],
  "condition": "equals"
},
{
  "item": "content_title",
  "value": ["news"],
  "condition": "contains"
}
]

Responses

Response Schema: application/json
Array of objects

視聴状況情報

golden
boolean

返却されたデータが全て確定データであるか否か

truncated
boolean

返却されたデータが全件ではない（以降の行が存在する）か否か

unsampled
boolean

返却されたデータが全て非サンプリングデータであるか否か

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v1/situation/data/playback_rate?startInterval=-30&endInterval=-1'

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "golden": true,
  • "truncated": true,
  • "unsampled": true
}

Error Codes

すべてのエラーレスポンスにはエラーの種類を示すエラーコードが与えられます。返却されうるエラーコードの一覧とそれぞれの意味は下表の通りです。

エラーコード 原因となる操作 意味
INVALID_REQUEST すべての操作 不正なリクエスト形式
METHOD_NOT_ALLOWED すべての操作 指定されたリクエストメソッドが存在しない
MODEL_NOT_FOUND すべての操作 指定したリソースが見つからない
REQUEST_UNAUTHORIZED すべての操作 認証エラーまたは認可されていないリクエスト
REQUEST_TIMEOUT すべての操作 タイムアウトになったリクエスト
TOO_MANY_REQUESTS すべての操作 サービス利用制限を超えたリクエスト
UNKNOWN_ERROR すべての操作 サーバ内部エラー