Analyze VOD Playback Data via DescribeVodMediaPlayData - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves playback data of an audio or video file on a specified date by media ID (audio or video ID), including the number of unique visitors, average plays per user, total plays, average play duration per user, and total play duration.

Operation description

Currently, this operation is available only in the China (Shanghai) region.
Only playback data collected by ApsaraVideo Player SDK is supported. Traffic statistics for audio-only streams are not supported.
Only data within the last 30 days can be queried.

Important - Before calling this operation, make sure that ApsaraVideo Player SDK meets the following conditions:

Android Player SDK or iOS Player SDK
- The Player SDK version is 5.4.9.2 or later.
- A License for the Player SDK has been obtained and integrated. For more information, see License management.
- The event tracking log reporting feature of the Player SDK is enabled. By default, this feature is enabled in ApsaraVideo Player SDK. For more information, see Create a player for Android and Create a player for iOS.
Web Player SDK
- The Player SDK version is 2.16.0 or later.
- A License for Playback Quality Monitoring has been obtained and integrated. Submit the Web Player SDK value-added service application form to apply. For the License integration method, see the license property in Web SDK API reference.
- The event tracking log reporting feature of the Player SDK is enabled. By default, this feature is enabled in ApsaraVideo Player SDK.

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 supports 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:DescribeVodMediaPlayData

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PlayDate	string	No	The playback date. Unit: day. Format: yyyyMMdd. Note Only daily queries are supported. Only data within the last 30 days can be queried.	20240322
TerminalType	string	No	The terminal type of the Player SDK. Specify this parameter to perform a filtered query for playback data of all audio and video files by terminal type. Valid values: Native: Android Player SDK or iOS Player SDK. Web: Web Player SDK.	Native
Os	string	No	The operating system of the playback device. Specify this parameter to perform a filtered query for playback data of all audio and video files by operating system. Valid values: Android iOS Windows macOS Linux	Android
Region	string	No	The service region. Specify this parameter to perform a filtered query for playback data of all audio and video files by service region. Valid values: cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-shenzhen: China (Shenzhen) ap-northeast-1: Japan (Tokyo) ap-southeast-1: Singapore ap-southeast-5: Indonesia (Jakarta) eu-central-1: Germany (Frankfurt)	cn-beijing
MediaId	string	No	The media ID, which is the audio or video ID (VideoId). Specify this parameter filtered query playback data for a specific media file. Only one media ID can be specified. You can obtain the media ID by using the following methods: For audio or video files uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the audio or video ID. When you upload an audio or video file by calling the CreateUploadVideo operation, the audio or video ID is the value of the VideoId response parameter. After the audio or video file is uploaded, you can call the SearchMedia operation filtered query the audio or video ID, which is the value of the VideoId response parameter.	9ae2af636ca6c10412f44891fc****
PageNo	integer	Yes	The page number of the data to return. Specify this parameter to set the page from which data starts to be returned.	1
PageSize	integer	Yes	The number of entries per page. Specify this parameter to set the number of entries displayed on each page. Maximum value: 100.	20
OrderType	string	No	The sort order. This parameter is used together with the `OrderName` parameter. Specify this parameter to sort the returned data in ascending or descending order by a specified metric. Valid values: ASC: ascending order. The returned data is sorted from smallest to largest. DESC: descending order. The returned data is sorted from largest to smallest.	ASC
OrderName	string	No	The metric name. This parameter is used together with the `OrderType` parameter. Specify this parameter to sort the returned data in ascending or descending order by a specified metric. Valid values: PlaySuccessVv: total plays. PlayPerVv: average plays per user. PlayDuration: total play duration. PlayDurationPerUv: average play duration per user.	PlaySuccessVv

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
TotalCount	integer	The total number of entries returned.	1
PageNo	integer	The page number of the returned data.	1
PageSize	integer	The number of entries per page.	20
QoeInfoList	array<object>	The list of returned data.
	object	The details of the returned data.
VideoTitle	string	The title of the audio or video file.	Alibaba Cloud VOD video title
VideoDuration	number	The duration of the audio or video file. Unit: seconds.	246
MediaId	string	The media ID, which is the audio or video ID (VideoId).	9ae2af636ca6c10412f44891fc****
DAU	number	The number of unique visitors for the audio or video file.	5
PlaySuccessVv	number	The total number of plays for the audio or video file.	20
PlayDurationPerUv	number	The average play duration per user for the audio or video file. Unit: seconds.	120
PlayDuration	number	The total play duration for the audio or video file. Unit: seconds.	2400
PlayPerVv	number	The average number of plays per user for the audio or video file.	4

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "TotalCount": 1,
  "PageNo": 1,
  "PageSize": 20,
  "QoeInfoList": [
    {
      "VideoTitle": "Alibaba Cloud VOD video title",
      "VideoDuration": 246,
      "MediaId": "9ae2af636ca6c10412f44891fc****",
      "DAU": 5,
      "PlaySuccessVv": 20,
      "PlayDurationPerUv": 120,
      "PlayDuration": 2400,
      "PlayPerVv": 4
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Meter.ParamError	Param Error:%s,Please Check Again.	One or more parameters are invalid.
500	Meter.ServerInternalError	The Request Processing Has Failed Due To Some Unknown Error.	An internal error occurred.
500	Meter.DataSourceQueryError	Data Source Error:%s,Please Try Again.	An internal data source error occurred.
403	Meter.AuthError	Authentication Failed,Please Try Again.	You do not have permissions to perform this operation.
502	Meter.ReadyTsError	Get ReadyTs Failed,Please Try Again.	The data is not prepared.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.