All Products
Search
Document Center

ApsaraVideo VOD:DescribePlayUserTotal

Last Updated:Dec 06, 2024

Queries the daily playback statistics in a specified time range. The playback statistics include the total number of views, total number of viewers, total playback duration, and playback duration distribution.

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 data that is generated since January 1, 2018. The maximum time range to query is 180 days.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribePlayUserTotalget
*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. 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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1FAFB884-D5A7-47D1-****-8928AA9C8720
UserPlayStatisTotalsarray<object>

The daily playback statistics.

UserPlayStatisTotalobject
Datestring

The date. The date is displayed in the yyyy-MM-dd format.

20170120
PlayDurationstring

The total playback duration. Unit: milliseconds.

9340070
PlayRangestring

The distribution of the playback duration.

"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%"
VVobject

The total number of video views.

Flashstring

The total number of video views played by using the Flash player.

2
iOSstring

The total number of video views played by using ApsaraVideo Player SDK for iOS.

0
HTML5string

The total number of video views played by using the HTML5 player.

2
Androidstring

The total number of video views played by using ApsaraVideo Player SDK for Android.

161
UVobject

The total number of unique visitors.

Flashstring

The total number of unique visitors who use the Flash player.

1
iOSstring

The total number of unique visitors who use ApsaraVideo Player SDK for iOS.

0
HTML5string

The total number of unique visitors who use the HTML5 player.

1
Androidstring

The total number of unique visitors who use ApsaraVideo Player SDK for Android.

2

Examples

Sample success responses

JSONformat

{
  "RequestId": "1FAFB884-D5A7-47D1-****-8928AA9C8720",
  "UserPlayStatisTotals": {
    "UserPlayStatisTotal": [
      {
        "Date": "20170120",
        "PlayDuration": "9340070",
        "PlayRange": "\"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%\"",
        "VV": {
          "Flash": "2",
          "iOS": "0",
          "HTML5": "2",
          "Android": "161"
        },
        "UV": {
          "Flash": "1",
          "iOS": "0",
          "HTML5": "1",
          "Android": "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 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.