全部产品
Search

搜索本产品

    视频点播：DescribePlayUserTotal - 播放数据总量统计

    文档中心

    视频点播：DescribePlayUserTotal - 播放数据总量统计

    更新时间：Nov 06, 2024

    调用本接口获取指定时间范围内的每日播放数据总量统计，统计指标包括总播放次数、总播放用户数、总播放时长、播放时长分布。

    接口说明

    • 目前服务地址仅支持：华东 2（上海）。
    • 仅支持统计使用了阿里云播放器 SDK 的播放数据。
    • 以北京时间（UTC+8）为基准，每天上午 9 点生成前一天的播放数据统计。
    • 支持查询 2018-01-01 之后的数据，数据查询的起止时间跨度最大为 180 天。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    vod:DescribePlayUserTotalget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    StartTimestring是

    指定查询的起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2016-06-29T13:00:00Z
    EndTimestring是

    指定查询的结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    说明 结束时间需大于起始时间，且与起始时间的最大跨度为 180 天。
    		2016-06-30T13:00:00Z

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    用户每天播放总量统计数据。

    UserPlayStatisTotalobject
    Datestring

    播放日期，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2016-06-30T13:00:00Z
    PlayDurationstring

    播放总时长。单位：毫秒。

    		9340070
    PlayRangestring

    播放时长分布。

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

    播放次数总量统计。

    Flashstring

    Flash 播放器播放总次数。

    		2
    iOSstring

    iOS 播放器播放总次数。

    		0
    HTML5string

    HTML5 播放器播放总次数。

    		2
    Androidstring

    Android 播放器播放总次数。

    		161
    UVobject

    播放用户数总量统计。

    Flashstring

    Flash 播放器播放总用户数。

    		1
    iOSstring

    iOS 播放器播放总用户数。

    		0
    HTML5string

    HTML5 播放器播放总用户数。

    		1
    Androidstring

    Android 播放器播放总用户数。

    		2

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "1FAFB884-D5A7-47D1-****-8928AA9C8720",
  "UserPlayStatisTotals": {
    "UserPlayStatisTotal": [
      {
        "Date": "2016-06-30T13:00:00Z",
        "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"
        }
      }
    ]
  }
}

    错误码

    访问错误中心查看更多错误码。

    接口错误码

    下表列举了本接口特有的错误码。

    错误代码错误信息HTTP 状态码说明
    InternalErrorThe request processing has failed due to some unknown error.500后台发生未知错误。
    InvalidStartTime.MalformedSpecified StartTime is malformed.400StartTime 格式错误，应为 UTC 时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
    InvalidEndTime.MalformedSpecified EndTime is malformed.400EndTime 格式错误，应为 UTC 时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
    InvalidEndTime.BeyondCurrentEndTime beyond current time.400EndTime 不能超过当前时间。
    InvalidEndTime.MismatchStartTime or EndTime is mismatch.400StartTime 和 EndTime 不匹配。