DescribePlayUserAvg - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the statistics on average playback each day in a specified time range.

Operation description

Note

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 previous day are generated at 09:00 on the current day, in UTC+8.

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. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-06-30T13:00:00Z

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6C7F90B2-BDA4-4FAC-****-A38A121DFE19
UserPlayStatisAvgs	array<object>	The statistics on average playback each day.
	object
Date	string	The date when the statistics were generated. The date follows the yyyy-MM-dd format.	20170120
AvgPlayDuration	string	The average playback duration. Unit: milliseconds.	1035902.8
AvgPlayCount	string	The average number of video views.	170

Examples

Sample success responses

JSONformat

{
  "RequestId": "6C7F90B2-BDA4-4FAC-****-A38A121DFE19",
  "UserPlayStatisAvgs": {
    "UserPlayStatisAvg": [
      {
        "Date": "20170120",
        "AvgPlayDuration": "1035902.8",
        "AvgPlayCount": "170"
      }
    ]
  }
}

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.