All Products
Search
Document Center

DescribePlayTopVideos

Last Updated: Mar 04, 2019

Description

You can call this operation to obtain daily playback statistics for top videos, including the video views (VV), unique visitors (UV), and total playback duration.

Notes:

  • You can query playback statistics for the top 1,000 videos at most on a specified day. Videos in the top video list are ranked based on the VV by default.
  • Playback statistics are collected only from videos played through the ApsaraVideo Player SDK.
  • Playback statistics for the previous day are generated at 09:00 Beijing time (UTC+08:00) every morning.
  • You can query data for a maximum duration of 90 days starting from January 1, 2018.

Request parameters

Name Type Required Description
Action String Yes

The operation that you want to perform. Set the value to DescribePlayTopVideos.

BizDate String Yes

The date. The value must be in UTC, for example, 2018-01-29T00:00:00Z.

PageNo Long No

The page number. Default value: 1.

PageSize Long No

The number of data records per page. Default value: 100. Maximum value: 1000.

Response parameters

Name Type Description
PageSize Long

The number of data records per page.

PageNo Long

The page number.

TotalNum Long

The total number of data records that are collected in playback statistics for top videos.

TopPlayVideos TopPlayVideoStatis

The daily playback statistics for top videos.

RequestId String

The GUID generated by Alibaba Cloud for the request.

Examples

Sample requests

  1. https://vod.cn-shanghai.aliyuncs.com?Action=DescribePlayTopVideos
  2. &BizDate=2018-01-01T00:00:00Z
  3. &PageNo=1&PageSize=1000
  4. &<Common request parameters>

Note: For more information about common request parameters, see Common parameters.

Successful response examples

JSON format

  1. {
  2. "PageNo":"1",
  3. "PageSize":"1000",
  4. "RequestId":"4B0BCF9F-2FD5-4817-B00D-7BEBBE3AF90B",
  5. "TopPlayVideos":{
  6. "TopPlayVideoStatis":[
  7. {
  8. "PlayDuration":"4640369",
  9. "Title":"Four streams (two streams encrypted): FD-HLS-encrypted + LD-MP4 + SD-H",
  10. "UV":"1",
  11. "VV":"107",
  12. "VideoId":"2a8d4cb9ecbb487681473a153aba8fda"
  13. },
  14. {
  15. "PlayDuration":"4689369",
  16. "Title":"Two streams (both encrypted): LD-HLS-encrypted + HD-HLS-encrypted",
  17. "UV":"1",
  18. "VV":"33",
  19. "VideoId":"cca9dbd11b7045808cc9babc56f5bad2"
  20. }
  21. ]
  22. },
  23. "Total":"150"
  24. }

Error response examples

JSON format

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

Error codes

The following table lists the error codes that this operation can return. For more information, see Error codes.

Error code Error message HTTP status code Description
InternalError The request processing has failed due to some unknown error. 500 The error message returned when an unknown error occurred in the background.
InvalidBizDate.Malformed Specified BizDate is malformed. 400 The error message returned when the format of the specified BizDate parameter value is invalid. The value must be in UTC, for example, 2016-06-29T19:00:00Z.
InvalidBizDate.BeyondCurrent EndTime beyond current time. 400 The error message returned when the time specified by the BizDate parameter is later than the current time.