调用本接口获取每日TOP视频的播放数据统计,统计指标包括播放次数、播放用户数和播放总时长。
接口说明
目前服务地址仅支持:华东 2(上海)。
最多可查询当日 Top1000 的视频播放统计数据,Top 视频列表默认基于播放次数进行倒序排序。
仅支持统计使用了阿里云播放器 SDK 的播放数据。
以北京时间(UTC+8)为基准,每天上午 9 点生成前一天的播放数据统计。
支持查询 2018-01-01 之后的数据,数据查询的起止时间跨度最大为 180 天。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
vod:DescribePlayTopVideos |
get |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
BizDate |
string |
是 |
指定查询的日期。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2016-06-29T13:00:00Z |
PageNo |
integer |
否 |
分页的页码。默认值:1。 |
1 |
PageSize |
integer |
否 |
每页大小,每页显示的条数。默认值为 100,最大值为 1000。 |
100 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
PageNo |
integer |
分页的页码。 |
1 |
RequestId |
string |
请求 ID。 |
4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B" |
PageSize |
integer |
每页大小。 |
100 |
TotalNum |
integer |
TOP 视频的总条数。 |
2 |
TopPlayVideos |
object |
||
TopPlayVideoStatis |
array<object> |
TOP 视频的当日播放数据。 |
|
object |
|||
Title |
string |
视频名称。 |
阿里云视频 |
VV |
string |
播放次数。 |
107 |
PlayDuration |
string |
播放总时长。单位:毫秒。 |
4640369 |
VideoId |
string |
视频 ID。 |
2a8d4cb9ecbb487681473a15****8fda |
UV |
string |
播放用户数。 |
1 |
示例
正常返回示例
JSON
格式
{
"PageNo": 1,
"RequestId": "4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B\"",
"PageSize": 100,
"TotalNum": 2,
"TopPlayVideos": {
"TopPlayVideoStatis": [
{
"Title": "阿里云视频",
"VV": "107",
"PlayDuration": "4640369",
"VideoId": "2a8d4cb9ecbb487681473a15****8fda",
"UV": "1"
}
]
}
}
异常返回示例
JSON
格式
{
"RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720",
"HostId":"vod.cn-shanghai.aliyuncs.com",
"Code":"InvalidStartTime.Malformed",
"Message":"Specified StartTime is malformed."
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidBizDate.Malformed | Specified BizDate is malformed. | |
400 | InvalidBizDate.BeyondCurrent | BizDate beyond current time. | |
400 | InvalidParamter | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。