All Products
Search
Document Center

ApsaraVideo VOD:DescribePlayTopVideos

Last Updated:Nov 09, 2022

Queries daily playback statistics on top videos, including video views, unique visitors, and total playback duration.

Operation Description

Note
  • This operation is available only in the China (Shanghai) region.
  • You can query playback statistics on top 1,000 videos at most on a specified day. By default, top videos are sorted in descending order based on video views.
  • 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.
  • Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
    • Condition keyword: refers to the condition keyword defined by the cloud product itself.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    Operateaccess levelResource typeconditional keywordAssociation operation
    vod:DescribePlayTopVideosList
    • VOD
      acs:vod:*:{#accountId}:*/*
      without
    without

    Request parameters

    ParameterTypeRequiredDescriptionExample
    BizDatestringYes

    The time 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
    PageNolongNo

    The number of the page to return. Default value: 1.

    1
    PageSizelongNo

    The number of entries to return on each page. Default value: 100. Maximum value: 1000.

    100

    Response parameters

    ParameterTypeDescriptionExample
    object
    PageNolong

    The page number of the returned page.

    1
    RequestIdstring

    The ID of the request.

    4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B"
    PageSizelong

    The number of entries returned per page.

    100
    TotalNumlong

    The total number of entries that were collected in playback statistics on top videos.

    2
    TopPlayVideosarray

    The daily playback statistics on each top video.

    object
    Titlestring

    The title of the video.

    Four streams (two streams encrypted): LD-HLS-encrypted + SD-MP4 + HD-H
    VVstring

    The number of video views.

    107
    PlayDurationstring

    The playback duration. Unit: milliseconds.

    4640369
    VideoIdstring

    The ID of the video.

    2a8d4cb9ecbb487681473a15****8fda
    UVstring

    The number of unique visitors.

    1

    Example

    Normal return example

    JSONFormat

    {
      "PageNo": 1,
      "RequestId": "4B0BCF9F-2FD5-4817-****-7BEBBE3AF90B\"",
      "PageSize": 100,
      "TotalNum": 2,
      "TopPlayVideos": [
        {
          "Title": "Four streams (two streams encrypted): LD-HLS-encrypted + SD-MP4 + HD-H",
          "VV": "107",
          "PlayDuration": "4640369",
          "VideoId": "2a8d4cb9ecbb487681473a15****8fda",
          "UV": "1"
        }
      ]
    }

    Error codes

    For a list of error codes, visit the API error center.

    Common errors

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

    Error codeError messageHTTP status codeDescription
    InternalErrorThe request processing has failed due to some unknown error.500The error message returned because an unknown error has occurred.
    InvalidBizDate.MalformedSpecified BizDate is malformed.400The error message returned because the format of the time that is specified by the BizDate 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.
    InvalidBizDate.BeyondCurrentEndTime beyond current time.400The error message returned because the time that is specified by the BizDate parameter is later than the current time.