TOP视频播放数据统计_播放数据_数据统计_服务端API

描述

获取每日TOP视频的播放数据统计（包括VV、UV和播放总时长）。

注意：

最多可查询该日 Top1000 的视频播放统计数据，Top视频列表默认基于VV数排序。
仅支持使用了阿里云点播播放器SDK的播放数据统计。
以北京时间（UTC+8）为基准，每天上午9点生成前一天的播放数据统计。
支持查询 2018-01-01 起的数据，数据查询的起止时间跨度最大为90天。

请求参数

参数	类型	是否必需	描述
Action	String	是	操作接口名，系统规定参数。取值：DescribePlayTopVideos
BizDate	String	是	日期。UTC格式，例如：2018-01-29T00:00:00Z。
PageNo	Long	否	分页页码。默认值：1。
PageSize	Long	否	分页大小。默认值：100。最大值：1000。

返回参数

参数	类型	描述
PageSize	Long	分页大小
PageNo	Long	分页页码
TotalNum	Long	TOP视频播放统计数据的总条数
TopPlayVideos	TopPlayVideoStatis	每日播放top统计数据
RequestId	String	请求ID

示例

请求示例

https://vod.cn-shanghai.aliyuncs.com?Action=DescribePlayTopVideos
&BizDate=2018-01-01T00:00:00Z
&PageNo=1&PageSize=1000
&<公共请求参数>

注意：示例中的“公共参数”参见公共参数说明文档。

正常返回示例

JSON格式

{
    "PageNo":"1",
    "PageSize":"1000",
    "RequestId":"4B0BCF9F-2FD5-4817-B00D-7BEBBE3AF90B",
    "TopPlayVideos":{
        "TopPlayVideoStatis":[
            {
                "PlayDuration":"4640369",
                "Title":"4路（2路加密）：流畅-HLS-加密+标清-MP4+高清-H",
                "UV":"1",
                "VV":"107",
                "VideoId":"2a8d4cb9ecbb487681473a153aba8fda"
            },
            {
                "PlayDuration":"4689369",
                "Title":"2路（全加密）：标清-HLS-加密+超清-HLS-加密",
                "UV":"1",
                "VV":"33",
                "VideoId":"cca9dbd11b7045808cc9babc56f5bad2"
            }
        ]
    },
    "Total":"150"
}

异常返回示例

JSON格式

{
    "Code":"InvalidStartTime.Malformed",
    "HostId":"vod.cn-shanghai.aliyuncs.com",
    "Message":"Specified StartTime is malformed.",
    "RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720"
}

错误码

下表列举了本接口特有的错误码。视频点播通用的错误码信息，参见错误码表。

错误代码	错误信息	HTTP 状态码	说明
InternalError	The request processing has failed due to some unknown error.	500	后台发生未知错误。
InvalidBizDate.Malformed	Specified BizDate is malformed.	400	BizDate格式错误，应为UTC格式，例如：2018-06-29T19:00:00Z。
InvalidBizDate.BeyondCurrent	EndTime beyond current time.	400	BizDate不能超过当前时间。