Documentation Powered by ReDoc

ULIZA Video Analytics (Cloud) API 仕様書 (v2.2.1)

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

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

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

注意

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

CHANGELOG

バージョン 改版日 改版内容
v2.0.0 2022/06/27 初版
v2.1.0 2022/10/04 a. リアルタイムアクティブユーザー数取得API、およびアクティブユーザー数取得APIのgroup_perパラメータにおいてcontent_nameの指定に対応
b. filtersパラメータのitemにcontent_nameを追加
c. コンテンツ名別視聴データ取得API、およびコンテンツ名・ユーザーID別視聴データ取得APIを追加
d. 視聴履歴取得APIのレスポンスにcontent_name(コンテンツ名)を追加
v2.2.0 2022/12/01 a. アクティブユーザー数取得APIを追加し、既存のアクティブユーザー数取得APIは非サポートのAPIに変更
v2.2.1 2023/5/01 a. 時間帯別視聴データ取得APIのgranularityパラメータにおいてweeklyの指定に対応
b. 視聴データ取得APIのdimensionsパラメータにおいてweekの指定に対応

Authentication

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

Authorization: Bearer <api-credential>

APILimits

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

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

Realtime

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

リアルタイムアクティブユーザー数取得API

リアルタイムアクティブユーザー数を取得します。

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "現在から15分前の日時（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で15分までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で15分までです。

sort
string
Default: "date_time|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • date_time：日時
group_per
string
Default: null

日時に加えて、結果を集計する際のグループを指定します。使用可能なグループ名は以下の通りです。例えば、content_titleを指定すると、日時、コンテンツタイトルごとのデータが取得できます。

  • content_name：コンテンツ名
  • content_title：コンテンツタイトル

Responses

Response Schema: application/json
Array of objects

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

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/realtime/user-counts?start=2022-06-27 13:00:00&end=2022-06-27 13:05:00'

Response samples

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

UserCounts

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

アクティブユーザー数取得API【 deprecated in v2.2.0 】

非サポートのAPIです。現在使用されている場合、代替の アクティブユーザー数取得API を使用して下さい。

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "現在から6時間前の日時（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "date_time|asc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • date_time：日時
group_per
string
Default: null

日時に加えて、結果を集計する際のグループを指定します。使用可能なグループ名は以下の通りです。例えば、content_titleを指定すると、日時、コンテンツタイトルごとのデータが取得できます。

  • content_name：コンテンツ名
  • content_title：コンテンツタイトル

Responses

Response Schema: application/json
Array of objects

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

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/user-counts/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

ActiveUsers

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

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

アクティブユーザー数を取得します。

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "date_time|asc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • date_time：時間帯
granularity
string
Default: "hourly"

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

  • minutely：分毎の粒度で集計した結果を返却します
  • hourly：時毎の粒度で集計した結果を返却します
filters
any

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン

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

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

Responses

Response Schema: application/json
Array of objects

日時別データ

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/active-users/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Datetime

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

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

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "date_time|asc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • date_time：時間帯
granularity
string
Default: "hourly"

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

  • hourly：時毎の粒度で集計した結果を返却します
  • daily：日毎の粒度で集計した結果を返却します
  • weekly：週毎の粒度（日曜日から土曜日までの区間毎）で集計した結果を返却します。
  • monthly：月毎の粒度で集計した結果を返却します
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

日時別データ

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/datetime/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Title

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

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

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

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

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/title/userid/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

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

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "content_title|asc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • content_title：コンテンツのタイトル
  • content_category：コンテンツのカテゴリ
  • content_type：コンテンツのタイプ
  • user_id：ユーザーID
engagement_bitmap_granularity
integer [ 1 .. 100 ]
Default: 20

視聴済フラグの結果を集計する粒度を指定します。例えば、20を指定した場合は、尺に対して20分割した位置ごとに集計されます。

filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

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

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/title/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

ContentName

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

コンテンツ名別視聴データ取得API

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

コンテンツ名別データ

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/title/userid/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

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

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "content_title|asc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • content_title：コンテンツのタイトル
  • content_category：コンテンツのカテゴリå
  • content_type：コンテンツのタイプ
  • user_id：ユーザーID
