メインコンテンツへスキップ

ユーザ別視聴解析

キーリスト取得

概要

ユーザ別視聴解析内のキーリストを取得するAPIです。


API URL

https://api-analytics.stream.jp/analysis/getKeyList


リクエスト通信仕様

  • プロトコル：POST
  • Content-Type : application/json

■パラメータ

No. 項目名 必須 説明 属性 形式 備考
1 from_date ○ 集計期間開始日時 string Y-m-d H:i:s  
2 to_date ○ 集計期間終了日時 string Y-m-d H:i:s  
3 sort   ソート string 1文字以上〜 レスポンスの項目名にマイナス（-）をつけると降順となる
例）-key
4 target ○ 集計対象 int 1-3 1:VOD/2:ライブ/3:疑似ライブ
5 page_size ○ 1ページ当たりのログレコード数 int 1〜100  
6 page_number ○ 該当のページ番号 int 1〜2147483647  

 

■リクエストサンプル

{
   "from_date":"2023-01-01 00:00:00",
   "to_date":"2023-12-31 23:59:59",
   "sort":"-key",
   "target":1,
   "page_size":100,
   "page_number":1
}

 

レスポンス通信仕様

  • Content-Type : application/json

■パラメータ

No. 項目名 説明 属性 備考
1 response_code レスポンスコード int 成功時は0
エラー時は9
2 count レコード数 int 検索条件に一致するトータルレコード件数
3 key_list 任意パラメータkey名一覧 array  
  key コンバージョン名 string 任意パラメータkey名
ソート指定可能

 

■レスポンスサンプル

{
    "count": 2,
    "key_list": [
      {
          "key": "user_id"
       },
       {
          "key": "eq"
       }
    ],
    "response_code": 0
}

 

■レスポンスサンプル（エラー時）　入力パラメータに誤りがある場合

{
  "title": "認証エラー",
  "body": "利用できない機能です。"
}

 

オンデマンド動画管理画面データ一覧取得

概要

管理画面のユーザー別視聴解析＞オンデマンド動画に表示されている値を取得するAPIです。

 

対象画面

ユーザー別視聴解析＞オンデマンド動画

 

API URL

https://api-analytics.stream.jp/analysis/getInfoListVod


リクエスト通信仕様

  • プロトコル：POST
  • Content-Type : application/json

■パラメータ

No. 項目名 必須 説明 属性 形式 備考
1 from_date ○ 集計期間開始日時 string Y-m-d H:i:s  
2 to_date ○ 集計期間終了日時 string Y-m-d H:i:s  
3 key ○ 任意パラメータkey名 string 1〜64文字  
4 type 〇 集計方法 int 1～4 1:分別
2:日別
3:月別
4:全体
5 sort   ソート string 1文字以上 レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count
6 page_size ○ 1ページ当たりのログレコード数 int 1〜100  
7 page_number ○ 該当のページ番号 int 1〜2147483647  


■リクエストサンプル

{
  "from_date": "2023-01-01 00:00:00",
  "to_date": "2023-01-01 23:59:59",
  "key" : "type",
  "type" : 1,
  "sort" : "view_count",
  "page_size": 1,
  "page_number": 1
}

 

レスポンス通信仕様

  • Content-Type : application/json

■パラメータ

No. 項目名 説明 属性 備考
1 response_code レスポンスコード int 成功時は0
エラー時は9
2 info_list ユーザー別視聴解析一覧 array  
  from_date 絞り込みの開始期間 string  
to_date 絞り込みの終了期間 string  
option_value 任意パラメータ値 string  
mid 動画ID int ソート指定可能
title 動画タイトル string  
duration 動画時間 string ソート指定可能
view_count 表示回数 int ソート指定可能
play_count 再生回数 int ソート指定可能
audience_rating 視聴率 string

小数点第3位まで（第4位を切り捨て）

ソート指定可能
play_rate 再生率 string

小数点第3位まで（第4位を切り捨て）

