查询媒体文件的播放统计数据

最近更新时间:2024-03-12 02:01:12

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

该接口用于查询指定日期范围内每天的播放统计数据。

  • 可以查询最近一年的播放统计数据。
  • 结束日期和起始日期的时间跨度最大为90天。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDailyMediaPlayStat。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
FileId String 媒体文件 ID 。
示例值:523123456
StartDate String 起始日期,使用 ISO 日期格式。该参数仅日期部分有效。
示例值:2023-08-01T10:00:00Z
EndDate String 结束日期,使用 ISO 日期格式。该参数仅日期部分有效。
示例值:2023-08-02T10:00:00Z
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:1490012345

3. 输出参数

参数名称 类型 描述
DailyPlayStatInfoSet Array of DailyPlayStatInfo 播放统计数据。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询从2021-01-01到2021-01-02的媒体文件5285485487985271487的播放统计数据

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeDailyMediaPlayStat
&FileId=5285485487985271487
&StartDate=2021-01-01T00:00:00+08:00
&EndDate=2021-01-10T00:00:00+08:00
&<公共请求参数>

输出示例

{
    "Response": {
        "DailyPlayStatInfoSet": [
            {
                "FileId": "5285485487985271487",
                "Date": "2021-01-01T00:00:00+08:00",
                "PlayTimes": 13,
                "Traffic": 23434
            },
            {
                "FileId": "5285485487985271487",
                "Date": "2021-01-02T00:00:00+08:00",
                "PlayTimes": 3,
                "Traffic": 2334
            }
        ],
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InvalidParameterValue.EndDate 参数值错误:EndDate 无效。
InvalidParameterValue.FileId FileId 不存在。
InvalidParameterValue.StartDate 参数值错误:StartDate 无效。