DescribeVodPlayerMetricData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries player metric 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:DescribeVodPlayerMetricData

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	app-1000000
StartTime	string	Yes	The start of the time range to query. The time is in UTC and the format is yyyy-mm-ddThh:mm:ssZ. Note You can query playback data from the last year. The time range for a single query cannot exceed 31 days. The time range is a left-closed, right-open interval `[StartTime, EndTime)`.	2025-06-24T00:55:06Z
EndTime	string	Yes	The end of the time range to query. The time is in UTC and the format is yyyy-mm-ddThh:mm:ssZ.	2025-06-05T15:59:59Z
Interval	string	Yes	The time granularity of the data to query. Valid values: 5m, 1h, and 1d. The supported time granularity varies 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 longer than 7 days, you can only set this parameter to 1d.	1d
TerminalType	string	Yes	The terminal type. Valid values: web: web client. mobile: native client.	web
Filters	string	No	The filter for metric dimensions. A dimension consists of a field (Field), an operator (Op), and a value. Note You can specify up to three dimensions. The `Filters` parameter does not take effect if the `Metrics` parameter includes any of the following four metrics: Uv (number of unique viewers), AvgPerVv (average number of views per user), AvgPerPlayDuration (average playback duration per user), or AvgPerCompletionVv (average number of complete views per user). For provinces and countries, pass the region code. To pass multiple values, separate them with `#_#`. Valid values for the dimension type (Field): SdkVersion: the SDK version. AppVersion: the app version. Codec: the encoding format. VideoType: the video format. Network: the network type. Country: the country. Isp: the carrier. VideoDefinition: the resolution. Domain: the domain name. Province: the province. IsHw: specifies whether hardware decoding is used. ErrorCode: the error code. Valid values for the operator (Op) are `=` (equal to), `>` (greater than), `<` (less than), and `!=` (not equal to). Note The SdkVersion and VideoDefinition metrics support all four operators. Other metrics only support `=` (equal to) and `!=` (not equal to). To get dimension values, call the DescribeVodPlayerDimensionData operation.	[ { "Field": "codec", "Op": "=", "Value": "h265#_#h264" }, { "Field": "os", "Op": "=", "Value": "Android#_#iOS" } ]
Metrics	string	Yes	The metric type. You can select multiple metrics, up to a maximum of three. Note Percentage data is returned as a decimal. Quality of Service (QoS) metrics: Vv: the number of views. RealVv: the number of actual views. FirstFrame: the time to first frame. SecondPlayRate: the rate of playback startup within one second. SlowPlayRate: the rate of slow playback startup. StuckCountRate: the stuttering rate by count. SeekDuration: the seek time. 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 viewers. AvgPerVv: the average number of views per user. AvgVideoDuration: the average video duration. AvgPerPlayDuration: the average playback duration per user. AvgPerCompletionVv: the average number of complete views per user. CompletionVv: the number of complete views. CompletionRate: the completion rate. AvgPlayDuration: the average playback duration. JumpRate5s: the 5-second bounce rate.	Vv,Uv,AvgPerVv
Top	integer	No	The number of top results to return based on the number of views. If you do not specify this parameter, data for all dimensions is returned.	5
PageNumber	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 5000. Maximum value: 5000.	5000
Language	string	No	The language of the response. Valid values: zh (default): Simplified Chinese. en: English.	zh
Os	string	No	The operating system of the player. You can specify this parameter to query playback data for a specific operating system. Valid values include Android, iOS, Harmony, Windows, macOS, and Linux. The valid values vary based on the terminal type: native: Android, iOS, and Harmony. web: Android, iOS, Harmony, Windows, macOS, and Linux. To specify multiple operating systems, separate them with `#_#`.	Android、iOS、Windows

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	25818875-5F78-4A*****F6-D7393642CA58
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	5000
TotalCnt	integer	The total number of data points.	500
DataList	array<object>	The list of returned data.
	object
TimeStamp	string	The timestamp of the returned data. The time is in UTC and the format is yyyy-mm-ddThh:mm:ssZ.	2025-06-24T00:55:06Z
Dimension	string	The dimension.	H265_MP4_WIFI
Uv	number	The number of unique viewers.	500
Vv	number	The number of views.	800
RealVv	number	The number of actual views.	1000
FirstFrame	number	The time to first frame, in milliseconds (ms).	100
SecondPlayRate	number	The rate of playback startup within one second.	0.8
SlowPlayRate	number	The rate of slow playback startup.	0.2
StuckCountRate	number	The stuttering rate by count.	0.1
SeekDuration	number	The seek time, in milliseconds (ms).	100
StuckDuration100s	number	The stuttering duration per 100 seconds, in milliseconds (ms).	200
PlayFailRate	number	The playback failure rate.	0.2
SeedFailRate	number	The rate of playback startup failures.	0.01
AvgPlayBitrate	number	The average playback bitrate, in bps.	100
AvgStartBitrate	number	The average startup bitrate, in bps.	100
ErrorCount100s	number	The number of errors per 100 seconds.	1
AvgPerVv	number	The average number of views per user.	10
AvgVideoDuration	number	The average video duration, in milliseconds (ms).	100000
AvgPerPlayDuration	number	The average playback duration per user, in milliseconds (ms).	100000
AvgPerCompletionVv	number	The average number of complete views per user.	2
CompletionVv	number	The number of complete views.	500
CompletionRate	number	The completion rate.	0.8
AvgPlayDuration	number	The average playback duration, in milliseconds (ms).	100000
JumpRate5s	number	The 5-second bounce rate.	0.1
TotalPlayDuration	number	The total playback duration, in milliseconds (ms).	100000
StuckCount100s	string	The number of stutters per 100 seconds.	2
Extend	object	The extended information.
ActualStartTime	string	The earliest time when a data point was generated within the specified time range. The time is in UTC and the format is yyyy-mm-ddThh:mm:ssZ.	2025-06-24T00:55:06Z
ActualEndTime	string	The latest time when a data point was generated within the specified time range. The time is in UTC and the format is yyyy-mm-ddThh:mm:ssZ.	2025-06-05T15:59:59Z
IntervalSeconds	integer	The time granularity of the queried data, in seconds (s).	3600

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "PageNumber": 1,
  "PageSize": 5000,
  "TotalCnt": 500,
  "DataList": [
    {
      "TimeStamp": "2025-06-24T00:55:06Z\n",
      "Dimension": "H265_MP4_WIFI",
      "Uv": 500,
      "Vv": 800,
      "RealVv": 1000,
      "FirstFrame": 100,
      "SecondPlayRate": 0.8,
      "SlowPlayRate": 0.2,
      "StuckCountRate": 0.1,
      "SeekDuration": 100,
      "StuckDuration100s": 200,
      "PlayFailRate": 0.2,
      "SeedFailRate": 0.01,
      "AvgPlayBitrate": 100,
      "AvgStartBitrate": 100,
      "ErrorCount100s": 1,
      "AvgPerVv": 10,
      "AvgVideoDuration": 100000,
      "AvgPerPlayDuration": 100000,
      "AvgPerCompletionVv": 2,
      "CompletionVv": 500,
      "CompletionRate": 0.8,
      "AvgPlayDuration": 100000,
      "JumpRate5s": 0.1,
      "TotalPlayDuration": 100000,
      "StuckCount100s": "2"
    }
  ],
  "Extend": {
    "ActualStartTime": "2025-06-24T00:55:06Z",
    "ActualEndTime": "2025-06-05T15:59:59Z",
    "IntervalSeconds": 3600
  }
}

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.