ソート指定可能
play_completion_rate 再生完了率 float

小数点第3位まで（第4位を切り捨て）

ソート指定可能
average_play_time 平均再生時間 float

小数点切り捨て

ソート指定可能
date 集計期間 string

type=1,2,3の時のみ返却される

  • 分別
    'YYYY/MM/DD HH24:MI:SS'
  • 日別
    'YYYY/MM/DD'
  • 月別
    'YYYY/MM'
3 count レコード数 int  

 

■レスポンスサンプル

{
  "info_list": [
    {
      "from_date" : "2023-01-01 00:01:00",
      "to_date": "2025-03-31 23:59:59",
     "date": "2023/04/02 12:03:00",
      "key" : "type",
      "option_value" : "研修",
      "mid": 2,
      "title": "研修動画",
      "duration": 100,
      "view_count": 0,
      "play_count": 0,
      "audience_rating": "0.0000",
      "play_rate": "0.0000",
      "play_completion_rate": "0.0000",
      "average_play_time": "0.00",
    },
  ],
  "count" : 1,
  "response_code": 0
}

 

ライブ管理画面データ一覧取得

概要

管理画面のユーザー別視聴解析＞ライブに表示されている値を取得するAPIです。

 

対象画面

ユーザー別視聴解析＞ライブ

 

API URL

https://api-analytics.stream.jp/analysis/getInfoListLive


リクエスト通信仕様

  • プロトコル：POST
  • Content-Type : application/json

■パラメータ

No. 項目名 必須 説明 属性 形式 備考
1 from_date ○ 集計期間開始日時 string Y-m-d H:i:s  
2 to_date ○ 集計期間終了日時 string Y-m-d H:i:s  
3 key ○ 任意パラメータkey名 string 1〜64文字  
4 type 〇 集計方法 int 1～4 1:分別
2:日別
3:月別
4:全体
5 sort   ソート string 1文字以上 レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count
6 page_size ○ 1ページ当たりのログレコード数 int 1〜100  
7 page_number ○ 該当のページ番号 int 1〜2147483647  


■リクエストサンプル

{
  "from_date": "2023-01-01 00:00:00",
  "to_date": "2023-01-01 23:59:59",
  "key" : "type",
  "type" : 1,
  "sort" : "view_count",
  "page_size": 1,
  "page_number": 1
}

 

レスポンス通信仕様

  • Content-Type : application/json

■パラメータ

No. 項目名 説明 属性 備考
1 response_code レスポンスコード int 成功時は0
エラー時は9
2 info_list ユーザー別視聴解析一覧 array  
  from_date 絞り込みの開始期間 string  
to_date 絞り込みの終了期間 string  
option_value 任意パラメータ値 string  
lpid ライブ設定ID int ソート指定可能
leid ライブイベントID  int ソート指定可能
title ライブイベント名  string  
duration 動画時間 string ソート指定可能
view_count 表示回数 int ソート指定可能
play_count 再生回数 int ソート指定可能
audience_rating 視聴率 string

小数点第3位まで（第4位を切り捨て）

ソート指定可能
play_rate 再生率 string

小数点第3位まで（第4位を切り捨て）

ソート指定可能
play_completion_rate 再生完了率 float

小数点第3位まで（第4位を切り捨て）

ソート指定可能
average_play_time 平均再生時間 float

小数点切り捨て

ソート指定可能
date 集計期間 string

type=1,2,3の時のみ返却される

  • 分別
    'YYYY/MM/DD HH24:MI:SS'
  • 日別
    'YYYY/MM/DD'
  • 月別
    'YYYY/MM'
3 count レコード数 int  

 

■レスポンスサンプル

{
  "info_list": [
    {
      "from_date" : "2023-01-01 00:01:00",
      "to_date": "2025-03-31 23:59:59",
     "date": "2023/04/02 12:03:00",
      "key" : "type",
      "option_value" : "研修",
      "lpid": 1,
      "leid": 1,
      "title": "研修ライブ",
      "duration": 100,
      "view_count": 0,
      "play_count": 0,
      "audience_rating": "0.0000",
      "play_rate": "0.0000",
      "play_completion_rate": "0.0000",
      "average_play_time": "0.00",
    },
  ],
  "count" : 1,
  "response_code": 0
}

 

