オンデマンド動画

全体サマリー

概要

オンデマンド動画全体のサマリーを取得するAPIです。

対象画面

各動画の詳細状況＞サマリー

API URL

https://api-analytics.stream.jp/ondemand/getSummary

リクエスト通信仕様

プロトコル：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	grids		管理グループID一覧	array		0〜5件指定しない場合は[0]固定グループIDの取得についてはこちら
4	title		タイトル	string	1文字以上
5	keywords		キーワード	string	1文字以上
6	mid		動画ID	int	1〜
7	opid		任意ID	string	1文字以上
8	api_keywords		APIリファレンスコード	string	1文字以上
9	custom_fields		カスタムフィールド	array		1〜5件
10	custom_fields.id		カスタムフィールドID	int	1〜5
11	custom_fields.val		カスタムフィールド値	string	1文字以上

■リクエストサンプル

{
"from_date":"2026-01-01 00:00:00",
"to_date":"2026-12-31 23:59:59",
"grids":[
0
],
"opid":"optest1",
"mid":350,
"api_keywords":"test_api_keywords",
"custom_fields": [
{"id":1, "val":"test100"}
]
}

レスポンス通信仕様

Content-Type : application/json

■パラメータ

No.	項目名	説明	属性	備考
1	response_code	レスポンスコード	int	成功時は0 エラー時は9
3	total_view_count	表示回数	int
4	total_play_count	再生回数	int
5	average_audience_rating	視聴率	string	小数点第3位まで（第4位を切り捨て）
6	average_play_rate	再生率	string	小数点第3位まで（第4位を切り捨て）
7	average_play_completion_rate	再生完了率	string	小数点第3位まで（第4位を切り捨て）

■レスポンスサンプル

{
"total_view_count": 98,
"total_play_count": 14,
"average_audience_rating": "0.142",
"average_play_rate": "0.000",
"average_play_completion_rate": "0.000",
"response_code": 0
}

全体コンテンツリスト

概要

オンデマンド動画全体のコンテンツリストから視聴状況タブの値を取得するAPIです。

対象画面

各動画の詳細状況＞コンテンツリストの視聴状況タブ

API URL　

https://api-analytics.stream.jp/ondemand/getContentList

リクエスト通信仕様

プロトコル：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	grids		管理グループID一覧	array	0〜5件	指定しない場合は[0]固定グループIDの取得についてはこちら
4	title		タイトル	string	1文字以上
5	keywords		キーワード	string	1文字以上
6	mid		動画ID	int	1〜2147483647
7	opid		任意ID	string	1文字以上
8	api_keywords		APIリファレンスコード	string	1文字以上
9	custom_fields		カスタムフィールド	array	1〜5件
10	custom_fields.id		カスタムフィールドID	int	1〜5
11	custom_fields.val		カスタムフィールド値	string	1文字以上
12	sort		ソート	string	1文字以上〜	レスポンスの項目名にマイナス（-）をつけると降順となる例）-view_count
13	page_size	○	1ページ当たりのログレコード数	int	1〜100
14	page_number	○	該当のページ番号	int	1〜2147483647

■リクエストサンプル

{
"from_date":"2025-01-01 00:00:00",
"to_date":"2025-10-05 23:59:59",
"grids":[
0
],
"mid":26,
"sort":"-view_count",
"page_size":100,
"page_number":1
}

レスポンス通信仕様

Content-Type : application/json

■パラメータ

No.	項目名		説明	属性	備考
1	response_code		レスポンスコード	int	成功時は0 エラー時は9
2	count		レコード数	int	検索条件に一致するトータルレコード件数
3	viewing_status_list		視聴状況一覧	array
		mid	動画ID	string
		title	動画タイトル	string
		thumbnail_url	サムネイルURL	string
		duration	動画の長さ	string
		opid_1	任意ID 1	string
		opid_2	任意ID 2	string
		opid_3	任意ID 3	string
		cumulative_play_count	累計再生回数	int
		session_count	セッション数	int
		view_count	表示回数	int
		play_count	再生回数	int
		audience_rating	視聴率	string	小数点第3位まで（第4位を切り捨て）
		play_rate	再生率	string	小数点第3位まで（第4位を切り捨て）
		play_completion_rate	再生完了率	string	小数点第3位まで（第4位を切り捨て）
		last_viewing_date	最終視聴日時	string
		conversion_contribution_count	コンバージョン貢献数	int
		average_play_time	平均再生時間	string
		average_play_count	平均再生回数	string

■レスポンスサンプル

{
"viewing_status_list": [
{
"mid": 26,
"opid_1": "",
"opid_2": "",
"opid_3": "",
"title": "第2回研修会",
"thumbnail_url": "https://eqxxxxxxxx.webcdn.stream.ne.jp/www50/eqxxxxxxxx/jmc_pub/thumbnail/00001/～.jpg",
"cumulative_play_count": "0",
"session_count": 0,
"view_count": 11,
"play_count": 0,
"audience_rating": "0.000",
"play_rate": "0.000",
"play_completion_rate": "0.000",
"average_play_count": "0.000",
"average_play_time": "0",
"duration": "43",
"last_viewing_date": null,
"conversion_contribution_count": 0
}
],
"count": 1,
"response_code": 0
}