engagement_bitmap_granularity
integer [ 1 .. 100 ]
Default: 20

視聴済フラグの結果を集計する粒度を指定します。例えば、20を指定した場合は、尺に対して20分割した位置ごとに集計されます。

filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

コンテンツ名・ユーザーID別データ

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/title/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Category

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

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

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

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

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/category/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Userid

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

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

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • ad_impressions : 広告再生開始数
  • avg_play_percent : 平均視聴割合
  • avg_play_time : 平均視聴時間
  • player_impressions : 表示回数
  • play_requested_count : 再生開始数
  • play_started_count : 再生回数
  • total_play_time : 総視聴時間
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

ユーザーID別データ

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/userid/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Os

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

OS別視聴データ取得API

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

OS別データ

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/os/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Browser

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

ブラウザ別視聴データ取得API

ブラウザ別の視聴情報を取得します。

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

ブラウザ別データ

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/browser/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Site

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

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

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

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

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/site/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Region

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

地域別視聴データ取得API

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。使用可能なキー名は以下の通りです。

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

地域別データ

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/region/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

History

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

視聴履歴取得API

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

engagement_bitmap_granularity
integer [ 1 .. 100 ]
Default: 20

視聴済フラグの結果を集計する粒度を指定します。例えば、20を指定した場合は、尺に対して20分割した位置ごとに集計されます。

filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

視聴履歴

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/history?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Data

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

視聴データ取得API

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

limit
integer [ 1 .. 50000 ]
Default: 100

1回のリクエストで取得するデータの行数を指定します。

offset
integer >= 0
Default: 0

リクエスト時の指定によりソートされた結果の取得開始位置を指定します。

sort
string
Default: "play_requested_count|desc"

ソートする第1キーおよび方向（昇順ascまたは降順desc）を|で連結した文字列を指定します。第1キーにはmetricsと同一の文字列を指定してください。使用可能なキー名は以下の通りです。

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
dimensions
string
Default: "content_title"

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

  • date_time：日時（YYYY-MM-DD HH:MM:SS形式）
  • date_minute：日付と時分（YYYY-MM-DD HH:MM:00形式）
  • date_hour：日付と時間（YYYY-MM-DD HH:00:00形式）
  • date：日付（YYYY-MM-DD 00:00:00形式）
  • week：週（YYYY-MM-DD 00:00:00形式。日曜日から土曜日までの区間毎に集計されます）
  • year_month：年月（YYYY-MM-01 00:00:00形式）
  • hour_minute：時刻（HH:MM形式）
  • year：年（YYYY形式）
  • month：月（MM形式）
  • day：日（DD形式）
  • hour：時（HH形式）
  • minute：分（MM形式）
  • content_category： コンテンツカテゴリ
  • content_title：コンテンツタイトル
  • content_name：コンテンツ名
  • user_id：ユーザーID
  • os_name：OS名
  • browser_name：ブラウザ名
  • site：サイト
  • country：国
  • region：地域
metrics
string
Default: "play_requested_count"

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

  • ad_impressions：広告再生開始数
  • avg_play_percent：平均視聴割合
  • avg_play_time：平均視聴時間
  • player_impressions：表示回数
  • play_requested_count：再生開始数
  • play_started_count：再生回数
  • total_play_time：総視聴時間
  • impression_user_count：表示ユーザー数
  • user_count：視聴ユーザー数
filters
string<JSON>
Default: null

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

値は配列内に必ず文字列で指定してください。大文字小文字は区別されます。複数個指定した場合はORで結合されます。

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
user_id ユーザーID
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_type コンテンツタイプ
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・VOD
・LIVE
・DVR
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン
play_percent 視聴割合
一致方式にはequalsもしくはbetweenが指定できます。

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

{
  "os:equals":["Windows", "Android"],
  "content_title:contains":["news"],
  "play_percent:between":[["1", "94"]]
}

Responses

Response Schema: application/json
Array of objects

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

truncated
boolean

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

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Engagement

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

エンゲージメント情報取得API

VODコンテンツの再生位置別のエンゲージメント情報を取得します。

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

granularity
integer [ 1 .. 100 ]
Default: 20

