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

概要: Analytics API v1

このトピックでは、 Analytics API.

概要

挽き目 Analytics API あなたの分析データを得ることができます Video Cloud アカウントを直接。 の分析モジュールで組み込みの分析レポートを表示することもできます Video Cloud スタジオ。 プログラムでデータにアクセスすると、柔軟性がさらに向上します。

また、 APIリファレンス.

典型的な用途

APIの一般的な使い方は次のとおりです。

  • カスタムチャートとディスプレイの作成
  • 複数のAPIを一緒に使用する-たとえば、 CMS API 前週で最も再生回数が多かった動画
  • ビデオ分析データと他のサイト分析データを組み合わせる
  • いくつかのサンプルソリューションについては、

ベースURL

そのベースURL Analytics API 次のとおりです。

  https://analytics.api.brightcove.com/v1

ヘッダ

認証(必須)

挽き目 Analytics API ブライトコーブを使用 OAuthサービス コールを認証します。

まず、クライアントの資格情報を取得する必要があります( client_idclient_secret)。 これは1回限りの操作で、 OAuth資格情報のUI。 以下を使用して、Brightcove OAuthサービスから直接クライアント認証情報を取得できます カール, Postmanまたは Insomnia.

クライアント認証情報には、Analyticsの読み取り権限とビデオの読み取り権限の両方が必要です。

の権限 Analytics API 証明
の権限 Analytics API 証明

あなたが直接あなたの信任状を作成しているならば OAuth API必要な権限は次のとおりです。

  [
    "video-cloud/analytics/read"
    "video-cloud/video/read"
  ]

また、 access_tokenこれは、 client_idclient_secret APIリクエストとともにAuthorizationヘッダーに渡されます。

  Authorization: Bearer {access_token}

挽き目 access_token 5分後に期限が切れるので、リクエストごとにトークンを取得するか、トークンが有効であることを確認する必要があります。 見る アクセストークンの取得 コードサンプルを含むトークンにアクセスする方法の詳細については、こちらを参照してください。

Accept-Encoding:gzip(オプション)

このヘッダーを渡すと、応答が圧縮された形式で返されます。 これにより、大規模なレポートのパフォーマンスが向上する可能性があります。

キャッシング

パフォーマンス上の理由から、API応答は約5分キャッシュされますが、正確な時間はいくつかの要因によって異なります。 任意の Analytics API クエリでは、応答ヘッダーからキャッシュに関する情報を取得できます。

キャッシュ制御ヘッダー
キャッシュ制御ヘッダー

挽き目 Cache-Control 結果が秒単位でキャッシュされる最大時間を示します(上記の例では、24秒)。 ザ Last-ModifiedExpires ヘッダーは現在のキャッシュの作成時期と期限が切れる時期を示します。

ほとんどの場合、これはおそらく問題ではありませんが、分析データの最新性が非常に重要な場合は、クエリが実行される時間が長くなればキャッシュが長くなり、リアルタイム(未調整の時間単位)データのみを取得するレポートリコンサイルされたデータをフェッチするもの(リアルタイムデータに加えて、またはリアルタイムデータに加えて)がキャッシュされている限り、キャッシュされません。 検索 リアルタイムで調整されたデータの完全な説明 もし良かったら; 短いバージョンは、 Analytics API 2つのデータバケットに依存しています。

  • 即座に利用可能になり、32日間保存されるリアルタイムまたは時間ごとの未調整データ
  • 恒久的に保存された調整済みデータ。 リアルタイムデータは、精度を向上させるために調整され、調整されたデータリポジトリに24時間ごとに格納されます

結果をリコンサイルまたはリアルタイムデータに限定するには、 和解する パラメータ。

キャッシングを最小限に抑えるには:

  • 使用 reconciled=false 結果をリアルタイムデータに限定するパラメータ
  • 小さい 期間、範囲全体が過去32日以内であることを確認してください

タイムアウト

Analytics API 完了しない場合、8分後にタイムアウトを要求します。 8分未満でタイムアウトが発生する場合、原因はクライアント側の制限です。

あなたが返すことができる最大項目

返すことができるアイテムの最大数は100万です。 ほとんどの場合、上限に達する可能性は低いですが、 date たとえば、長期間にわたってディメンションを作成することは可能です。 あなたが百万アイテムの制限に達するならば、あなたは返されるアイテムの数を減らすために要求を修正する必要があるでしょう。 一般に、これを行うための最も簡単な方法は、データ範囲を狭めることです( fromto パラメータについては後述します。

同時リクエスト

1つのアカウントは、一度に1つのリクエストに制限されます。 複数の同時リクエストが連続して実行されます。

例として:

  1. APIリクエスト "A"を開始します。
  2. 同じアカウントに対してAPIリクエスト "B"を開始します。
  3. リクエスト "B"は "A"が完了するまで完了しません。
  4. リクエスト "A"が長すぎる場合、リクエスト "A"は "あなたのリクエストは保留中です;もう一度やり直してください"というエラーを受け取ります。
  5. 要求 "A"が長すぎる場合、要求 "B"は同じエラーを受信する可能性があります。 A + Bを完了するための時間が私たちのタイムアウト値より大きい場合、リクエスト "B"はエラーになることに注意してください。

複数の同時リクエストを作成すると、受信した順に1つずつ処理されます。

「保留中のエラー」で返されたリクエストは、最終的に完了し、キャッシュに保存されます。 これは、5分キャッシュの有効期限が切れる前に要求が行われた場合に限り、同じデータに対する将来の要求がほぼ即時に返されることを意味します。

あなたのシステムは、2-4分を待ち、同じ要求を再度行うことで、保留中のエラーを処理する必要があります。

ベストプラクティス

リクエストの種類

挽き目 Analytics API 3つの要求タイプを受け入れる

データ(レポートとも呼ばれる)
1つ以上のレポート 大きさ。 レポート要求のエンドポイントは次のとおりです。
  https://analytics.api.brightcove.com/v1/data?accounts={account_id(s)}&dimensions={dimensions}
Engageメンメントレポート
過去32日以内に利用可能な詳細なエンゲージメントデータ。 見る 係合部 詳細はこちら
ビデオ情報エンドポイント
特定の分析データが最小限の遅延で処理されました。 見る ビデオデータエンドポイント 詳細については。

フィルタの場所期間 レポートに適用できます。 レポートリクエストには、で詳細に説明されている追加パラメータがあります。 この文書.

寸法とフィールド

ディメンションとフィールドに関する詳細な情報は別のドキュメントにあります。 ディメンション、フィールド、およびパラメータの概要.

パラメーター

パラメータに関する詳細な情報は別のドキュメントにあります。 ディメンション、フィールド、およびパラメータの概要.

Engageメンメントレポート

動画の100番目の部分ごとの視聴回数を示す詳細なエンゲージメントレポート(またはアカウントのすべての動画の平均または player)は、過去32日以内の期間に利用できます。 (過去32日間以外の日付範囲をリクエストすると、エラーが返されます。)

アカウントエンゲージメント

視聴した動画のエンゲージメントの平均値を取得するには、エンドポイントを使用します。

  
      https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id
  

Player 婚約

で表示されたすべてのビデオの平均値を取得するには player、エンドポイントを使用:

  
      https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id/players/:player_id
  

動画エンゲージメント

特定の動画のエンゲージメントデータを取得するには、エンドポイントを使用します。

  
      https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id/videos/:video_id
  

Live アナリティクス

挽き目 Analytics API Brightcoveの分析を取得するためのXNUMXつのエンドポイントを提供します Live 時系列またはイベントのいずれかでストリームします。 を参照してください Analytics API 参照 詳細については。


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