Queries the playback statistics based on the media ID. You can call this operation to query information such as the number of visits, average video views per viewer, total number of views, average playback duration per viewer, and total playback duration.
Operation description
-
This operation is available only in the China (Shanghai) region.
-
Only playback data in ApsaraVideo Player SDK is collected.
-
You can query only data within the last 30 days.
-
Before you call this operation, make sure that the following requirements are met:
-
ApsaraVideo Player SDK for Android or iOS
- ApsaraVideo Player SDK for Android or iOS V5.4.9.2 or later is used.
- A license for ApsaraVideo Player SDK is obtained. For more information, see Manage licenses.
- The log reporting feature is enabled. By default, the feature is enabled for ApsaraVideo Player SDKs. For more information, see Integrate ApsaraVideo Player SDK for Android and Integrate ApsaraVideo Player SDK for iOS.
-
ApsaraVideo Player SDK for Web
- ApsaraVideo Player SDK for Web V2.16.0 or later is used.
- A license for playback quality monitoring is obtained. To apply for the license, submit a request on Yida to enable value-added features for ApsaraVideo Player SDK for Web. For more information, see the description of the
licenseparameter in the API operations topic. - The log reporting feature is enabled. By default, the feature is enabled for ApsaraVideo Player SDKs.
-
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vod:DescribeVodMediaPlayData | none | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PlayDate | string | No | The playback time. Specify the value in the yyyyMMdd format. Note
| 20240322 |
| TerminalType | string | No | The type of the player SDK. You can specify this parameter to query all playback data generated by using a specific type of player SDK. Valid values:
| Native |
| Os | string | No | The operating system of the player. You can specify this parameter to query all playback data generated on a specific operating system. Valid values:
| Android |
| Region | string | No | The region in which ApsaraVideo VOD is activated. You can specify this parameter to query all playback data generated only in a specific region. Valid values:
| cn-beijing |
| MediaId | string | No | The ID of the media file (VideoId). You can specify this parameter to query all playback data of a media file. You can specify only one media ID. You can use one of the following methods to obtain the ID:
| 9ae2af636ca6c10412f44891fc**** |
| PageNo | long | Yes | The number of the page. You can specify a page number to return data from the specified page. | 1 |
| PageSize | long | Yes | The number of entries per page. Maximum value: 100. | 20 |
| OrderType | string | No | The sort type. This parameter must be specified together with the
| ASC |
| OrderName | string | No | The name of the metric. This parameter must be specified together with the
| PlaySuccessVv |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****",
"TotalCount": 1,
"PageNo": 1,
"PageSize": 20,
"QoeInfoList": [
{
"VideoTitle": 0,
"VideoDuration": 246,
"MediaId": "9ae2af636ca6c10412f44891fc****",
"DAU": 5,
"PlaySuccessVv": 20,
"PlayDurationPerUv": 120,
"PlayDuration": 2400,
"PlayPerVv": 4
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-07 | The Error code has changed. The response structure of the API has changed | View Change Details |