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

描述

获取指定视频在指定时间范围内的每日播放统计数据。

注意：

仅支持使用了阿里云点播播放器SDK的播放数据统计。
以北京时间（UTC+8）为基准，每天上午9点生成前一天的播放数据统计。
仅支持最近2年内（730天）的数据查询，且数据查询的起止时间跨度最大为180天。

请求参数

参数	类型	是否必需	描述
Action	String	是	操作接口名，系统规定参数。取值：DescribePlayVideoStatis
StartTime	String	是	起始时间。 UTC格式，例如：2018-01-29T00:00:00Z。支持查询2018-01-01起的数据，即 StartTime 大于等于 2018-01-01T00:00:00Z。
EndTime	String	是	结束时间。UTC格式，例如：2018-02-01T00:00:00Z。
VideoId	String	是	指定视频的视频ID。

返回参数

参数	类型	描述
RequestId	String	请求ID。
VideoPlayStatisDetails	VideoPlayStatisDetail	指定视频的每日统计数据。

示例

请求示例

https://vod.cn-shanghai.aliyuncs.com?Action=DescribePlayVideoStatis
&Interval=day
&StartTime=2018-01-01T00:00:00Z
&EndTime=2018-01-02T00:00:00Z
&VideoId=2a8d4cb9ecbb*****1473a153aba8fda
&<公共请求参数>

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

正常返回示例

JSON格式

{
    "RequestId":"A92D3600-A3E7-43*****D9-B6E3B4A1FE6B",
    "VideoPlayStatisDetails":{
        "VideoPlayStatisDetail":[
            {
                "Date":"20180101",
                "PlayDuration":"3288",
                "PlayRange":"<=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2%",
                "Title":"4路（1路加密）：流畅-HLS+标清-MP4+高清-HLS-加密+超清-MP4",
                "UV":"1",
                "VV":"1"
            },
            {
                "Date":"20180102",
                "PlayDuration":"967277",
                "PlayRange":"<=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2%",
                "Title":"4路（1路加密）：流畅-HLS+标清-MP4+高清-HLS-加密+超清-MP4",
                "UV":"1",
                "VV":"24"
            }
        ]
    }
}

异常返回示例

JSON格式

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

错误码

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

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