統計
バージョン別機能範囲のご案内
- v1 未対応: v1 では統計関連機能をサポートしていません。
- 共通認証: すべてのバージョンの API はクエリ文字列パラメータ（
?access_token=）による共通認証方式を使用します。エラー判定基準に関する共通仕様は、API v3 マイグレーションガイドの コア変更点 セクションを参照してください。
コンテンツ全体視聴ランキング取得
- 既存 (v1/v2): 未対応
- 変更後 (v3):
GET/statistics/content-rank
レスポンス最上位キーの例外構造
ほとんどの v3 API とは異なり、最上位キーとして result_data を使用します。
クライアントアプリケーションに API 共通レスポンスパーサーを適用する場合、データが欠落する可能性があるため、必ず例外処理を実装する必要があります。
リクエストパラメータおよびレスポンス構造の詳細
リクエストクエリパラメータ
| パラメータ | データ型 | 必須有無 | 説明 |
|---|---|---|---|
start_date | String | 必須 | 照会範囲の開始日 (YYYYMMDD) |
end_date | String | 必須 | 照会範囲の終了日 (YYYYMMDD) |
keyword | String | オプション | 検索キーワードによるフィルタリング |
start_index | Integer | オプション | 結果リストの開始番号 |
limit | Integer | オプション | 最大出力データ件数（0: 全データ照会） |
レスポンス構造仕様
{
"result_data": [
{
"avg_play_rate": 85.5,
"avg_uplay_rate": 80.2,
"category_id": 10,
"channel_key": "channel_key_string",
"content_id": 1,
"title": "top1_content_title",
"upload_time": "2025-12-22 01:28:39",
"upload_key": "upload_key_string",
"duration": 3600,
"count": 500,
"play_count": 450
}
]
}
チャンネル内コンテンツ視聴ランキング取得
- 既存 (v1/v2): 未対応
- 変更後 (v3):
GET/channels/{channel_key}/statistics/content-rank
レスポンス最上位キーの例外構造
ほとんどの v3 API とは異なり、最上位キーとして result_data を使用します。
クライアントアプリケーションに API 共通レスポンスパーサーを適用する場合、データが欠落する可能性があるため、必ず例外処理を実装する必要があります。
リクエストパラメータおよびレスポンス構造の詳細
リクエストパラメータ
- パスパラメータ (Path): 対象チャンネルを指定するための
channel_key（必須）を URL に含める必要があります。 - クエリパラメータ (Query): コンテンツ全体視聴ランキング取得 API と完全に同一のパラメータ 仕様（
start_date、end_date、keyword、start_index、limit）を使用します。
レスポンス構造仕様
レスポンス仕様は コンテンツ全体視聴ランキング取得 のレスポンス構造と完全に同一です。
日別統計照会
- 既存 (v1): 未対応
- 既存 (v2):
GET/vod/statistics/summary-daily - 変更後 (v3):
GET/statistics/summary-daily
変更事項
エンドポイントパスから /vod プレフィックスが削除されました。リクエストクエリパラメータおよびレスポンス構造は v2 仕様と同一に維持されます。
リクエストパラメータおよびレスポンス構造の詳細
リクエストクエリパラメータ
| パラメータ | データ型 | 必須有無 | 説明 |
|---|---|---|---|
start_date | String | 必須 | 照会範囲の開始日 (YYYYMMDD) |
end_date | String | 必須 | 照会範囲の終了日 (YYYYMMDD) |
レスポンス構造仕様
{
"data": [
{
"startdate": "20231001",
"enddate": "20231031",
"total_transfer": 1024000,
"max_traffic": 5000,
"total_storage": 2048000,
"max_storage": 2100000,
"total_transcoding_size": 512000,
"total_transcoding_count": 150,
"total_visitor": 3500,
"daily_data": [
{
"datetime": "20231001",
"transfer": 30000,
"traffic": 150,
"storage": 2000000,
"transcoding_size": 15000,
"transcoding_count": 5,
"visitor": 120
}
]
}
]
}