支持 聯繫支持 | 系統狀況 系統狀態
頁面內容

    概述: Analytics API v1

    在本主題中,您將獲得有關 Analytics API.

    簡介

    Analytics API 允許您獲取您的分析數據 Video Cloud 直接帳戶。 您還可以在以下網站的“分析”模塊中查看內置的分析報告: Video Cloud 工作室。 以編程方式訪問數據為您提供了更多的靈活性。

    另見 API參考.

    典型用途

    以下是API的一些典型用法:

    • 創建自定義圖表和顯示
    • 一起使用多個API-例如,使用 CMS API 觀看前一周觀看次數最多的視頻
    • 將您的視頻分析數據與其他站點分析數據相結合
    • 有關一些示例解決方案,請參見

    基本網址

    的基本網址 Analytics API 是:

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

    身份驗證(必填)

    Analytics API 使用Brightcove OAuth服務 驗證電話。

    您首先需要獲取客戶端憑據( client_idclient_secret)。 這是一次性操作,可以使用 OAuth憑證使用者介面。 您可以使用以下方法直接從Brightcove OAuth服務獲取客戶端憑據: 捲曲, 郵差, 或者叫 失眠.

    您需要具有Google讀取和視頻讀取權限才能獲得客戶端憑據:

    的權限 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 五分鐘後過期,因此您必須為每個請求獲取一個,或檢查以確保您的令牌仍然有效。 看到 獲取訪問令牌 有關如何獲取訪問令牌(包括代碼示例)的詳細說明。

    接受編碼:gzip(可選)

    傳遞此標頭將導致響應以壓縮形式返回。 這可以提高大型報表的性能。

    高速緩存

    出於性能方面的考慮,API響應會緩存大約5分鐘,儘管確切的時間可能會因多種因素而有所不同。 對於任何 Analytics API 查詢,您可以從響應標頭中獲取有關緩存的信息:

    緩存控制頭
    緩存控制頭

    Cache-Control 告訴您將結果緩存的最長時間(以秒為單位)(在上面的示例中為24秒)。 的 Last-ModifiedExpires 標頭會告訴您當前的緩存何時創建以及何時過期。

    在大多數情況下,這可能不是問題,但是如果分析數據的新鮮度至關重要,則應該知道查詢運行的時間越長,緩存的時間就越長,並且報告僅獲取實時(每小時未對帳)數據只要獲取已對帳數據的數據(僅實時數據或除實時數據外)就不會被緩存。 找到一個 實時和對帳數據的完整說明 如果你喜歡; 簡短的版本是 Analytics API 依靠兩個數據桶:

    • 實時或每小時未對帳數據,可立即使用並存儲32天
    • 對帳數據已永久存儲; 對實時數據進行協調以提高準確性,並每24小時將其存儲在協調的數據存儲庫中

    您可以將結果限制為已對帳或實時數據 不甘心 參數。

    要最小化緩存:

    超時時間

    Analytics API 如果未完成,則在8分鐘後請求超時。 如果您看到超時少於8分鐘,則原因是客戶端限制。

    您最多可以退回的物品

    可以退回的最大物品數為一百萬。 在大多數情況下,您不太可能達到上限,但是如果您要求提供有關 date 例如,可以在較大的時間跨度內進行尺寸標註。 如果達到百萬個項目的限制,則需要修改請求以減少返回的項目數。 通常,最直接的方法是縮小數據范圍(使用 fromto 參數將在後面討論)。

    並發請求

    一個帳戶一次只能有一個請求。 多個並發請求將按順序執行。

    例如:

    1. 啟動API請求“ A”。
    2. 為同一帳戶啟動API請求“ B”。
    3. 在“ A”完成之前,請求“ B”將不會完成。
    4. 如果請求“ A”花費的時間太長,則請求“ A”將收到一條錯誤消息,指出“您的請求未決;請重試”。
    5. 如果請求“ A”花費的時間太長,則可能導致請求“ B”收到相同的錯誤。 請注意,如果完成A + B的時間大於我們的超時值,則請求“ B”將收到錯誤消息。

    如果您發出多個並發請求,則將按接收到的順序一次處理一個。

    最終返回“未決錯誤”的請求將完成並保存到我們的緩存中。 這意味著將來對同一數據的請求將幾乎立即返回,但前提是該請求是在五分鐘緩存到期之前發出的。

    您的系統應等待2-4分鐘,然後再次發出相同的請求,以處理未決的錯誤。

    最佳實踐

    請求類型

    Analytics API 接受三種請求類型

    數據(也稱為報告)
    關於一個或多個的報告 外形尺寸。 報告請求的端點是:
      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(分析)

    Analytics API 提供了兩個端點來檢索Brightcove的分析 Live 按時間序列或事件流。 見 Analytics API 參考 有關詳細信息。


    頁面最後更新於12年2020月XNUMX日