tencent cloud



Last updated: 2024-03-27 16:09:03

    1. API Description

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

    This API is used to query the playback statistics of a media file at the specified granularity.

    • You can query playback statistics in the past year.
    • If the granularity is an hour, the start and end time cannot be more than seven days apart.
    • If the granularity is a day, the start and end time cannot be more than 90 days apart.

    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 The ID of the media file.
    StartTime Yes String The start time in ISO date format.
    EndTime Yes String The end time in ISO date format.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Interval No String Granularity. Valid values:
  • Hour
  • Day

  • The default value depends on the time period queried. If the time period is shorter than one day, the default value is Hour; if the time period is one day or longer, the default value is Day.

    3. Output Parameters

    Parameter Name Type Description
    PlayStatInfoSet Array of PlayStatInfo The 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 5285485487985271487 from 2021-01-01 00:00:00 to 2021-01-01 02:00:00

    Input Example

    &<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


    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 EndTime.
    InvalidParameterValue.FileId The FileId does not exist.
    InvalidParameterValue.Interval Invalid Interval value
    InvalidParameterValue.StartTime Incorrect parameter value: invalid StartTime.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support