调用本接口获取指定时间范围内的每日播放数据均量统计,统计指标包括平均播放时长、平均播放次数。
接口说明
目前服务地址仅支持:华东 2(上海)。
仅支持使用了阿里云播放器 SDK 的播放数据统计。
以北京时间(UTC+8)为基准,每天上午 9 点生成前一天的播放数据统计。
支持查询 2018-01-01 之后的数据,数据查询的起止时间跨度最大为 180 天。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:DescribePlayUserAvg |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| StartTime |
string |
是 |
指定查询的起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2016-06-29T13:00:00Z |
| EndTime |
string |
是 |
指定查询的结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
结束时间需大于起始时间,且与起始时间的最大跨度为 180 天。 |
2016-06-30T13:00:00Z |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
6C7F90B2-BDA4-4FAC-****-A38A121DFE19 |
| UserPlayStatisAvgs |
object |
||
| UserPlayStatisAvg |
array<object> |
用户每天平均播放均值统计数据。 |
|
|
object |
|||
| Date |
string |
播放日期,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2016-06-30T13:00:00Z |
| AvgPlayDuration |
string |
平均播放时长。单位:毫秒。 |
1035902.8 |
| AvgPlayCount |
string |
平均播放次数。 |
2.0 |
示例
正常返回示例
JSON格式
{
"RequestId": "6C7F90B2-BDA4-4FAC-****-A38A121DFE19",
"UserPlayStatisAvgs": {
"UserPlayStatisAvg": [
{
"Date": "2016-06-30T13:00:00Z",
"AvgPlayDuration": "1035902.8",
"AvgPlayCount": "2.0"
}
]
}
}
异常返回示例
JSON格式
{
"RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720",
"HostId":"vod.cn-shanghai.aliyuncs.com",
"Code":"InvalidStartTime.Malformed",
"Message":"Specified StartTime is malformed."
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | 开始时间格式错误。 |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 结束时间格式错误。 |
| 400 | InvalidEndTime.BeyondCurrent | EndTime beyond current time. | |
| 400 | InvalidParamter | %s | |
| 400 | InvalidEndTime.Mismatch | StartTime or EndTime is mismatch. | 开始时间与结束时间不匹配 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。