DescribeVodPlayerCollectData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the summary of player playback data.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	app-1000000
StartTime	string	Yes	The start of the time range to query. The time is in the yyyy-mm-ddThh:mm:ssZ format in UTC. Note You can query the playback data in the last year. The maximum time range for a single query is 31 days. The time range is a left-closed, right-open interval. The range includes the start time but not the end time. [StartTime, EndTime).	2025-06-24T00:55:06Z
EndTime	string	Yes	The end of the time range to query. The time is in the yyyy-mm-ddThh:mm:ssZ format in UTC.	2025-06-05T15:59:59Z
Interval	string	Yes	The time granularity of the query. Valid values: 5m, 1h, and 1d. The supported time granularities vary based on the time range specified by `StartTime` and `EndTime`: If the time range is within 3 days, you can set this parameter to 5m, 1h, or 1d. If the time range is from 4 to 7 days, you can set this parameter to 1h or 1d. If the time range is more than 7 days, you can set this parameter to 1d.	1d
TerminalType	string	Yes	The terminal type. Valid values: web: web client. mobile: native client.	web
Os	string	No	The operating system of the player. If you specify this parameter, you can query the playback data of a specified operating system. Valid values include Android, iOS, Harmony, Windows, MacOS, and Linux. The valid values vary based on the terminal type. The following list describes the mappings: native: Android, iOS, and Harmony. web: Android, iOS, Harmony, Windows, MacOS, and Linux. Separate multiple operating systems with #_#.	Android、iOS、Windows
Metrics	string	Yes	The metric type. You can specify multiple metrics. You can specify a maximum of three metrics. Note The values of percentage-related data are returned in the decimal format. Quality of Service (QoS) metrics: Vv: the number of playbacks. RealVv: the number of actual playbacks. FirstFrame: the first frame latency. SecondPlayRate: the rate of starting playback within 1 second. SlowPlayRate: the rate of slow starting playbacks. StuckCountRate: the stuttering rate based on the number of stutters. SeekDuration: the seek latency. StuckDuration100s: the stuttering duration per 100 seconds. StuckCount100s: the number of stutters per 100 seconds. PlayFailRate: the playback failure rate. SeedFailRate: the rate of playback startup failures. AvgPlayBitrate: the average playback bitrate. AvgStartBitrate: the average startup bitrate. ErrorCount100s: the number of errors per 100 seconds. Quality of Experience (QoE) metrics: Uv: the number of unique visitors (UVs). AvgPerVv: the average number of playbacks per person. AvgVideoDuration: the average video duration. AvgPerPlayDuration: the average playback duration per person. AvgPerCompletionVv: the average number of completed playbacks per person. CompletionVv: the number of completed playbacks. CompletionRate: the completion rate. AvgPlayDuration: the average playback duration. JumpRate5s: the 5-second bounce rate.	Vv,Uv,AvgPerVv
Period	string	No	The time range for period-over-period analysis. Unit: day (d). For example, if you set this parameter to 1d, the time range for period-over-period data is from StartTime-1d to EndTime-1d.	1d

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	25818875-5F78-4AF6-D7393642CA58****
DataList	array<object>	The list of data returned.
	object
Metric	string	The data metric returned.	Vv
Value	number	The value of the data metric returned.	100.0
ValueRefer	number	The period-over-period value of the data metric returned.	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.