调用DescribePlayUserAvg获取指定时间范围内的每日播放数据均量统计。

说明
  • 目前服务地址仅支持:华东2(上海)
  • 仅支持使用了阿里云点播播放器SDK的播放数据统计。
  • 以北京时间(UTC+8)为基准,每天上午9点生成前一天的播放数据统计。
  • 支持查询2018-01-01之后的数据,数据查询的起止时间跨度最大为180天。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribePlayUserAvg

系统规定参数。取值:DescribePlayUserAvg

StartTime String 2016-06-29T13:00:00Z

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

EndTime String 2016-06-30T13:00:00Z

结束时间,需晚于起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

返回数据

名称 类型 示例值 描述
RequestId String 6C7F90B2-BDA4-4FAC-****-A38A121DFE19

请求ID。

UserPlayStatisAvgs Array of UserPlayStatisAvg

用户每天平均播放均值统计数据。

UserPlayStatisAvg
Date String 20170120

日期。格式为:yyyyMMdd

AvgPlayDuration String 1035902.8

平均播放时长。单位:毫秒。

AvgPlayCount String 170

平均播放次数。

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=DescribePlayUserAvg
&StartTime=2016-06-29T13:00:00Z
&EndTime=2016-06-30T13:00:00Z
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePlayUserAvgResponse>
	<UserPlayStatisAvgs>
		<UserPlayStatisAvg>
			<AvgPlayDuration>1035902.8</AvgPlayDuration>
			<Date>20171127</Date>
			<AvgPlayCount>17.0</AvgPlayCount>
		</UserPlayStatisAvg>
		<UserPlayStatisAvg>
			<AvgPlayDuration>3113356.7</AvgPlayDuration>
			<Date>20171128</Date>
			<AvgPlayCount>41.0</AvgPlayCount>
		</UserPlayStatisAvg>
		<UserPlayStatisAvg>
			<AvgPlayDuration>4290368.0</AvgPlayDuration>
			<Date>20171129</Date>
			<AvgPlayCount>59.8</AvgPlayCount>
		</UserPlayStatisAvg>
	</UserPlayStatisAvgs>
	<RequestId>6C7F90B2-BDA4-4FAC-****-A38A121DFE19</RequestId>
</DescribePlayUserAvgResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "UserPlayStatisAvgs" : {
    "UserPlayStatisAvg" : [ {
      "AvgPlayDuration" : "1035902.8",
      "Date" : "20171127",
      "AvgPlayCount" : "17.0"
    }, {
      "AvgPlayDuration" : "3113356.7",
      "Date" : "20171128",
      "AvgPlayCount" : "41.0"
    }, {
      "AvgPlayDuration" : "4290368.0",
      "Date" : "20171129",
      "AvgPlayCount" : "59.8"
    } ]
  },
  "RequestId" : "6C7F90B2-BDA4-4FAC-****-A38A121DFE19"
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

InternalError

The request processing has failed due to some unknown error.

500

后台发生未知错误。

InvalidStartTime.Malformed

Specified StartTime is malformed.

400

StartTime格式错误。使格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

InvalidEndTime.Malformed

Specified EndTime is malformed.

400

EndTime格式错误。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

InvalidEndTime.BeyondCurrent

EndTime beyond current time.

400

EndTime不能超过当前时间。

InvalidEndTime.Mismatch

StartTime or EndTime is mismatch.

400

StartTime和EndTime不匹配。

使用UTC时间,格式:YYYY-MM-DDThh:mm:ssZ。