サポート サポート問い合わせ先 | システムステータス システムステータス

Analytics API: Live メトリック

このトピックでは、 Live ストリーム。

概要

再生メトリック Live によって提供されるストリーム Brightcove Live サービスは、リアルタイムで、 分析API。 このデータは ライブストリーム のみ; VOD再生は含まれていません。

APIが提供する Live 2つのエンドポイントを介してストリームメトリック:

  • /v1/timeseries
  • /v1/events

どちらも同じデータセットをクエリしますが、結果の集計方法は異なります。 このドキュメントでは、それぞれの使用法と構文について説明します。

メトリック

これらは、 Live エンドポイント。 クエリは複数のメトリックを要求する場合があります。

メトリック 説明
alive_ss_ad_start サーバー側の広告のインプレッション
ccu 独自の セッション; 個別の数(指紋 + セッションを開く)
fingerprint_count 独自の デバイス; 異なる数 指紋 (下記参照)
video_impression ビデオが読み込まれた回数 player
video_seconds_viewed すべての視聴者が視聴した合計秒数
video_view ストリームの開始(一意ではない)

  ユニーク 追跡、割り当てます 指紋 組み合わせて各デバイスに(Remote IP + User-Agent + Player)。 デバイス自体からの実際のハードウェアIDは使用しないことに注意してください。これにより精度が低下しますが、プライバシーに準拠したままになります。

寸法

次の組み合わせがサポートされています dimensionswhere フィルターキー:

  • video
  • video, country
  • video, device_type

クエリパラメータ

両方 Live エンドポイントは、クエリのスコープとグループ化を制御するいくつかの共通パラメーターを共有します。

パラメーター 構文 必須 デフォルト 説明
大きさ <dim1>,<dim2>,... Y - クエリディメンション(GROUP BY)
メトリクス <metric1>,<metric2>,... Y - レポートするXNUMX​​つ以上のメトリック
where <dim1>=<value1>;... Y - 1つ以上のクエリフィルター。 少なくともXNUMXつの動画を含める必要があります
from <epoch> N 0 時間範囲が始まります
〜へ <epoch> N 時間範囲終了

時系列

挽き目 /v1/timeseries endpointは、タイムラインに沿ったポイントのリストを、各ポイントで要求されたメトリックの値とともに返します。 ポイントは 1の時間(分) デフォルトではバケットですが、パラメータを使用して変更できます。

このコンテキストでは、ユニークなメトリック(ccu, fingerprint_count)を示す 最大値 各バケット中いつでも。 したがって、クエリ bucket_duration=1d 毎日の最大同時実行性を返しますが、 bucket_limit=1 ストリームの任意の時点で最大の同時実行性を返します。

URI

/v1/timeseries/accounts/$account

追加パラメーター

パラメーター 構文 必須 デフォルト 説明
bucket_duration <n>m (分)
<n>h (時間)
<n>d (日々)
N 1m 各ポイントで表される期間。 1d 24時間です。カレンダーの日ではありません。
bucket_limit <n> N - 返すポイントの数。 どちらかを使用 bucket_duration or bucket_limit、しかし両方ではない。

レスポンス

{
"<metric1>": {
"data": [
  {
    "dimensions": {
        "account": "<account>",
        "<dim1>": "<key1>",
        ...
        "<dimN>": "<keyN>"
      },
    "points": [
      {
        "timestamp": <bucket1>,
        "value": <value1>
      },
      ...,
      {
        "timestamp": <bucketN>,
        "value": <valueN>
      },
    ]
  }
]
},
"<metric2>": {
...
},
...
}

イベント (英語のみ)

挽き目 /v1/events エンドポイントは、すべてまたは一部のメトリックの合計を返します Live ビデオストリーム。

このコンテキストでは、ユニークなメトリック(ccu, fingerprint_count)を表す 総価値 クエリ範囲。 したがって、たとえば、 from/to パラメータは合計数を返します ユニーク ストリーム全体のセッション(ccu)やデバイス(fingerprint_count)。

URI

/v1/events/accounts/$account

追加パラメーター

無し

レスポンス

{
"data": [
{
  "dimensions": {
    "account": "<account>",
    "<dim1>": "<key1>",
    ...
    "<dimN>": "<keyN>"
  },
  "totals": {
    "<metric1>": <value1>,
    ...
    "<metricN>": <valueN>
  }
}
]
}

輸出

イベントエンドポイントは、ダウンロード可能なレポートも提供します。

/v1/events/accounts/$account/videos/$video/export?format=xlsx

応答は XLSX ファイル Live 4つのシートのメトリック:

  • サマリー
  • 同時ユーザー
  • デバイスタイプ別のビュー
  • 地理別のビュー

使用例

これらすべての例では、 アカウント1234, ビデオ5555、現在の時刻を 午後12:00:00 UTC on 15年2020月XNUMX日.


現在のビューア数(CCU)を取得します Live ストリームまたはチャネル

設定する from 少なくとも2分前(11:58 AM)に、最後の ポイント レスポンスで。

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581767880000


のCCUグラフポイントを取得する Live 過去24時間のストリーミング

ズームイン(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


のXNUMX日あたりの最大CCUを取得 Live 過去7日間のチャネル

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581206400000&bucket_duration=1d


中のいつでも最大CCUを取得 Live 流れ

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&bucket_limit=1


複数のユニークビューアーと秒数の合計を取得します Live ストリーム

ビデオ5555が完了しました。 数値は最終的なものです。 ビデオ5556はまだアクティブです。 数値は累計です。

/v1/events/accounts/1234?dimensions=video&metrics=fingerprint_count,video_seconds_viewed&where=video==5555,5556


XNUMX時間のプログラムの視聴者数と広告の合計を取得します Live チャンネル<

10:00 AMから11:00 AMまで放送されるプログラム(UTC)

/v1/events/accounts/1234?dimensions=video&metrics=alive_ss_ad_start,video_view,fingerprint_count&where=video==5555&from=1581760800000&to=1581764399999


期間中、国別の視聴率を取得します Live 流れ

/v1/events/accounts/1234?dimensions=video,country&metrics=video_view,fingerprint_count&where=video==5555


ページの最終更新日:12年2020月XNUMX日