DescribePlayVideoStatis - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries daily playback statistics on a video in the specified time range.

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 only data in the last 730 days. 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
VideoId	string	Yes	The ID of the video. You can specify only one ID. You can use one of the following methods to obtain the ID: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the page that appears, view the video ID. Obtain the video ID from the response to the CreateUploadVideo operation that you call to obtain the upload URL and credential. Obtain the video ID from the response to the SearchMedia operation that you call to query the audio or video file.	2a8d4cb9ecbb487681473****aba8fda

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	A92D3600-A3E7-43D6-****-B6E3B4A1FE6B
VideoPlayStatisDetails	array<object>	The daily playback statistics on the video.
	object
PlayDuration	string	The total playback duration. Unit: milliseconds.	967277
Date	string	The date. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	20170120
VV	string	The number of video views.	24
Title	string	The video title.	Four streams (one stream encrypted): LD-HLS + SD-MP4 + HD-HLS-encrypted + UHD-MP4
UV	string	The number of unique visitors.	1
PlayRange	string	The distribution of the playback duration.	<=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.2%

Examples

Sample success responses

JSONformat

{
  "RequestId": "A92D3600-A3E7-43D6-****-B6E3B4A1FE6B",
  "VideoPlayStatisDetails": {
    "VideoPlayStatisDetail": [
      {
        "PlayDuration": "967277",
        "Date": "20170120",
        "VV": "24",
        "Title": "Four streams (one stream encrypted): LD-HLS + SD-MP4 + HD-HLS-encrypted + UHD-MP4",
        "UV": "1",
        "PlayRange": "<=1m:79.2%;>1<=5m:16.7%;>5<=10m:4.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.