All Products
Search
Document Center

ApsaraVideo VOD:DescribePlayUserAvg

Last Updated:May 22, 2024

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.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • 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 Key: the condition key that is defined by the cloud service.
    • 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    vod:DescribePlayUserAvgRead
    • All Resources
      *
      none
    none
    vod:DescribePlayUserAvgRead
    • All Resources
      *
      none
    none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    StartTimestringYes

    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
    EndTimestringYes

    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

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    6C7F90B2-BDA4-4FAC-****-A38A121DFE19
    UserPlayStatisAvgsobject []

    The statistics on average playback each day.

    Datestring

    The date when the statistics were generated. The date follows the yyyy-MM-dd format.

    20170120
    AvgPlayDurationstring

    The average playback duration. Unit: milliseconds.

    1035902.8
    AvgPlayCountstring

    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 codeError messageHTTP status codeDescription
    InternalErrorThe request processing has failed due to some unknown error.500The error message returned because an unknown error has occurred.
    InvalidStartTime.MalformedSpecified StartTime is malformed.400The 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.MalformedSpecified EndTime is malformed.400The 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.BeyondCurrentEndTime beyond current time.400The error message returned because the end time that is specified by the EndTime parameter is later than the current time.
    InvalidEndTime.MismatchStartTime or EndTime is mismatch.400The error message returned because the time range that is specified by the StartTime and EndTime parameters is invalid.