概述：尺寸，字段和參數

尺寸和領域

維度是用於分析的主要數據桶。要查看各個尺寸的完整指南，請在下面的列表中單擊尺寸名稱。

選擇下面的尺寸以查看可以為其返回的字段。您也可以點擊 發出請求 按鈕發出樣品請求並查看結果。如果您選擇了多個不兼容的尺寸，則會看到一條消息，說明該效果。

注意：您不能返回該字段 video.custom_fields，但在某些情況下，能夠返回 video.custom_fields.{field_name}。如下所示，但是由於 {field_name} 不是真實的字段名稱，將不會在示例請求中使用。

輸入

選擇要報告的維度：

要返回的字段：

（使用樣本Brightcove帳戶）

數據 ad_mode_begin, ad_mode_complete和 play_request 從06年13月2016日開始可用。

產量

最早的 `from` 此維度組合的日期：

示例API請求：

響應數據

  Response will appear here...

筆記

默認情況下， video_view 是唯一返回的字段-其他字段只有在 fields 參數。
如果您指定要返回的維度或維度組合不支持的字段， UNSUPPORTED_FIELD_COMBINATION_ERROR 錯誤將被返回。
bytes_delivered 字段包含所有數據live紅由 Video Cloud 給客戶，包括視頻數據，圖像，文本軌道和其他資產，以及 player 代碼本身。其中一些數據是從CDN獲得的，可能長達3天都無法使用。
除了顯示的字段 video 尺寸，您還可以返回 video.custom_fields.{field_name}

範例要求

獲取多個維度的報告的典型用例：您想要細分台式機和移動設備之間的視頻觀看次數，還想知道iOS和Android設備上分別有多少個移動設備觀看次數，以及有多少台式機在Mac和Windows機器上查看。目前，Studio Analytics Module中沒有提供此信息的標準報告，但您可以通過此報告獲取 Analytics API 呼叫：

  https://analytics.api.brightcove.com/v1/data?accounts=57838016001&dimensions=video,device_type,device_os&from=2014-01-01&to=2014-04-01&fields=video_view

（在這種情況下，我們要求1年1月2014日至XNUMX月XNUMX日的視頻觀看次數。）

使用cURL的示例

如果您想嘗試使用捲曲，這裡有幾點注意事項：

您首先需要獲得一個訪問令牌
由於請求的網址將始終包含網址參數，則需要將其用引號引起來（單引號或雙引號）

樣本

這是一個示例cURL命令：

  curl -s --header "Authorization: Bearer $ACCESS_TOKEN" \
  "https://analytics.api.brightcove.com/v1/data?accounts=$ACCOUNT_ID&dimensions=video&from=2017-04-04&limit=100"

如果您更換 $ACCESS_TOKEN 使用有效的訪問令牌，以及 $ACCOUNT_ID 使用您的帳戶ID，此請求應該可以使用。請注意，您可以使用這個示例應用生成訪問令牌。

支持的尺寸組合

為了快速參考，下表顯示了受支持的尺寸組合。請注意，在某些情況下可以使用兩個以上的尺寸。您可以使用尺寸和領域上面的工具。

支持的尺寸組合
	`account`	`browser_type`	`city`	`country`	`date`	`date_hour`	`destination_domain`	`destination_path`	`device_os`	`device_manufacturer`	`device_type`	`live_stream`	`player`	`referrer_domain`	`region`	`search_terms`	`social_platform`	`source_type`	`video`
`account`	N / A
`browser_type`		N / A
`city`			N / A
`country`				N / A
`date`					N / A
`date_hour`						N / A
`destination_domain`							N / A
`destination_path`								N / A
`device_os`									N / A
`device_manufacturer`										N / A
`device_type`											N / A
`live_stream`												N / A
`player`													N / A
`referrer_domain`														N / A
`region`															N / A
`search_terms`																N / A
`social_platform`																	N / A
`source_type`																		N / A
`video`																			N / A

參數

下表總結了 Analytics API。在以下各節中將更詳細地討論參數的使用。

參數	需要的	產品描述	價值觀	預設產品

帳號

Video Cloud 要使用其報告的帳戶是使用 accounts 參數。例如：

  https://analytics.api.brightcove.com/v1/data?accounts={account1_id,account2_id}