エンゲージメント情報を取得するために使用する尺に対する値を指定します。例えば、20を指定した場合は、尺に対して20分割した位置ごとに集計されます。

filters
string<JSON>

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン

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

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

Responses

Response Schema: application/json
Array of objects

エンゲージメント情報

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/engagement/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Reaction

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

リアクション情報取得API

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

query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

granularity
integer [ 1 .. 100 ]
Default: 100

リアクション情報を取得するために使用する尺に対する値を指定します。例えば、100 を指定した場合は、尺に対して 100 分割した位置ごとにリアクションボタンの押下回数が集計されます。

filters
string<JSON>

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン

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

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

Responses

Response Schema: application/json
Array of objects

リアクション情報

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/reaction/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Situation

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

視聴状況情報取得API

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

path Parameters
parameter
required
string

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

  • playback_rate：コンテンツを視聴した際に使用された倍速値を取得します。
  • bitrate：コンテンツを視聴した際に使用されたビットレート（bps）を取得します。ビットレート切り替え機能を使用できない配信方式、およびブラウザでコンテンツを再生した場合は、nullが取得されます。
  • subtitle：コンテンツを視聴した際に使用された字幕を取得します。字幕機能を使用していないプレイヤーでコンテンツを再生した場合は、nullが取得されます。
  • cast：コンテンツを視聴した際のキャスト（AirPlay、GoogleCast、もしくはOFF）を取得します。
  • screen_type：コンテンツを視聴した際のスクリーンタイプ（インライン、フルスクリーン、もしくはピクチャーインピクチャー）を取得します。
  • is_background：コンテンツを視聴した際のバックグラウンド状態（trueはバックグラウンド、falseはフォアグラウンド）を取得します。
query Parameters
start
string <yyyy-mm-dd hh:mm:ss>
Default: "本日から30日前の00時00分00秒（日本時間）"

データを取得する期間の開始日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

end
string <yyyy-mm-dd hh:mm:ss>
Default: "現在の日時（日本時間）"

データを取得する期間の終了日を日本時間で指定します。1回のリクエストで取得できるデータの取得期間は最大で13か月までです。

granularity
integer [ 1 .. 100 ]
Default: 20

視聴状況情報を取得するために使用する尺に対する値を指定します。例えば、20を指定した場合は、尺に対して20分割した位置ごとに集計されます。

filters
string<JSON>

データの詳細絞り込み条件をJSON形式の文字列で指定します（値はURLエンコードする必要があります）。条件として、項目名、一致方式、値を以下のように1つのkey-value形式で指定することでデータの絞り込みができます。 複数の条件を指定した場合の各条件はANDで結合されます。ただし、同じ項目名を使用した条件を複数指定することはできません。

"<項目名>:<一致方式>":"<値>"

使用可能な一致方式は以下の通りです。

  • equals：完全一致
  • contains：部分一致
  • starts_with：前方一致
  • ends_with：後方一致
  • matches：正規表現に一致
  • between：範囲に一致。配列として指定する値の中に、第一要素にAを、第二要素にBを指定した配列を作ることで、A以上B以下の範囲のデータを絞り込むことができます。

使用可能な項目名は以下の通りです。 一致方式に関する記載のない項目はbetween以外が指定できます。

項目名
 説明
hour 時間帯
一致方式にはequalsのみ指定でき、値には00 - 23を文字列で指定してください。
content_category コンテンツカテゴリ
content_name コンテンツ名
content_title コンテンツタイトル
content_format 配信フォーマット
一致方式にはequalsのみ指定でき、値には以下が指定できます。
・MP4
・HLS
・DASH
os_name OS名
browser_name ブラウザ名
region 地域
site 配信したサイトのドメイン、もしくはアプリ名
player_name プレイヤー名
player_version プレイヤーのバージョン

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

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

Responses

Response Schema: application/json
Array of objects

視聴状況情報

Request samples 

curl \
-H 'Authorization: Bearer <your-token>' \
'https://analytics-api.p.uliza.jp/v2/situation/bitrate/data?start=2022-06-27 00:00:00&end=2022-06-27 23:59:59'

Response samples

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

Error Codes

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

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