疑似ライブ管理画面データ一覧取得

概要

管理画面のユーザー別視聴解析＞疑似ライブに表示されている値を取得するAPIです。

 

対象画面

ユーザー別視聴解析＞疑似ライブ

 

API URL

https://api-analytics.stream.jp/analysis/getInfoListVlive


リクエスト通信仕様

  • プロトコル：POST
  • Content-Type : application/json

■パラメータ

No. 項目名 必須 説明 属性 形式 備考
1 from_date ○ 集計期間開始日時 string Y-m-d H:i:s  
2 to_date ○ 集計期間終了日時 string Y-m-d H:i:s  
3 key ○ 任意パラメータkey名 string 1〜64文字  
4 type 〇 集計方法 int 1～4 1:分別
2:日別
3:月別
4:全体
5 sort   ソート string 1文字以上 レスポンスの項目名にマイナス（-）をつけると降順となる
例）-view_count
6 page_size ○ 1ページ当たりのログレコード数 int 1〜100  
7 page_number ○ 該当のページ番号 int 1〜2147483647  


■リクエストサンプル

{
  "from_date": "2023-01-01 00:00:00",
  "to_date": "2023-01-01 23:59:59",
  "key" : "type",
  "type" : 1,
  "sort" : "view_count",
  "page_size": 1,
  "page_number": 1
}

 

レスポンス通信仕様

  • Content-Type : application/json

■パラメータ

No. 項目名 説明 属性 備考
1 response_code レスポンスコード int 成功時は0
エラー時は9
2 info_list ユーザー別視聴解析一覧 array  
  from_date 絞り込みの開始期間 string  
to_date 絞り込みの終了期間 string  
option_value 任意パラメータ値 string  
flpid 疑似ライブ設定ID int ソート指定可能
title 疑似ライブ設定名  string  
duration 動画時間 string ソート指定可能
view_count 表示回数 int ソート指定可能
play_count 再生回数 int ソート指定可能
audience_rating 視聴率 string

小数点第3位まで（第4位を切り捨て）

ソート指定可能
play_rate 再生率 string

小数点第3位まで（第4位を切り捨て）

ソート指定可能
play_completion_rate 再生完了率 float

小数点第3位まで（第4位を切り捨て）

ソート指定可能
average_play_time 平均再生時間 float

小数点切り捨て

ソート指定可能
date 集計期間 string

type=1,2,3の時のみ返却される

  • 分別
    'YYYY/MM/DD HH24:MI:SS'
  • 日別
    'YYYY/MM/DD'
  • 月別
    'YYYY/MM'
3 count レコード数 int  

 

■レスポンスサンプル

{
  "info_list": [
    {
      "from_date" : "2023-01-01 00:01:00",
      "to_date": "2025-03-31 23:59:59",
     "date": "2023/04/02 12:03:00",
      "key" : "type",
      "option_value" : "研修",
      "flpid": 1,
      "title": "研修動画",
      "duration": 100,
      "view_count": 0,
      "play_count": 0,
      "audience_rating": "0.0000",
      "play_rate": "0.0000",
      "play_completion_rate": "0.0000",
      "average_play_time": "0.00",
    },
  ],
  "count" : 1,
  "response_code": 0
}

 

オンデマンド動画データ一覧取得

概要

※旧VAでCSVファイル取得機能を利用していたお客様向けの機能です。

ユーザー別視聴解析で取得したオンデマンド動画に関する値を取得するAPIです。
旧VAで存在していたCSVファイル取得機能の代替となるAPIとなり、リクエストをvalue値で設定可能です。

 

API URL

https://api-analytics.stream.jp/analysis/getRecordListVod


リクエスト通信仕様

  • プロトコル：POST
  • Content-Type : application/json

