DescribeVodPlayerMetricData - 播放器播放数据查询_视频点播(VOD)-阿里云帮助中心

查询播放器指标数据。

调试

您可以在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.	数据还未准备

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。