DescribePlayTopVideos - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries daily playback statistics on top videos, including video views, unique visitors, and total playback duration.

Operation description

This operation is available only in the China (Shanghai) region.
You can query playback statistics on top 1,000 videos at most on a specified day. By default, top videos are sorted in descending order based on video views.
You can call this operation to query only playback statistics collected on videos that are played by using ApsaraVideo Player SDKs.
Playback statistics for the previous day are generated at 09:00 on the current day, in UTC+8.
You can query data that is generated since January 1, 2018. The maximum time range to query is 180 days.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
BizDate	string	Yes	The time to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-06-29T13:00:00Z
PageNo	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries to return on each page. The default value is 100. The maximum value is 1000.	100

Response parameters

Parameter	Type	Description	Example
	object
PageNo	long	The page number.	1
RequestId	string	The ID of the request.	4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B"
PageSize	long	The number of entries per page.	100
TotalNum	long	The total number of entries that were collected in playback statistics on top videos.	2
TopPlayVideos	array<object>	The daily playback statistics on each top video.
	object
Title	string	The title of the video.	Four streams (two streams encrypted): LD-HLS-encrypted + SD-MP4 + HD-H
VV	string	The number of video views.	107
PlayDuration	string	The total playback duration. Unit: milliseconds.	4640369
VideoId	string	The ID of the video.	2a8d4cb9ecbb487681473a15****8fda
UV	string	The number of unique visitors.	1

Examples

Sample success responses

JSONformat

{
  "PageNo": 1,
  "RequestId": "4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B\"",
  "PageSize": 100,
  "TotalNum": 2,
  "TopPlayVideos": {
    "TopPlayVideoStatis": [
      {
        "Title": "Four streams (two streams encrypted): LD-HLS-encrypted + SD-MP4 + HD-H",
        "VV": "107",
        "PlayDuration": "4640369",
        "VideoId": "2a8d4cb9ecbb487681473a15****8fda",
        "UV": "1"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
InternalError	The request processing has failed due to some unknown error.	500	The error message returned because an unknown error has occurred.
InvalidBizDate.Malformed	Specified BizDate is malformed.	400	The error message returned because the format of the time that is specified by the BizDate parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
InvalidBizDate.BeyondCurrent	EndTime beyond current time.	400	The error message returned because the time that is specified by the BizDate parameter is later than the current time.