DescribePlayUserTotal - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the daily playback statistics in a specified time range. The playback statistics include the total number of views, total number of viewers, total playback duration, and playback duration distribution.

Operation description

This operation is available only in the China (Shanghai) region.
You can call this operation to query only playback statistics collected on videos that are played by using ApsaraVideo Player SDKs.
Playback statistics for the current day are generated at 09:00 (UTC+8) on the next day.
You can query data that is generated since January 1, 2018. The maximum time range to query is 180 days.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-06-29T13:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The end time must be later than the start time. The interval between the start time and the end time cannot exceed 180 days.	2016-06-30T13:00:00Z

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1FAFB884-D5A7-47D1-****-8928AA9C8720
UserPlayStatisTotals	array<object>	The daily playback statistics.
	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

Sample success responses

JSONformat

{
  "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 codes

For a list of error codes, visit the Service error codes.

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
InternalError	The request processing has failed due to some unknown error.	500	The error message returned because an unknown error has occurred.
InvalidStartTime.Malformed	Specified StartTime is malformed.	400	The error message returned because the format of the start time that is specified by the StartTime parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
InvalidEndTime.Malformed	Specified EndTime is malformed.	400	The error message returned because the format of the end time that is specified by the EndTime parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
InvalidEndTime.BeyondCurrent	EndTime beyond current time.	400	The error message returned because the end time that is specified by the EndTime parameter is later than the current time.
InvalidEndTime.Mismatch	StartTime or EndTime is mismatch.	400	The error message returned because the time range that is specified by the StartTime and EndTime parameters is invalid.