DescribeDailyPlayStatFileList

最后更新时间:2021-03-24 15:54:01

1. API Description

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

This API is used to query the download links of playback statistics files.

  • You can query the download links of playback statistics files in last 30 days.
  • Every day, VOD will analyze CDN request logs of the previous day and then generate a playback statistics file.
  • A playback statistics file includes playback times and traffic of media files.
  • Notes on playback times:
    1. HLS file: VOD counts playback times when accessing M3U8 files, but not when accessing TS files.
    2. Other files (MP4 files for example): VOD does not count playback times when the playback request carries the range parameter and the start parameter in range is not 0. In other cases, VOD counts playback times.
  • Statistics on playback devices: VOD counts playback times on mobile clients when the playback request carries the UserAgent parameter which includes an identifier such as Android or iPhone. In other cases, VOD counts playback times on PC clients.

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 parameter. The value used for this API: DescribeDailyPlayStatFileList.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
StartTime Yes String Start date in ISO date format.
EndTime Yes String End date in ISO date format.
SubAppId No Integer VOD subapplication ID. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

3. Output Parameters

Parameter Name Type Description
PlayStatFileSet Array of PlayStatFileInfo List of playback statistics files.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of playback statistics files between December 1, 2020 and December 2, 2020

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeDailyPlayStatFileList
&StartTime=2020-12-01T00:00:00+08:00
&EndTime=2020-12-02T00:00:00+08:00
&<Common request parameters>

Output Example

{
  "Response": {
    "PlayStatFileSet": [
      {
        "Date": "2020-12-01T00:00:00+08:00",
        "Url": "http://xxx.test.com/playstat/2021201.csv.gz?sign=abc"
      },
      {
        "Date": "2020-12-02T00:00:00+08:00",
        "Url": "http://xxx.test.com/playstat/20201202.csv.gz?sign=abc"
      }
    ],
    "RequestId": "requestId"
  }
}

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.
InternalError.DBError Internal error. Failed to access DB.
InvalidParameterValue.EndTime Incorrect parameter value: invalid EndTime.
InvalidParameterValue.StartTime Incorrect parameter value: invalid StartTime.