導出虛擬事件查看器數據

在本主題中，您將了解如何導出虛擬事件查看器數據。

介紹

除了特定帳戶的帳戶、觀眾和視頻分析之外，您還可以查看按設備和位置匯總的虛擬事件的報告事件。此信息可以幫助您更好地組織即將舉行的虛擬活動，以最大限度地提高觀眾的參與度。

可以使用 Analytics API 下載此數據，並可以 JSON、CSV 或 XLXS 格式返回。下一節將簡要介紹 Analytics API。如果您已經知道如何使用它，則可以跳至下一節以獲取有關獲取虛擬事件分析數據的信息。

分析 API

和其他一樣平台API , Analytics API 是一個 RESTful API，允許您以編程方式與視頻雲平台進行交互。它根據您在請求中包含的各種 URL 參數返回分析數據。默認情況下，數據以 JSON 格式返回，但您可以請求在電子表格應用程序中打開 CSV 或 XLXS 數據。

如何提出要求

向 URL 發出對 RESTful API 的請求，與瀏覽器向 URL 發出請求以檢索網頁的方式相同。但是，您不能簡單地將 API 請求粘貼到瀏覽器中，因為該請求必須經過身份驗證（我們正在這樣做）以表明您有權獲取數據。但是，有許多工具可以幫助您做到這一點。這是一個簡短的列表：

  • 失眠（流行的跨平台應用程序）
  • 郵差（另一個流行的跨平台應用程序）
  • 在線 API 測試儀由 Brightcove Learning Services 創建
  • api-tester.sh（由 Brightcove Learning Services 創建的基於 curl 的 shell 腳本）

驗證請求

為了保護您的數據，Analytics API 請求必須包含一個包含訪問令牌的授權標頭：

Authorization: bearer your access token

你如何獲得訪問令牌？你可以閱讀所有關於它的信息獲取訪問令牌，但簡短的回答是，在你做了一些準備之後，上面列出的任何工具（以及許多其他工具）都會為你準備好。

準備工作包括獲得客戶憑據，其中包括一個client_id和一個client_secret .您可以使用工作室管理頁面（您必須是您帳戶的管理員或讓管理員執行此操作）：

  1. 在主導航中，單擊管理員 > API 身份驗證 .
  2. 點擊註冊新應用 .
  3. 在打開的對話框中輸入“Analytics”作為名稱。
  4. 選擇您要使用 API 的帳戶。
  5. 在下面暴露的 Brightcove API， 選擇讀在下面分析和視頻閱讀在下面內容管理系統 :
    API權限
    API權限
  6. 點擊節省 .
  7. 一個新對話框將顯示客戶端編號客戶秘密 .將它們複製並保存在一個安全的地方，以便您可以再次找到它們。

訪問令牌

使用客戶端憑據從另一個 Brightcove API 檢索訪問令牌。您可以自己執行此操作，但同樣，上一節中列出的任何工具都會獲取您的客戶端憑據並為您獲取訪問令牌，並將其放入與您的 Analytics API 請求一起發送的請求標頭中。

分析 API 請求

以下是 Analytics API 請求的形式：

http://analytics.api.brightcove.com/v1/data?accounts={account1_id,account2_id}
&from={yyyy-mm-dd}
&to={yyyy-mm-dd}
&dimensions=viewer,video,country,city,region,device_type,protocol
&fields=video,video.name,viewer,country,region,city,device_type,time,video_view,video_percent_viewed,video_seconds_viewed
&sort=-video_view&limit=20&format=csv

必需參數

必需參數
範圍 必填值 可選值
accounts 一個或多個帳戶 ID
dimensions
  • viewer
  • account
  • video
  • country
  • region
  • city
  • device_type
  • protocol

看參數對於一些額外的可選參數，可用於設置日期範圍、對結果進行排序、設置響應格式等。

過濾條件

您可以使用篩選結果where範圍。看過濾條件詳情

字段

直接從玩家那裡收集

  • viewer:事件查看器（SSO ID 或設備 ID 或基於用戶代理和 IP 的唯一字符串），取自user場地
  • time : 收到的最後一個事件的時間戳
  • video
  • country
  • region
  • city
  • device_type

聚合指標

  • video_view：總次數video_view由玩家發送（注意video_view是不是當觀看者暫停並重新開始播放視頻，或多次觀看視頻而不刷新頁面時發送）

計算字段

  • video_seconds_viewed:
    • Collector API 收到的最高範圍值，與順序無關
    • 請注意，描述超過 20 秒範圍的事件會被分析系統丟棄，如果播放器未正確檢測以發送 20 秒或更短的範圍，這可能會導致值不准確 - 請參閱概述：數據收集接口
  • video_percent_viewed : video_seconds_viewed/video_duration *100（如果視頻持續時間未發送到數據收集器，則此值將丟失或不准確）
  • video_engagement_xx：xx video_percent_viewed 的總觀看次數（xx = 1、25、50、75 或 100）
示例 API 響應 (JSON) 
{
	4    "item_count": 1,
	5    "items": [
	6        {
	7            "viewer": "test@brightcove.com",
	8            "country": "GB",
	9            "video_seconds_viewed": 253,
	10            "city": "London",
	11            "video_percent_viewed": 527.08,
	12            "device_type": "other",
	13            "video": "70701475639202",
	14            "video_view": 46,
	15            "region": "GB-ENG"
	16        }
	17    ],
	18    "summary": {
	19        "video_seconds_viewed": 253,
	20        "video_percent_viewed": 527.08,
	21        "video_view": 46
	22    }
	23}