tencent cloud

APIs

DocumentationAPIsVideo on DemandData Statistics APIsDescribeDailyMostPlayedStat

DescribeDailyMostPlayedStat

Download
Focus Mode
Font Size
Last updated: 2026-09-22 21:56:06

1. API Description

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

This API is used to query daily playback statistics of the Top 100 media files.

  • Playback statistics from the past one year can be queried.
  • You can query by playback times or traffic volume.
  • Statistical description of the number of plays:
  • HLS file: The number of plays is counted when an M3U8 file is accessed, but not when a TS file is accessed.
  • Other files (for example, MP4 files): If a playback request includes the range parameter and the start parameter of range is not equal to 0, the number of plays is not counted. In other cases, the number of plays is counted.
  • Playback statistics only target VOD domains (i.e., distribution from EdgeOne domain names is not included in playback statistics).

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: DescribeDailyMostPlayedStat.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Date Yes String Query date, in ISO date format. This parameter is only valid for the date part.
DomainName No String Domain name. Query playback stats of the Top 100 media files for that domain name. Query playback stats of all domain names by default.
Metric No String Statistical metrics for Top data. Valid values:
  • Traffic: playback traffic. The data of Top 100 is collected by playback traffic.
  • PlayTimes: number of plays, the data of the Top 100 by playback count.

    • Default value: Traffic.
    SubAppId No Integer ID of the on-demand application. For customers who activate on-demand services after December 25, 2023, this field must be filled with the app ID when accessing resources in on-demand applications (whether the default application or a newly created application).

    3. Output Parameters

    Parameter Name Type Description
    DailyPlayStatInfoSet Array of DailyPlayStatInfo Media file 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 Query the playback statistics of the Top 100 plays on 2021-01-01.

    Query the playback statistics of the Top 100 plays on 2021-01-01.

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeDailyMostPlayedStat
&Date=2021-01-01T00:00:00+08:00
&Metric=PlayTimes
&<Common request parameters>

    Output Example

    {
    "Response": {
        "DailyPlayStatInfoSet": [
            {
                "Date": "2021-01-01T00:00:00+08:00",
                "PlayTimes": 1,
                "Traffic": 1234,
                "FileId": "5285485487985271487"
            }
        ],
        "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.NetWorkError Network error.
    InvalidParameterValue.Date Invalid parameter value: Date.
    InvalidParameterValue.DomainName Parameter error: non-existent domain name.
    InvalidParameterValue.Metric Parameter error: Metric is invalid.
    Previous Topic: DescribeStorageDetailsNext Topic: DescribeMediaProcessUsageData

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback

    Search
      Enter keywords to search documentation