■パラメータ

No. 項目名 必須 説明 属性 形式 備考
1 from_date ○ 集計期間開始日時 string Y-m-d H:i:s  
2 to_date ○ 集計期間終了日時 string Y-m-d H:i:s  
3 type 〇 集計方法 int 1～4 1:分別
2:日別
3:月別
4:全体
4 key   検索対象キー string 1文字以上  
5 value   検索対象バリュー string 1文字以上  
6 page_size ○ 1ページ当たりのログレコード数 int 1〜100  
7 page_number ○ 該当のページ番号 int 1〜  


■リクエストサンプル

{
  "from_date": "2023-01-01 00:00:00",
  "to_date": "2023-01-01 23:59:59",
  "key" : "type",
  "value" : "研修",
  "type" : 1,
  "target" : 1,
  "page_size": 1,
  "page_number": 1
}

 

レスポンス通信仕様

  • Content-Type : application/json

■パラメータ

No. 項目名 説明 属性 備考
1 response_code レスポンスコード int 成功時は0
エラー時は9
2 count レコード数 int  
3 record_list ユーザー別視聴解析一覧 array  
  date 集計日時 string 集計方法が「4:全体」の場合は未設定
key カスタム解析Key string  
value カスタム解析変数値 string  
mid 動画ID int  
title 動画タイトル string  
duration 動画時間 int  
view_count 表示回数 int  
play_count 再生回数 int  
audience_rating 視聴率 float 小数点第3位まで（第4位を切り捨て）
play_rate 再生率 float 小数点第3位まで（第4位を切り捨て）
play_completion_rate 再生完了率 float 小数点第3位まで（第4位を切り捨て）
average_play_time 平均再生時間 int 小数点切り捨て

 

■レスポンスサンプル

{
  "count" : 1000,
  "record_list": [
    {
      "date" : "2023-01-01 00:01:00",
      "key" : "type",
      "value" : "研修",
      "mid": 34,
      "title": "研修動画",
      "duration": 100,
      "view_count": 0,
      "play_count": 0,
      "audience_rating": "0.000",
      "play_rate": "0.0000",
      "play_completion_rate": "0.000",
      "average_play_time": "0",
    },
  ],
  "response_code": 0
}

 

ライブデータ一覧取得

概要

※旧VAでCSVファイル取得機能を利用していたお客様向けの機能です。

ユーザー別視聴解析で取得したライブに関する値を取得するAPIです。
旧VAで存在していたCSVファイル取得機能の代替となるAPIとなり、リクエストをvalue値で設定可能です。

 

API URL

https://api-analytics.stream.jp/analysis/getRecordListLive


リクエスト通信仕様

  • プロトコル：POST
  • Content-Type : application/json

■パラメータ

No. 項目名 必須 説明 属性 形式 備考
1 from_date ○ 集計期間開始日時 string Y-m-d H:i:s  
2 to_date ○ 集計期間終了日時 string Y-m-d H:i:s  
3 type 〇 集計方法 int 1～4 1:分別
2:日別
3:月別
4:全体
4 key   検索対象キー string 1文字以上  
5 value   検索対象バリュー string 1文字以上  
6 page_size ○ 1ページ当たりのログレコード数 int 1〜100  
7 page_number ○ 該当のページ番号 int 1〜  


■リクエストサンプル

{
  "from_date": "2023-01-01 00:00:00",
  "to_date": "2023-01-01 23:59:59",
  "key" : "type",
  "value" : "研修",
  "type" : 1,
  "target" : 1,
  "page_size": 1,
  "page_number": 1
}

 

レスポンス通信仕様

  • Content-Type : application/json

■パラメータ

No. 項目名 説明 属性 備考
1 response_code レスポンスコード int 成功時は0
エラー時は9
2 count レコード数 int  
3 record_list ユーザー別視聴解析一覧 array  
  date 集計日時 string 集計方法が「4:全体」の場合は未設定
