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

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

调试

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

请求参数

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

系统规定参数。取值:DescribePlayUserTotal

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 1FAFB884-D5A7-47D1-****-8928AA9C8720

请求ID。

UserPlayStatisTotals Array of UserPlayStatisTotal

用户每天播放总量统计数据。

UserPlayStatisTotal
Date String 20170120

日期。格式为:yyyyMMdd

PlayDuration String 9340070

播放总时长。单位:毫秒。

PlayRange String "<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%"

播放时长分布。

VV Object

播放次数总量统计。

Flash String 2

Flash播放器播放总次数。

iOS String 0

IOS播放器播放总次数。

HTML5 String 2

Html5播放器播放总次数。

Android String 161

Android播放器播放总次数。

UV Object

播放用户数总量统计。

Flash String 1

Flash播放器播放总用户数。

iOS String 0

IOS播放器播放总用户数。

HTML5 String 1

Html5播放器播放总用户数。

Android String 2

Android播放器播放总用户数。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribePlayUserTotalResponse>
    <UserPlayStatisTotals>
		<UserPlayStatisTotal>
			<PlayRange>&lt;=1m:74.3%;&gt;1&lt;=5m:22.8%;&gt;5&lt;=10m:1.0%;&gt;10&lt;=15m:1.0%;&gt;15&lt;=30m:1.0%</PlayRange>
			<Date>20180101</Date>
			<VV>
				<Android>101</Android>
				<iOS>1</iOS>
			</VV>
			<PlayDuration>6215417</PlayDuration>
			<UV>
				<Android>5</Android>
				<iOS>1</iOS>
			</UV>
		</UserPlayStatisTotal>
		<UserPlayStatisTotal>
			<PlayRange>&lt;=1m:73.6%;&gt;1&lt;=5m:23.9%;&gt;5&lt;=10m:2.5%</PlayRange>
			<Date>20180102</Date>
			<VV>
				<Android>161</Android>
				<Flash>2</Flash>
				<HTML5>1</HTML5>
			</VV>
			<PlayDuration>9340070</PlayDuration>
			<UV>
				<Android>1</Android>
				<Flash>2</Flash>
				<HTML5>1</HTML5>
			</UV>
		</UserPlayStatisTotal>
	</UserPlayStatisTotals>
	<RequestId>0B9BA42C-8BDE-4611-****-C856BBE20898</RequestId>
</DescribePlayUserTotalResponse>

JSON格式

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

{
  "UserPlayStatisTotals" : {
    "UserPlayStatisTotal" : [ {
      "PlayRange" : "<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%",
      "Date" : "20180101",
      "VV" : {
        "Android" : "101",
        "iOS" : "1"
      },
      "PlayDuration" : "6215417",
      "UV" : {
        "Android" : "5",
        "iOS" : "1"
      }
    }, {
      "PlayRange" : "<=1m:73.6%;>1<=5m:23.9%;>5<=10m:2.5%",
      "Date" : "20180102",
      "VV" : {
        "Android" : "161",
        "Flash" : "2",
        "HTML5" : "1"
      },
      "PlayDuration" : "9340070",
      "UV" : {
        "Android" : "1",
        "Flash" : "2",
        "HTML5" : "1"
      }
    } ]
  },
  "RequestId" : "0B9BA42C-8BDE-4611-****-C856BBE20898"
}

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

InternalError

The request processing has failed due to some unknown error.

500

后台发生未知错误。

InvalidStartTime.Malformed

Specified StartTime is malformed.

400

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

InvalidEndTime.Malformed

Specified EndTime is malformed.

400

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

InvalidEndTime.BeyondCurrent

EndTime beyond current time.

400

EndTime不能超过当前时间。

InvalidEndTime.Mismatch

StartTime or EndTime is mismatch.

400

StartTime和EndTime 不匹配。