全体コンテンツクリックリスト

概要

オンデマンド動画全体のコンテンツリストからクリック数タブの値を取得するAPIです。

対象画面

各動画の詳細状況＞コンテンツリストのクリック数タブ

API URL

https://api-analytics.stream.jp/ondemand/getContentClickCountList

リクエスト通信仕様

プロトコル：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	grids		管理グループID一覧	array	0〜5件	指定しない場合は[0]固定グループIDの取得についてはこちら
4	title		タイトル	string	1文字以上
5	keywords		キーワード	string	1文字以上
6	mid		動画ID	int	1〜2147483647
7	opid		任意ID	string	1文字以上
8	api_keywords		APIリファレンスコード	string	1文字以上
9	custom_fields		カスタムフィールド	array	1〜5件
10	custom_fields.id		カスタムフィールドID	int	1〜5
11	custom_fields.val		カスタムフィールド値	string	1文字以上
12	sort		ソート	string	1文字以上〜	レスポンスの項目名にマイナス（-）をつけると降順となる例）-view_count
13	page_size	○	1ページ当たりのログレコード数	int	1〜100
14	page_number	○	該当のページ番号	int	1〜2147483647

■リクエストサンプル

{
"from_date":"2025-01-01 00:00:00",
"to_date":"2025-10-05 23:59:59",
"grids":[
0
],
"mid":26,
"sort":"-twitter_count",
"page_size":100,
"page_number":1
}

レスポンス通信仕様

Content-Type : application/json

■パラメータ

No.	項目名		説明	属性	備考
1	response_code		レスポンスコード	int	成功時は0 エラー時は9
2	count		レコード数	int	検索条件に一致するトータルレコード件数
3	click_count_list		視聴状況一覧	array
		mid	動画ID	string
		title	動画タイトル	string
		thumbnail_url	サムネイルURL	string	ソート指定可能
		opid_1	任意ID 1	string	ソート指定可能
		opid_2	任意ID 2	string	ソート指定可能
		opid_3	任意ID 3	string	ソート指定可能
		replay_count	もう一回見る	int	ソート指定可能
		exlink1_count	外部リンク 1	int	ソート指定可能
		exlink2_count	外部リンク 2	int	ソート指定可能
		exlink3_count	外部リンク 3	int	ソート指定可能
		facebook_count	SNS（Facebook）	int	ソート指定可能
		twitter_count	SNS（X: 旧Twitter）	int	ソート指定可能
		line_count	SNS（LINE）	int	ソート指定可能

■レスポンスサンプル

{
"click_count_list": [
{
"mid": 26,
"opid_1": "",
"opid_2": "",
"opid_3": "",
"title": "第2回研修会",
"thumbnail_url": "https://eqxxxxxxxx.webcdn.stream.ne.jp/www50/eqxxxxxxxx./jmc_pub/thumbnail/00001/～.jpg",
"replay_count": 0,
"exlink1_count": 0,
"exlink2_count": 0,
"exlink3_count": 0,
"facebook_count": 0,
"twitter_count": 0,
"line_count": 0
}
],
"count": 1,
"response_code": 0
}

各動画の掲載ページURL一覧

概要

オンデマンド動画毎の掲載ページURL一覧を取得するAPIです。

対象画面

各動画の詳細状況＞動画詳細ページの掲載ページURLリスト

API URL

https://api-analytics.stream.jp/ondemandDetail/getUrlInfoList

リクエスト通信仕様

プロトコル：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	mid	○	動画ID	int	1〜2147483647
4	search_domain		取得対象対象掲載ページURLの一覧	string	1文字以上	未指定で全体取得
5	sort		ソート	string	1文字以上	レスポンスの項目名にマイナス（-）をつけると降順になる例）-view_count
6	page_size	○	1ページ当たりのログレコード数	int	1〜100
7	page_number	○	該当のページ番号	int	1〜2147483647

■リクエストサンプル

{
"from_date": "2025-01-01 00:00:00",
"to_date": "2025-10-05 23:59:59",
"mid": 4,
"search_domain":"stream.co.jp",
"sort":"-view_count",
"page_size":100,
"page_number":1
}

レスポンス通信仕様

Content-Type : application/json

■パラメータ

No.	項目名		説明	属性	備考
1	response_code		レスポンスコード	int	成功時は0 エラー時は9
2	url_info_list		掲載ページURL一覧	array
		target_name	掲載ページURL	string
		view_count	表示回数	int	ソート指定可能
		play_count	再生回数	int	ソート指定可能
		audience_rating	視聴率	string	ソート指定可能小数点第3位まで（第4位を切り捨て）
		play_rate	再生率	string	ソート指定可能小数点第3位まで（第4位を切り捨て）
		play_completion_rate	再生完了率	string	ソート指定可能小数点第3位まで（第4位を切り捨て）
		average_play_time	平均再生時間	string	ソート指定可能