key カスタム解析Key string  
value カスタム解析変数値 string  
lpid ライブ設定ID int  
leid ライブイベントID int  
title ライブイベント名 string  
duration 配信時間 int  
view_count 表示回数 int  
play_count 再生回数 int  
audience_rating 視聴率 float 小数点第3位まで（第4位を切り捨て）
play_rate 再生率 float 小数点第3位まで（第4位を切り捨て）
play_completion_rate 再生完了率 float 小数点第3位まで（第4位を切り捨て）
average_play_time 平均再生時間 int 小数点切り捨て

 

■レスポンスサンプル

{
  "count" : 1000,
  "record_list": [
    {
       "date" : "2023-01-01 00:01:00",
       "key" : "社内",
       "value" : "研修",
       "lpid": 1,
       "leid": 1,
       "title": "研修ライブ",
       "duration": 100,
       "view_count": 0,
       "play_count": 0,
       "audience_rating": "0.000",
       "play_rate": "0.000",
       "play_completion_rate": "0.000",
       "average_play_time": "0",
    },
  ],
  "response_code": 0
}

 

疑似ライブデータ一覧取得

概要

※旧VAでCSVファイル取得機能を利用していたお客様向けの機能です。

ユーザー別視聴解析で取得した疑似ライブに関する値を取得するAPIです。
旧VAで存在していたCSVファイル取得機能の代替となるAPIとなり、リクエストをvalue値で設定可能です。

 

API URL

https://api-analytics.stream.jp/analysis/getRecordListVlive


リクエスト通信仕様

  • プロトコル：POST
  • Content-Type : application/json

■パラメータ

No. 項目名 必須 説明 属性 形式 備考
1 from_date ○ 集計期間開始日時 string Y-m-d H:i:s  
2 to_date ○ 集計期間終了日時 string Y-m-d H:i:s  
3 type 〇 集計方法 int 1～4 1:分別
2:日別
3:月別
4:全体
4 key   検索対象キー string 1文字以上  
5 value   検索対象バリュー string 1文字以上  
6 page_size ○ 1ページ当たりのログレコード数 int 1〜100  
7 page_number ○ 該当のページ番号 int 1〜  


■リクエストサンプル

{
  "from_date": "2023-01-01 00:00:00",
  "to_date": "2023-01-01 23:59:59",
  "key" : "type",
  "value" : "研修",
  "type" : 1,
  "target" : 1,
  "page_size": 1,
  "page_number": 1
}

 

レスポンス通信仕様

  • Content-Type : application/json

■パラメータ

No. 項目名 説明 属性 備考
1 response_code レスポンスコード int 成功時は0
エラー時は9
2 count レコード数 int  
3 record_list ユーザー別視聴解析一覧 array  
  date 集計日時 string 集計方法が「4:全体」の場合は未設定
key カスタム解析Key string  
value カスタム解析変数値 string  
flpid 疑似ライブ設定ID int  
title 疑似ライブ設定名 string  
duration 配信時間 int  
view_count 表示回数 int  
play_count 再生回数 int  
audience_rating 視聴率 float 小数点第3位まで（第4位を切り捨て）
play_rate 再生率 float 小数点第3位まで（第4位を切り捨て）
play_completion_rate 再生完了率 float 小数点第3位まで（第4位を切り捨て）
average_play_time 平均再生時間 int 小数点切り捨て

 

■レスポンスサンプル

{
  "count" : 1000,
  "record_list": [
    {
      "date" : "2023-01-01 00:01:00",
      "key" : "type",
      "value" : "研修",
      "flpid": 2,
      "title": "研修動画",
      "duration": 100,
      "view_count": 0,
      "play_count": 0,
      "audience_rating": "0.0000",
      "play_rate": "0.0000",
      "play_completion_rate": "0.0000",
      "average_play_time": "0.00",
    },
  ],
  "response_code": 0
}

 

この記事は役に立ちましたか？
0人中0人がこの記事が役に立ったと言っています
ページの先頭へ戻る