调用本接口查询指定视频在指定时间范围内的每日播放统计数据,统计指标包括播放总时长、播放次数、播放用户数和播放时长分布。
接口说明
目前服务地址仅支持:华东 2(上海)。
仅支持统计使用了阿里云播放器 SDK 且单日播放次数排名前 1000 的视频播放数据。
以北京时间(UTC+8)为基准,每天上午 9 点生成前一天的播放数据统计。
仅支持最近 2 年内(730 天)的数据查询,且数据查询的起止时间跨度最大为 180 天。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:DescribePlayVideoStatis |
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 |
| VideoId |
string |
是 |
要查询的视频的视频 ID,仅支持传入一个视频 ID。可通过以下方式获取:
|
2a8d4cb9ecbb487681473****aba8fda |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
A92D3600-A3E7-43D6-****-B6E3B4A1FE6B |
| VideoPlayStatisDetails |
object |
||
| VideoPlayStatisDetail |
array<object> |
视频在指定时间段内每日的播放统计数据。 |
|
|
object |
|||
| PlayDuration |
string |
播放总时长。单位:毫秒。 |
967277 |
| Date |
string |
播放日期,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2024-06-12T16:00:00Z |
| VV |
string |
播放次数。 |
24 |
| Title |
string |
视频名称。 |
Alibaba Cloud video |
| UV |
string |
播放用户数。 |
1 |
| PlayRange |
string |
播放时长分布。 |
<=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2% |
示例
正常返回示例
JSON格式
{
"RequestId": "A92D3600-A3E7-43D6-****-B6E3B4A1FE6B",
"VideoPlayStatisDetails": {
"VideoPlayStatisDetail": [
{
"PlayDuration": "967277",
"Date": "2024-06-12T16:00:00Z",
"VV": "24",
"Title": "Alibaba Cloud video",
"UV": "1",
"PlayRange": "<=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2%"
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | 开始时间格式错误。 |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 结束时间格式错误。 |
| 400 | InvalidParamter | %s | |
| 400 | InvalidEndTime.Mismatch | StartTime or EndTime is mismatch. | 开始时间与结束时间不匹配 |
| 400 | InvalidEndTime.BeyondCurrent | EndTime beyond current time. | |
| 400 | InvalidParameter | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。