tencent cloud

云点播

文档云点播服务端 API 文档Data Statistics APIsDescribeMediaPlayStatDetails

DescribeMediaPlayStatDetails

Download
聚焦模式
字号
最后更新时间： 2026-05-19 15:02:50

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to query playback statistics of media files by specified time granularity.

  • Playback statistics from the past one year can be queried.
  • The time granularity is hourly, and the span between end time and start time cannot exceed 7 days.
  • The time granularity is day, and the span between the end time and start time is up to 90 days.
    Playback statistics only target VOD domains (EdgeOne domain name distribution is not included).

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeMediaPlayStatDetails.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
FileId Yes String Media file ID.
StartTime Yes String Start time. Use the ISO date format.
EndTime Yes String End time. Use the ISO date format.
SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
Interval No String Statistical time granularity. Valid values:
  • Hour: hourly granularity.
  • Day: By day.

    • The default granularity is determined by the duration. If the duration is less than 1 day, the granularity is hour. If the duration is equal to or greater than 1 day, the granularity is day.

    3. Output Parameters

    Parameter Name Type Description
    PlayStatInfoSet Array of PlayStatInfo Playback statistics.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying the playback statistics of the media file EndTime from 2021-01-01 00:00:00 to 2021-01-01 02:00:00

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeMediaPlayStatDetails
&FileId=5285485487985271487
&StartTime=2021-01-01T00:00:00+08:00
&EndTime=2021-01-01T02:00:00+08:00
&<Common request parameters>

    Output Example

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

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.DBError Operation failed: The database operation failed.
    InvalidParameterValue.EndTime Incorrect parameter value: invalid FileId.
    InvalidParameterValue.FileId The Interval does not exist.
    InvalidParameterValue.Interval Invalid StartTime value
    InvalidParameterValue.StartTime Incorrect parameter value: invalid .
    上一篇: DescribeAigcUsageData下一篇: DescribeReviewDetails

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