入門
によって提供されるライブストリームの再生メトリックBrightcoveライブサービスは、を介してリアルタイムで利用可能ですAnalytics API。このデータは ライブストリーム それだけ; VOD再生は含まれていません。
APIは、次の2つのエンドポイントを介してライブストリームメトリックを提供します。
/v1/timeseries
/v1/events
どちらも同じデータセットをクエリしますが、結果の集計方法は異なります。このドキュメントでは、それぞれの使用法と構文について説明します。
指標
これらは、ライブエンドポイントを介して利用可能なメトリックです。クエリは複数のメトリックを要求する場合があります。
メトリック | 説明 |
---|---|
alive_ss_ad_start |
サーバー側の広告の表示回数 |
ccu |
個性的 セッション;個別の数(指紋 + セッション) |
fingerprint_count |
個性的 デバイス;明確な数 指紋 (下記参照) |
video_impression |
ビデオがプレーヤーにロードされた回数 |
video_seconds_viewed |
すべての視聴者が視聴した合計秒数 |
video_view |
ストリームが開始します(一意ではありません) |
にとって個性的追跡、割り当てます 指紋 (を組み合わせて各デバイスにRemote IP
+ User-Agent
+ Player
)。デバイス自体の実際のハードウェアIDは使用しないことに注意してください。これにより、精度は低下しますが、プライバシーに準拠した状態が維持されます。
サイズ
次の組み合わせは、としてサポートされていますdimensions
そしてwhere
フィルタキー:
video
video, country
video, device_type
クエリパラメータ
両方のライブエンドポイントは、クエリのスコープとグループ化を制御するいくつかの共通パラメーターを共有します。
パラメーター | 構文 | 必須 | デフォルト | 説明 |
---|---|---|---|---|
次元 | <dim1>,<dim2>,... |
Y | - | クエリディメンション(GROUP BY) |
メトリック | <metric1>,<metric2>,... |
Y | - | レポートする1つ以上のメトリック |
ここでは以下の条件です。 | <dim1>==<value1>;... |
Y | - | 1つ以上のクエリフィルター。少なくとも1つのビデオを含める必要があります |
から | <epoch> |
N | 今から32日 | 時間範囲が始まります |
から | <epoch> |
N | 今 | 時間範囲終了 |
時系列
ザ・/v1/timeseries
エンドポイントは、タイムラインに沿ったポイントのリストを、各時点での要求されたメトリックの値とともに返します。ポイントは1分デフォルトではバケットですが、パラメータを介して変更できます。
このコンテキストでは、一意のメトリック(ccu
、fingerprint_count
)は最大値各バケット中いつでも。したがって、bucket_duration=1d
1日の最大同時実行数を返しますが、bucket_limit=1
ストリーム内の任意の時点で最大の同時実行性を返します。
うり
/v1/timeseries/accounts/{account_id}
追加パラメータ
パラメーター | 構文 | 必須 | デフォルト | 説明 |
---|---|---|---|---|
バケット期間 | <n>m (分)<n>h (時間)<n>d (日々) |
N | 1メートル | 各ポイントで表される期間。1d カレンダーの日ではなく、24時間です。 |
バケット制限 | <n> |
N | - | 返すポイントの数。どちらかを使用してくださいbucket_duration またはbucket_limit 、ただし両方を一緒にすることはできません。 |
応答
{
"<metric1>": {
"data": [
{
"dimensions": {
"account": "<account>",
"<dim1>": "<key1>",
...
"<dimN>": "<keyN>"
},
"points": [
{
"timestamp": <bucket1>,
"value": <value1>
},
...,
{
"timestamp": <bucketN>,
"value": <valueN>
},
]
}
]
},
"<metric2>": {
...
},
...
}
イベント
ザ・/v1/events
エンドポイントは、ライブビデオストリームの全部または一部のメトリック合計を返します。
このコンテキストでは、一意のメトリック(ccu
、fingerprint_count
)を表す総価値クエリ範囲を超えています。したがって、たとえば、from
/ to
パラメータは、の総数を返します 個性的 ストリーム全体のセッション(ccu)および/またはデバイス(fingerprint_count)。
うり
/v1/events/accounts/{account_id}
追加パラメータ
なし
応答
{
"data": [
{
"dimensions": {
"account": "<account>",
"<dim1>": "<key1>",
...
"<dimN>": "<keyN>"
},
"totals": {
"<metric1>": <value1>,
...
"<metricN>": <valueN>
}
}
]
}
エクスポート
イベントエンドポイントは、ダウンロード可能なレポートも提供します。
/v1/events/accounts/{account_id}/videos/{video_id}/export?format=xlsx
応答はXLSX 4枚のライブメトリックを含むファイル:
- 要約
- 同時ユーザー
- デバイスタイプ別のビュー
- 地理によるビュー
使用例
これらすべての例では、アカウント1234、ビデオ5555、および現在の時刻を12:00:00 PM UTCオン2020年2月15日。
ライブストリームまたはチャンネルの現在の視聴者数(CCU)を取得する
設定 から 少なくとも2分前(午前11時58分)まで、最後の 点 応答で。
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581767880000
過去24時間のライブストリームのCCUグラフポイントを取得します
ズームイン(1分ポイント)
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1m
ズームアウト(1時間ポイント)
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1h
過去7日間のライブチャンネルの1日あたりの最大CCUを取得する
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581206400000&bucket_duration=7d
ライブストリーム中いつでも最大CCUを取得する
/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&bucket_limit=1
複数のライブストリームのユニーク視聴者と視聴秒数の合計を取得します
ビデオ5555が完了しました。数字は最終的なものです。ビデオ5556はまだアクティブです。数字は現在の合計です。
/v1/events/accounts/1234?dimensions=video&metrics=fingerprint_count,video_seconds_viewed&where=video==5555,5556
ライブチャンネルで1時間の番組の視聴者数と広告の合計を取得する<
プログラムは午前10時から午前11時まで放送されました(UTC)
/v1/events/accounts/1234?dimensions=video&metrics=alive_ss_ad_start,video_view,fingerprint_count&where=video==5555&from=1581760800000&to=1581764399999
ライブストリームの期間中、国別の視聴者数を取得する
/v1/events/accounts/1234?dimensions=video,country&metrics=video_view,fingerprint_count&where=video==5555