DescribeVodPlayerCollectData - 播放器播放汇总数据查询

查询播放器播放汇总的数据。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vod:DescribeVodPlayerCollectData

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
Os	string	否	播放端的操作系统。传入此参数，可筛选查询指定操作系统的播放数据。取值包含：Android 、iOS、Harmony、Windows、MacOS 和 Linux。不同端类型可选取值不同，对应关系如下： native：Android、iOS、Harmony。 web：Android、iOS、Harmony、Windows、MacOs、Linux。多个 os 以 #_#进行分隔。	Android、iOS、Windows
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
Period	string	否	用于确认环比分析的时间范围，单位天（d）。例如当传值 1d（1 天）时，会取环比时间为 StartTime-1d ～EndTime-1d 作为环比数据的时间范围。	1d

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	25818875-5F78-4AF6-D7393642CA58****
DataList	array<object>	返回数据列表。
	object
Metric	string	返回的数据指标。	Vv
Value	number	返回的数据指标数值。	100.0
ValueRefer	number	返回的数据指标环比数值。	200.0
ValueRatio	number	环比百分比。	0.5

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "DataList": [
    {
      "Metric": "Vv",
      "Value": 100,
      "ValueRefer": 200,
      "ValueRatio": 0.5
    }
  ]
}

错误码

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.	数据还未准备

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

变更历史

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