tencent cloud

APIs

DocumentaçãoAPIsVideo on DemandData Statistics APIsDescribeMediaPlayStatDetails

DescribeMediaPlayStatDetails

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-18 16:00:11

1. API Description

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

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

  • Playback statistics from the past one year can be queried.
    Time granularity: hr. The max span between the end time and start time is 7 days.
    Time granularity is day, and the maximum span between the end time and start time is 90 days.
  • Playback statistics only target VOD domains, excluding distribution from EdgeOne domain names.

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 in ISO date format.
EndTime Yes String End time in ISO datetime format.
SubAppId No Integer VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
Interval No String Statistical time granularity. Valid values:
  • Hour: in hours.
  • Day: By day.

    • The granularity is determined by default based on the duration: less than 1 day uses hour granularity, and 1 day or more uses day granularity.

    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 Query playback statistics of media file 5285485487985271487 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: Database operation failed.
    InvalidParameterValue.EndTime Parameter value error: EndTime is invalid.
    InvalidParameterValue.FileId FileId does not exist.
    InvalidParameterValue.Interval Parameter value error. Interval is invalid.
    InvalidParameterValue.StartTime Parameter value error: StartTime is invalid.
    Anterior: DescribeAigcUsageDataPróximo: DescribeReviewDetails

    Ajuda e Suporte

    Esta página foi útil?

    comentários

    Search
      Enter keywords to search documentation