DescribePlayTopVideos - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Operation description

This endpoint is supported only in the China (Shanghai) region.
You can query playback statistics for up to 1,000 top videos per day. By default, the list of top videos is sorted by view count in descending order.
Only playback data collected by the ApsaraVideo Player SDK is supported.
Playback statistics for the previous day are generated at 09:00 (UTC+8) every day.
You can query data generated after January 1, 2018. The maximum query time range is 180 days.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:DescribePlayTopVideos

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BizDate	string	Yes	The date to query. The date must be in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2016-06-29T13:00:00Z
PageNo	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 100. Maximum value: 1000.	100

Response parameters

Parameter	Type	Description	Example
	object
PageNo	integer	The number of the page returned.	1
RequestId	string	The ID of the request.	4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B"
PageSize	integer	The number of entries returned on each page.	100
TotalNum	integer	The total number of top videos.	2
TopPlayVideos	object
TopPlayVideoStatis	array<object>	The playback data of the top videos of the day.
	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 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

Success response

JSON format

{
  "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 response

JSON format

{
    "RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720",
    "HostId":"vod.cn-shanghai.aliyuncs.com",
    "Code":"InvalidStartTime.Malformed",
    "Message":"Specified StartTime is malformed."
}

Error codes

HTTP status code	Error code	Error message
400	InvalidBizDate.Malformed	Specified BizDate is malformed.
400	InvalidBizDate.BeyondCurrent	BizDate beyond current time.
400	InvalidParamter	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.