You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/数据统计/播放统计/查询播放 TopN 的视频
查询播放 TopN 的视频
最近更新时间：2024.06.14 17:20:13首次发布时间：2022.09.27 21:09:36
我的收藏

此接口用于在指定空间下，查询一定时间范围内播放 TopN 的视频信息。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。

  • 在 HLS 协议视频中，当 M3U8 文件和 TS 分片在同一目录下时，视频点播的播放统计将会同步统计 TS 分片的流量。

    说明

    当多个 M3U8 文件和相应的 TS 分片都在同一个目录下（比如根目录）时，可能会出现统计不准的情况。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeVodMostPlayedStatisData&Version=2020-08-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数
类型
是否必选
示例值
描述
Action
String
是
DescribeVodMostPlayedStatisData
接口名称。当前 API 的名称为 DescribeVodMostPlayedStatisData。
Version
String
是
2020-08-01
接口版本。当前 API 的版本为 2020-08-01。
Space
String
是
test

点播空间名称。您可通过以下方式获取空间名称：

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
StartTime
String
是
2023-12-23T16:00:00Z
开始时间。日期格式要求符合 RFC3339 规范
EndTime
String
是
2023-12-24T15:59:59Z

结束时间。日期格式要求符合 RFC3339 规范。

说明

最早查询 31 天内的数据。

OrderType
String
否
traffic

排序类型。取值如下：

  • count：（默认）按照次数排序。
  • traffic：按照流量降序。
TopN
Integer
否
100
返回视频的个数。默认值为 100。最大为 100。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
Space
String
test
点播空间名称。
StartTime
String
2023-12-23T16:00:00Z
开始时间，RFC3339 格式。
EndTime
String
2023-12-24T15:59:59Z
结束时间，RFC3339 格式。
OrderType
String
traffic

排序类型。取值如下：

  • count：按照次数排序。
  • traffic：按照流量降序。
TopN
Integer
100
返回视频的个数。
PlayStatInfos
Object[]
-
播放信息。
Vid
String
v02c24g10001***k792ucabrgag
视频 ID。
Name
String
水印.dash.mp4
视频名称。
Size
Integer
11135289
视频大小，单位为字节。
Duration
Float
107.867
视频长度，单位为秒。
CreateTime
String
2022-10-31 16:33:22
视频创建时间。
PlayCount
Integer
2
播放次数。
Traffic
Integer
1133
流量，单位为字节。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodMostPlayedStatisData&Version=2020-08-01&Space=test&StartTime=2023-12-23T16%3A00%3A00Z&EndTime=2023-12-24T15%3A59%3A59Z&OrderType=traffic&TopN=100

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202312251433***64896865F42EFE9",
        "Action": "DescribeVodMostPlayedStatisData",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Space": "test",
        "StartTime": "2023-12-23T16:00:00Z",
        "EndTime": "2023-12-24T15:59:59Z",
        "OrderType": "traffic",
        "PlayStatInfos": [
            {
                "Vid": "v02c24g10001cald1cbh1vq4cc06mb40",
                "Name": "od(原画转封装)，240，360，480，540，720，1080视频流",
                "Duration": 120.2,
                "Size": 32202259,
                "PlayCount": 736,
                "CreateTime": "2022-06-16 14:42:12",
                "Traffic": 212638450
            },
            {
                "Vid": "v02c24g1000***q4cc06mu9g",
                "Name": "加密，非加密od，240，360，480，540，720，1080视频流",
                "Duration": 120.2,
                "Size": 32202259,
                "PlayCount": 288,
                "CreateTime": "2022-06-16 19:54:15",
                "Traffic": 82958589
            },
            {
                "Vid": "v02c24g1000***kiv7mrolf0",
                "Name": "heihei",
                "Duration": 120.2,
                "Size": 32202259,
                "PlayCount": 2,
                "CreateTime": "2022-08-08 17:29:42",
                "Traffic": 32203993.999999996
            },
            {
                "Vid": "v02c24g10001***co9qbmp4en9g",
                "Name": "原片",
                "Duration": 120.2,
                "Size": 32202259,
                "PlayCount": 32,
                "CreateTime": "2022-06-16 20:06:16",
                "Traffic": 22175704
            },
            {
                "Vid": "v02c24g10001***k792ucabrgag",
                "Name": "水印.dash.mp4",
                "Duration": 107.867,
                "Size": 11135289,
                "PlayCount": 2,
                "CreateTime": "2022-10-31 16:33:22",
                "Traffic": 1133
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：