全部產品
Search

搜尋本產品

    ApsaraVideo VOD：DescribeVodPlayerMetricData - 播放器播放資料查詢

    文件中心

    ApsaraVideo VOD：DescribeVodPlayerMetricData - 播放器播放資料查詢

    更新時間：Aug 10, 2025

    查詢播放器指標資料。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vod:DescribeVodPlayerMetricData

    none

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    AppId

    string

    是

    應用 ID。

    app-1000000
    StartTime

    string

    是

    查詢的開始時間。格式為：yyyy-mm-ddthh:mm:ssz（utc 時間）。

    說明

    • 支援近一年播放資料歷史查詢。

    • 單次查詢時間範圍不超過 31 天。

    • 時間區間為左閉右開[StartTime, EndTime)。

    2025-06-24T00:55:06Z
    EndTime

    string

    是

    查詢的結束時間。格式為：yyyy-mm-ddthh:mm:ssz（utc 時間）。

    2025-06-05T15:59:59Z
    Interval

    string

    是

    設定查詢資料的時間粒紋。取值：5m、1h 和 1d。根據您指定的StartTime和EndTime的時間跨度，支援設定的時間粒紋如下：

    • 3 天以內支援：5m、1h 和 1d。

    • 4-7 天內支援：1h 和 1d。

    • 7 天以上支援：1d。

    1d
    TerminalType

    string

    是

    終端類型。取值：

    • web：web 端。

    • mobile：native 端。

    web
    Filters

    string

    否

    指標維度篩選器，維度由維度類型（Field）、操作符號（Op）、維度值組成。

    說明

    • 最多指定三個維度。

    • 當 Metrics 參數包含以下四種指標時，Filters 篩選不生效：Uv（播放使用者數）、 AvgPerVv（人均播放次數）、AvgPerPlayDuration（人均播放時間長度）、AvgPerCompletionVv（人均完播次數）。

    • 省份和國家傳遞用 regionCode 即可。

    • 多個 value 在傳參時採取用#_#分隔。

    維度類型（Field）取值如下：

    • SdkVersion：SDK 版本。

    • AppVersion：APP 版本。

    • Codec：編碼格式。

    • VideoType：視頻格式。

    • Network：網路類型。

    • Country：國家。

    • Isp：電訊廠商。

    • VideoDefinition：解析度。

    • Domain：網域名稱。

    • Province：省份。

    • IsHw：是否硬解。

    • ErrorCode：錯誤碼。

    操作符號（Op）取值為：=（等於）、>（大於）、<（小於）和!=（不等於）。

    說明

    • 操作符可選情況為：SdkVersion、VideoDefinition 指標支援所有四種操作符，其他指標只支援=（等於）和!=（不等於）。

    維度值請通過 DescribeVodPlayerDimensionData 擷取。

    [ { "Field": "codec", "Op": "=", "Value": "h265#_#h264" }, { "Field": "os", "Op": "=", "Value": "Android#_#iOS" } ]
    Metrics

    string

    是

    指標類型，支援多選（最多支援 3 個指標）。

    說明

    • 百分比資料傳回值為小數形式。

    播放品質 QoS 指標：

    • Vv：播放次數 。

    • RealVv：實際播放量。

    • FirstFrame：首幀時間。

    • SecondPlayRate：秒開率。

    • SlowPlayRate：慢開率。

    • StuckCountRate：次數卡頓率。

    • SeekDuration：seek 耗時。

    • StuckDuration100s：百秒卡頓耗時。

    • StuckCount100s：百秒卡頓次數 。

    • PlayFailRate:播放失敗率。

    • SeedFailRate：未起播率。

    • AvgPlayBitrate：平均播放碼率。

    • AvgStartBitrate：平均起播碼率。

    • ErrorCount100s：百秒錯誤次數。

    播放體驗 QoE 指標：

    • Uv：播放使用者數。

    • AvgPerVv：人均播放次數。

    • AvgVideoDuration：平均視頻時間長度。

    • AvgPerPlayDuration：人均播放時間長度。

    • AvgPerCompletionVv：人均完播次數。

    • CompletionVv：完播量。

    • CompletionRate：完播率。

    • AvgPlayDuration：平均播放時間長度。

    • JumpRate5s：5 秒跳出率。

    Vv,Uv,AvgPerVv
    Top

    integer

    否

    取播放量排名前 top 的資料展示，不傳值時返回全量維度資料。

    5
    PageNumber

    integer

    否

    頁碼。預設值為 1。

    1
    PageSize

    integer

    否

    分頁大小，每頁顯示的條目數。預設值：5000。最大值：5000。

    5000
    Language

    string

    否

    請求返回的語言。取值：

    • zh（預設）：表示簡體中文。

    • en：表示英文。

    zh
    Os

    string

    否

    播放端的作業系統。傳入此參數，可篩選查詢指定作業系統的播放資料。取值包含：Android 、iOS、Harmony、Windows、MacOS 和 Linux。 不同端類型可選取值不同，對應關係如下：

    • native：Android、iOS、Harmony。

    • web：Android、iOS、Harmony、Windows、MacOs、Linux。

    多個 os 以 #_#進行分隔。

    Android、iOS、Windows

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    Id of the request

    25818875-5F78-4A*****F6-D7393642CA58
    PageNumber

    integer

    當前頁碼。

    1
    PageSize

    integer

    分頁大小。

    5000
    TotalCnt

    integer

    資料點總個數。

    500
    DataList

    array<object>

    返回資料列表。

    object

    TimeStamp

    string

    資料返回時間戳記。格式為：yyyy-mm-ddthh:mm:ssz（utc 時間）。

    2025-06-24T00:55:06Z

    Dimension

    string

    維度。

    H265_MP4_WIFI
    Uv

    number

    播放使用者數。

    500
    Vv

    number

    播放次數。

    800
    RealVv

    number

    實際播放量。

    1000
    FirstFrame

    number

    首幀時間，單位毫秒（ms）。

    100
    SecondPlayRate

    number

    秒開率。

    0.8
    SlowPlayRate

    number

    慢開率。

    0.2
    StuckCountRate

    number

    次數卡頓率。

    0.1
    SeekDuration

    number

    seek 耗時，單位毫秒（ms）。

    100
    StuckDuration100s

    number

    百秒卡頓耗時，單位毫秒（ms）。

    200
    PlayFailRate

    number

    播放失敗率。

    0.2
    SeedFailRate

    number

    未起播率。

    0.01
    AvgPlayBitrate

    number

    平均播放碼率，單位為 bps。

    100
    AvgStartBitrate

    number

    平均起播碼率，單位為 bps。

    100
    ErrorCount100s

    number

    百秒錯誤次數。

    1
    AvgPerVv

    number

    人均播放次數。

    10
    AvgVideoDuration

    number

    平均視頻時間長度，單位毫秒（ms）。

    100000
    AvgPerPlayDuration

    number

    人均播放時間長度，單位毫秒（ms）。

    100000
    AvgPerCompletionVv

    number

    人均完播次數。

    2
    CompletionVv

    number

    完播量。

    500
    CompletionRate

    number

    完播率。

    0.8
    AvgPlayDuration

    number

    平均播放時間長度，單位毫秒（ms）。

    100000

    JumpRate5s

    number

    5 秒跳出率。

    0.1
    TotalPlayDuration

    number

    累計播放時間長度，單位毫秒（ms）。

    100000
    StuckCount100s

    string

    百秒卡頓次數 。

    2
    Extend

    object

    擴充資訊

    ActualStartTime

    string

    指定時間範圍內有資料點的最早時間，格式為：yyyy-mm-ddthh:mm:ssz（utc 時間）。

    2025-06-24T00:55:06Z
    ActualEndTime

    string

    指定時間範圍內有資料點的最晚時間，格式為：yyyy-mm-ddthh:mm:ssz（utc 時間）。

    2025-06-05T15:59:59Z
    IntervalSeconds

    integer

    查詢資料的時間粒紋，單位為秒（s）。

    3600

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "PageNumber": 1,
  "PageSize": 5000,
  "TotalCnt": 500,
  "DataList": [
    {
      "TimeStamp": "2025-06-24T00:55:06Z\n",
      "Dimension": "H265_MP4_WIFI",
      "Uv": 500,
      "Vv": 800,
      "RealVv": 1000,
      "FirstFrame": 100,
      "SecondPlayRate": 0.8,
      "SlowPlayRate": 0.2,
      "StuckCountRate": 0.1,
      "SeekDuration": 100,
      "StuckDuration100s": 200,
      "PlayFailRate": 0.2,
      "SeedFailRate": 0.01,
      "AvgPlayBitrate": 100,
      "AvgStartBitrate": 100,
      "ErrorCount100s": 1,
      "AvgPerVv": 10,
      "AvgVideoDuration": 100000,
      "AvgPerPlayDuration": 100000,
      "AvgPerCompletionVv": 2,
      "CompletionVv": 500,
      "CompletionRate": 0.8,
      "AvgPlayDuration": 100000,
      "JumpRate5s": 0.1,
      "TotalPlayDuration": 100000,
      "StuckCount100s": "2"
    }
  ],
  "Extend": {
    "ActualStartTime": "2025-06-24T00:55:06Z",
    "ActualEndTime": "2025-06-05T15:59:59Z",
    "IntervalSeconds": 3600
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Meter.ParamError Param Error:%s,Please Check Again. 參數錯誤
    500 Meter.ServerInternalError The Request Processing Has Failed Due To Some Unknown Error. 服務內部錯誤
    500 Meter.DataSourceQueryError Data Source Error:%s,Please Try Again. 服務內部資料來源錯誤
    403 Meter.AuthError Authentication Failed,Please Try Again. 使用者權限錯誤
    502 Meter.ReadyTsError Get ReadyTs Failed,Please Try Again. 資料還未準備

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。