调用本接口获取每日TOP视频的播放数据统计，统计指标包括播放次数、播放用户数和播放总时长。
接口说明
- 目前服务地址仅支持：华东 2（上海）。
- 最多可查询当日 Top1000 的视频播放统计数据，Top 视频列表默认基于播放次数进行倒序排序。
- 仅支持统计使用了阿里云播放器 SDK 的播放数据。
- 以北京时间（UTC+8）为基准，每天上午 9 点生成前一天的播放数据统计。
- 支持查询 2018-01-01 之后的数据，数据查询的起止时间跨度最大为 180 天。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vod:DescribePlayTopVideos | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BizDate | string | 是 | 指定查询的日期。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 | 2016-06-29T13:00:00Z |
| PageNo | long | 否 | 分页的页码。默认值：1。 | 1 |
| PageSize | long | 否 | 每页大小，每页显示的条数。默认值为 100，最大值为 1000。 | 100 |
返回参数
示例
正常返回示例
JSON格式
{
"PageNo": 1,
"RequestId": "4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B\"",
"PageSize": 100,
"TotalNum": 2,
"TopPlayVideos": {
"TopPlayVideoStatis": [
{
"Title": "阿里云视频",
"VV": "107",
"PlayDuration": "4640369",
"VideoId": "2a8d4cb9ecbb487681473a15****8fda",
"UV": "1"
}
]
}
}错误码
访问错误中心查看更多错误码。
接口错误码
下表列举了本接口特有的错误码。
| 错误代码 | 错误信息 | HTTP 状态码 | 说明 |
|---|---|---|---|
| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |
| InvalidBizDate.Malformed | Specified BizDate is malformed. | 400 | BizDate 格式错误。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
| InvalidBizDate.BeyondCurrent | EndTime beyond current time. | 400 | BizDate 不能超过当前时间。 |