哪裡過濾

過濾器的一般語法為：

where=dimension1==value1;dimension2==value2

例如：

https://analytics.api.brightcove.com/v1?accounts=account_id(s)&dimensions=device_type&where=video==video_id;device_type==tablet

逗號被視為邏輯“或”，分號被視為邏輯“與”。例如， where=video==1234,5678;player==9876 解釋為“其中視頻= 1234 OR 5678 與 player = 9876“

空格和特殊字符

字符串值應為URI編碼。您還可以使用“”轉義特殊字符：

where=search_terms==boston,%20ma

您可以使用任何維度作為過濾器， 但僅由如果該尺寸也包含在 dimensions 您正在要求。

按視頻屬性過濾

使用特殊 where=video.q=={property}:{value} 過濾器，您可以根據多種屬性將報告限制為一組特定的視頻，包括：

標籤
reference_id
custom_fields ^[1]
{a_specific_custom_field}
created_at

筆記

^[1] 基本語法是 where=video.q==custom_fields:value （與任何自定義字段中的值匹配）或 where=video.q==myfield:value （與特定自定義字段中的值匹配 myfield）。如果要搜索特定的自定義字段，請注意，必須在 內部名稱，而不是顯示名稱：

快速檢查一下您是否使用了正確的名稱：內部名稱為 全部小寫且不包含空格.

範例檔案

這是一些例子 where 用於搜索標籤和自定義字段的過濾器：

單標籤

where=video.q==tags:foo

多個標籤：

where=video.q==tags:foo,bar

自定義字段

where=video.q==custom_fields:foo

標籤和自定義字段

where=video.q==tags:foo,bar+custom_fields:fish

請注意 video.q 搜索功能包括 AND, OR 以及 NOT 邏輯如下：

A + 搜索詞前的加號（加號）表示結果 必須的， 包括這個詞。
A - 搜索字詞前的（減號）表示結果不得包括這個詞。
如果沒有加號或減號，則結果可能包括也可能不包括該術語。

以下示例說明了此邏輯的用法。

搜索示例
`where` 篩選	效果見證
`where=video.q==tags:red%20tags:blue%tags:green`	帶有標籤的視頻 `red` OR `blue` OR `green` 將返回
`where=video.q==+tags:red%20tags:blue%tags:green`	返回的視頻必須具有標籤 `red` AND可能有標籤 `blue` OR `green`
`where=video.q==+tags:red%20tags:blue%-tags:green`	返回的視頻必須具有標籤 `red` AND可能有標籤 `blue`，但不能帶有標籤 `green`

備註： %20 在上面的示例中，是URI編碼的空間。根據您用於發出請求的客戶端，您可能還需要對 + 簽為 %2B.

有關此查詢語法的完整說明，請參見使用 CMS API：搜索視頻.

過濾器和允許值的摘要

下表顯示了用作過濾器的每個維度的允許值：

尺寸過濾器	允許值

日期範圍

日期範圍，在 from 以及 to 所有類型的報告的參數可以用不同的格式表示：

文字值：
- to=now （可用以及所有請求的默認值）
紀元時間值（以毫秒為單位），例如 1377047323000
以ISO 8601標準國際日期格式表示的日期： YYYY-MM-DD格式，例如 2013-09-12。對於以這種格式表示的日期：
- 指定的任何日期範圍將被解釋 在為帳戶設置的時區中
- 給出日期的時間將被解釋為午夜（ 00:00:00）在指定的日期 在為帳戶設置的時區中
相對日期：您可以表達 to 以及 from 相對於另一個值的天數（天）或小時（小時）。例如：
- from=2015-01-01&to=31d
- from=-48h&to=now
- from=-2d&to=now （將提供與前面的示例相同的結果）
- from=-365d&to=2014-12-31
請注意，負數（-2d）被解釋為“在”之前（另一個值），正數（48h）被解釋為“從”（另一個值）

要針對某一天（例如“視頻”）生成報表，請設置該日期的to和from值：

...&dimensions=video&from=2013-11-01&to=2013-11-01

限制和偏移