3	count		レコード数	int

■レスポンスサンプル

{
"url_info_list": [
{
"target_name": https://stream.co.jp",
"view_count": 1,
"play_count": 1,
"audience_rating": "1.000",
"play_rate": "0.000",
"play_completion_rate": "1.000",
"average_play_time": "239"
}
],
"count": 1,
"response_code": 0
}

■レスポンスサンプル（エラー時）　midが存在しない場合

{
"title": "対象データが存在しません。",
"body": "対象データが存在しません。 cid = 0000 mid = 400"
}

動画別の日別・時間帯別リスト

概要

動画別・日時別のリストを取得するAPIです。

対象画面

各動画の詳細状況＞動画別・日時別csvエクスポート

API URL

https://api-analytics.stream.jp/ondemand/getSpanSummary

リクエスト通信仕様

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

■パラメータ

No.	項目名	必須	説明	属性	形式	備考
1	target_month	○	集計対象月	string	Y-m-d	過去25か月以内を指定
2	page_size	○	1ページ当たりのログレコード数	int	1〜100000
3	page_number	○	該当のページ番号	int	1〜2147483647

■リクエストサンプル

{
"target_month": "2025-09",
"page_size":100,
"page_number":1
}

レスポンス通信仕様

Content-Type : application/json

■パラメータ

No.	項目名		説明	属性	備考
1	response_code		レスポンスコード	int	成功時は0 エラー時は9
2	viewing_date_list		動画日時別一覧	array
		target_date	年月日	string	yyyy/mm/dd
		target_hour	時	int	24時間形式で0～23
		mid	動画ID	int
		opid_1	任意ID 1	string
		opid_2	任意ID 2	string
		opid_3	任意ID 3	string
		title	タイトル	string
		device	視聴機器	string
		view_count	表示回数	int
		play_count	再生回数	int
		audience_rating	視聴率	string	小数点第3位まで（第4位を切り捨て）
		play_rate	再生率	string	小数点第3位まで（第4位を切り捨て）
		play_completion_rate	再生完了率	string	小数点第3位まで（第4位を切り捨て）
		average_play_time	平均再生時間	string
		total_play_time	総視聴時間	string
		duration	動画時間	string
3	count		レコード数	int	検索条件に一致するトータルレコード件数

■レスポンスサンプル

{
"viewing_date_list": [
{
"mid": 1,
"target_date": "2025/09/04",
"target_hour": 0,
"opid_1": "",
"opid_2": "",
"opid_3": "",
"title": "新VA試験用動画_VOD.mp4",
"device": "PC",
"view_count": 1,
"play_count": 0,
"audience_rating": "0.000",
"play_rate": "0.000",
"play_completion_rate": "0.000",
"average_play_time": "0",
"total_play_time": "0",
"duration": "120"
},
{
"mid": 4,
"target_date": "2025/09/11 13:00",
"opid_1": "__",
"opid_2": "5",
"opid_3": "hoge",
"title": "新VA試験用動画_VOD.mp4",
"device": "PC",
"view_count": 1,
"play_count": 1,
"audience_rating": "1.000",
"play_rate": "1.000",
"play_completion_rate": "1.000",
"average_play_time": "239",
"total_play_time": "239.940236",
"duration": "120"
},
{
"mid": 6,
"target_date": "2025/09/11 13:00",
"opid_1": "_",
"opid_2": "AaAA",
"opid_3": "",
"title": "新VA試験用動画_VOD.mp4",
"device": "PC",
"view_count": 1,
"play_count": 1,
"audience_rating": "1.000",
"play_rate": "1.000",
"play_completion_rate": "1.000",
"average_play_time": "239",
"total_play_time": "239.962581",
"duration": "120"
},
{
"mid": 6,
"target_date": "2025/09/12 11:00",
"opid_1": "_",
"opid_2": "AaAA",
"opid_3": "",
"title": "新VA試験用動画_VOD.mp4",
"device": "PC",
"view_count": 1,
"play_count": 1,
"audience_rating": "1.000",
"play_rate": "1.000",
"play_completion_rate": "1.000",
"average_play_time": "239",
"total_play_time": "239.961279",
"duration": "120"
}
],
"count": 4,
"response_code": 0
}

お知らせ

リリースノート

メンテナンス

障害情報

EQ

EQポータル

マニュアル動画

EQ管理画面マニュアル

EQポータルマニュアル

ライブ配信マニュアル

動画視聴解析マニュアル

拡張アプリ/周辺アプリ

EQプレイヤーSDK

APIマニュアル

外部連携マニュアル

セミナー

JストリームBlog

よくあるご質問

既知の問題

用語集

困ったときは

全体サマリー

全体コンテンツリスト

全体コンテンツクリックリスト

各動画の掲載ページURL一覧

動画別の日別・時間帯別リスト