CDN

直播按域名维度统计观看时长

最近更新时间:2018-02-07 11:05:56

GetPlayTimeDataByDomain

描述

本接口用于获取直播域名维度的观看时长数据,单位毫秒(ms)

  • 支持批量域名查询,批量域名合并的方法为“将各域名下各流名的总播放时长,除以各域名下各流名的总访问次数”;
  • 最大查询范围:最多可获取最近62天内,7天跨度的数据
  • 统计粒度:5分钟;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度的观看时长为该时段的播放时长总和,除以该时段的总访问次数;
  • 接口性能:接口最大吞吐量为10000,即Region个数*DomainId个数*(EndTime-StartTime)/统计粒度<= 10000。注:在获取多个域名多个区域合并值时,Region个数和DomainId个数按照1计算
  • 时效性:5分钟延迟;
  • 应用场景:
    • 客户查询单个域名或多个域名下的流名,在一段时间内的合并后的观看时长,用于绘制一条曲线;
    • 客户查询单个域名或多个域名下的流名,在一段时间内的详细数据,用于画出多条曲线,表征每个域名的详细情况.

请求参数

参数名 必选 类型及范围 说明
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)间隔
Regions String 计费区域名称, 取值为CN:中国大陆,HK:香港,TW:台湾,AS:亚洲其他,NA:北美洲,SA:南美洲,EU:欧洲,AU:大洋洲,AF:非洲,支持多计费区域查询,多个区域用逗号(半角)分隔,缺省为 CN
ResultType Int 取值为0:多流名多区域数据做合并;1:每个流名每个区域的数据分别返回
Granularity Int 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的观看时长均取播放时长求和,除以该时段的总访问次数的值

返回参数

参数名 类型及范围 说明
StartTime String 开始时间
EndTime String 结束时间
DomainIds String 域名ID列表,逗号(半角)间隔
Regions String 区域,逗号(半角)间隔
ResultType Int 0:多域名多计费区域数据做合并返回;1:每个域名每个计费区域的数据分别返回
Granularity Int 统计粒度;5:5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时力度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的观看时长均取播放时长求和,除以该时段的总访问次数的值
Datas WatchLengthDataByTime[] 每个时间粒度的观看时长数据

PlayTimeDataByTime

参数名 类型及范围 说明
Time String 时间点
TotalSv Long 访问次数总和
TotalPlayTime Long 总播放时长
PlayTime Long 平均观看时长,单位毫秒
DomainIds WatchLengthDataByDomain[] 每个域名的详细观看时长数据 (仅当ResultType取值为1时返回此数据)

PlayTimeDataByDomain

参数名 类型及范围 说明
DomainId String 域名
TotalSv Long 访问次数总和
TotalPlayTime Long 总播放时长
PlayTime Long 平均观看时长,单位毫秒
Regions WatchLengthDataByRegion[] 该域名在每个区域的详细观看时长数据

PlayTimeDataByRegion

参数名 类型及范围 说明
Region String 区域
TotalSv Long 访问次数总和
TotalPlayTime Long 总播放时长
PlayTime Long 平均观看时长,单位毫秒

示例

请求示例

POST方式:

POST /2016-09-01/statistics/GetPlayTimeDataByDomain 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetPlayTimeDataByDomain
x-version: 2016-09-01
Content-Type: application/x-www-form-urlencoded

StartTime=2017-02-21T00:00+0800&EndTime=2017-02-21T02:00+0800&DomainIds=xxxx&ResultType=1&Granularity=20&Regions=CN

返回示例

JSON格式:

{
    "StartTime": "2017-02-21T00:00+0800",
    "EndTime": "2017-02-21T02:00+0800",
    "DomainIds": "a,b,c,dP",
    "Regions": "CN",
    "ResultType": 1,
    "Granularity": 20,
    "Datas": [
        {
            "Time": "2017-02-21T00:00+0800",
            "TotalSv": 943733,
            "TotalPlayTime": 64881879960,
            "PlayTime": 68750,
            "DomainIds": [
                {
                    "DomainId": "a",
                    "TotalSv": 943733,
                    "TotalPlayTime": 64881879960,
                    "PlayTime": 68750,
                    "Regions": [
                        {
                            "Region": "CN",
                            "TotalSv": 943733,
                            "TotalPlayTime": 64881879960,
                            "PlayTime": 68750
                        }
                    ]
                }
            ]
        }
        ...
    ]
}

金山云,开启您的云计算之旅

注册有礼