Query VOD Playback Data with DescribeVodPlayerCollectData - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries aggregated playback data of the player.

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:DescribeVodPlayerCollectData

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	app-1000000
StartTime	string	Yes	The start time of the query. Format: yyyy-mm-ddthh:mm:ssz (UTC). Note Playback data from the last year can be queried. The time range for a single query cannot exceed 31 days. The time interval is left-closed and right-open [StartTime, EndTime).	2025-06-24T00:55:06Z
EndTime	string	Yes	The end time of the query. Format: yyyy-mm-ddthh:mm:ssz (UTC).	2025-06-05T15:59:59Z
Interval	string	Yes	The time granularity for the query data. Valid values: 5m, 1h, and 1d. The supported time granularity varies based on the time span specified by `StartTime` and `EndTime`: Within 3 days: 5m, 1h, and 1d. 4 to 7 days: 1h and 1d. More than 7 days: 1d.	1d
TerminalType	string	Yes	The terminal type. Valid values: web: web. mobile: native.	web
Os	string	No	The operating system of the playback device. Specify this parameter to perform a filtered query for playback data of a specific operating system. Valid values: Android, iOS, Harmony, Windows, MacOS, and Linux. The available values vary by terminal type: native: Android, iOS, Harmony. web: Android, iOS, Harmony, Windows, MacOs, Linux. Separate multiple values with #_#.	Android、iOS、Windows
Metrics	string	Yes	The metric type. You can specify up to 3 metrics. Note Percentage data is returned in decimal format. Playback quality (QoS) metrics: Vv: play count. RealVv: actual play count. FirstFrame: first frame time. SecondPlayRate: instant play rate. SlowPlayRate: slow play rate. StuckCountRate: stuttering rate by count. SeekDuration: seek duration. StuckDuration100s: stuttering duration per 100 seconds. StuckCount100s: stuttering count per 100 seconds. PlayFailRate: playback failure rate. SeedFailRate: non-play rate. AvgPlayBitrate: average playback bitrate. AvgStartBitrate: average initial bitrate. ErrorCount100s: error count per 100 seconds. Playback experience (QoE) metrics: Uv: unique viewers. AvgPerVv: average plays per user. AvgVideoDuration: average video duration. AvgPerPlayDuration: average playback duration per user. AvgPerCompletionVv: average completion count per user. CompletionVv: completion count. CompletionRate: completion rate. AvgPlayDuration: average playback duration. JumpRate5s: 5-second bounce rate.	Vv,Uv,AvgPerVv
Period	string	No	The time range for period-over-period analysis, in days (d). For example, if you set this parameter to 1d (1 day), the period-over-period data is retrieved from the time range of StartTime-1d to EndTime-1d.	1d

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	25818875-5F78-4AF6-D7393642CA58****
DataList	array<object>	The returned data list.
	object
Metric	string	The returned data metric.	Vv
Value	number	The value of the returned data metric.	100.0
ValueRefer	number	The period-over-period value of the returned data metric.	200.0
ValueRatio	number	The period-over-period percentage.	0.5

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "DataList": [
    {
      "Metric": "Vv",
      "Value": 100,
      "ValueRefer": 200,
      "ValueRatio": 0.5
    }
  ]
}

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.