limit 是要返回的項目數（默認值：10）。要退回所有物品，請使用 limit=all. offset 是要跳過的項目數（默認值：0）。您可以使用 limit 以及 offset 一起創建一個可以瀏覽結果的應用程序。

對帳數據

reconciled 參數是布爾值。如果設置為 true，結果將僅限於對帳數據。如果 false，結果將僅限於實時（每小時未對帳）數據。

實時數據僅適用於前32天。如果您設定 reconciled=false 和 from 如果日期早於32天，則API將不返回任何數據，因為此時沒有未對帳的數據。

地理報告

地理分析的維度

country -作為ISO-3611-1國家/地區代碼。例如：“美國”
region -作為ISO-3611-2區域代碼。例如：“ US-WA”
city - 城市名稱。例如：西雅圖

注意：對於未知的國家或地區，API返回“ ZZ”作為代碼（根據ISO-3611-alpha2）。

字段和排序

使用 fields 參數以指定要返回的字段。默認， video_view 返回，並且對應於您要報告的維度的字段（例如 destination_domain）返回。看到尺寸和領域更多的細節。

使用 sort 用於指定使用哪個度量標準字段對返回的項目進行排序的參數；例如： sort=video_view。您可以通過否定排序字段來反轉排序順序： sort= -video_view

可用於返回或排序的字段取決於度量返回您要報告的維度。這些參數經過嚴格驗證，如果您的請求將返回錯誤， fields or sort 參數指向對請求無效的字段。

對於視頻尺寸報告，有效的排序值包括視頻元數據字段： video.name, video.reference_id和 video.tags.

計算字段

您可以使用以下語法將計算出的字段添加到您的API請求中：

fields=calulated_field_name:expression

您可以使用計算字段來根據現有指標創建自己的自定義字段，也可以重命名現有字段。

計算字段的名稱可以是任何與URI兼容的字符串。該表達式可以包含常規字段名稱和以下算術運算符：

+ （加成）
- （減法）
* （乘法）
/ （師）
^ （指數）
() （括弧）

範例檔案

fields=avg_seconds_viewed:video_seconds_viewed/video_view,video.name

fields=avg_incomplete_ads:(ad_mode_begin-ad_mode_complete)/video_view,video.name

fields=Video%20Views:video_view,video.name

樣品要求

https://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=video&fields=avg_seconds_viewed:video_seconds_viewed/video_view,video_seconds_viewed,video.name&sort=-video_view&limit=4

樣本響應（對以上請求）

{
  "item_count": 110,
  "items": [
    {
      "avg_seconds_viewed": 2152.2519913106444,
      "video.name": "Flamingos",
      "video_seconds_viewed": 2972260,
      "video": "4825279519001",
      "video_view": 1381
    },
    {
      "avg_seconds_viewed": 14.016225448334756,
      "video.name": "Tiger",
      "video_seconds_viewed": 16413,
      "video": "4093643993001",
      "video_view": 1171
    },
    {
      "avg_seconds_viewed": 12.06,
      "video.name": "Zebra",
      "video_seconds_viewed": 9045,
      "video": "3851389913001",
      "video_view": 750
    },
    {
      "avg_seconds_viewed": 23.343065693430656,
      "video.name": "Sea-SeaTurtle",
      "video_seconds_viewed": 15990,
      "video": "1754276205001",
      "video_view": 685
    }
  ],
  "summary": {
    "avg_seconds_viewed": 274.27374399301004,
    "video_seconds_viewed": 3139063,
    "video_view": 11445
  }
}

頁面內容

概述：尺寸，字段和參數

尺寸和領域

選擇要報告的維度：

要返回的字段：選擇全部取消全選

最早的 from 此維度組合的日期：

示例API請求：

響應數據

筆記

範例要求

使用cURL的示例

樣本

支持的尺寸組合

參數

帳號

哪裡過濾

空格和特殊字符

按視頻屬性過濾

筆記

範例檔案

單標籤

多個標籤：

自定義字段

標籤和自定義字段

過濾器和允許值的摘要

日期範圍

限制和偏移

對帳數據

地理報告

地理分析的維度

字段和排序

計算字段

範例檔案

樣品要求

樣本響應（對以上請求）

要返回的字段：

最早的 `from` 此維度組合的日期：