DescribePlayUserTotal API for Daily Playback Statistics - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the total daily playback statistics within a specified time range, including total play count, total unique viewers, total playback duration, and playback duration distribution.

Operation description

Currently, the only supported service region is China (Shanghai).
Only playback data from ApsaraVideo Player SDK is supported.
Based on UTC+8, playback statistics for the previous day are generated at 9:00 AM each day.
Data after 2018-01-01 can be queried. The maximum time span between the start time and end time is 180 days.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time of the query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2016-06-29T13:00:00Z
EndTime	string	Yes	The end time of the query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). Note The end time must be later than the start time. The maximum time span between the start time and end time is 180 days.	2016-06-30T13:00:00Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1FAFB884-D5A7-47D1-****-8928AA9C8720
UserPlayStatisTotals	object
UserPlayStatisTotal	array<object>	The daily total playback statistics.
	array<object>
Date	string	The date. The date is displayed in the yyyy-MM-dd format.	20170120
PlayDuration	string	The total playback duration. Unit: milliseconds.	9340070
PlayRange	string	The distribution of the playback duration.	"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%"
VV	object	The total number of video views.
Flash	string	The total number of video views played by using the Flash player.	2
iOS	string	The total number of video views played by using ApsaraVideo Player SDK for iOS.	0
HTML5	string	The total number of video views played by using the HTML5 player.	2
Android	string	The total number of video views played by using ApsaraVideo Player SDK for Android.	161
UV	object	The total number of unique visitors.
Flash	string	The total number of unique visitors who use the Flash player.	1
iOS	string	The total number of unique visitors who use ApsaraVideo Player SDK for iOS.	0
HTML5	string	The total number of unique visitors who use the HTML5 player.	1
Android	string	The total number of unique visitors who use ApsaraVideo Player SDK for Android.	2

Examples

Success response

JSON format

{
  "RequestId": "1FAFB884-D5A7-47D1-****-8928AA9C8720",
  "UserPlayStatisTotals": {
    "UserPlayStatisTotal": [
      {
        "Date": "20170120",
        "PlayDuration": "9340070",
        "PlayRange": "\"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%\"",
        "VV": {
          "Flash": "2",
          "iOS": "0",
          "HTML5": "2",
          "Android": "161"
        },
        "UV": {
          "Flash": "1",
          "iOS": "0",
          "HTML5": "1",
          "Android": "2"
        }
      }
    ]
  }
}

Error response

JSON format

{
    "RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720",
    "HostId":"vod.cn-shanghai.aliyuncs.com",
    "Code":"InvalidStartTime.Malformed",
    "Message":"Specified StartTime is malformed."
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The start time is in an invalid format.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The end time is in an invalid format.
400	InvalidEndTime.BeyondCurrent	EndTime beyond current time.
400	InvalidParamter	%s
400	InvalidEndTime.Mismatch	StartTime or EndTime is mismatch.	The start time and end time do not match.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.