查询视频播放的终端环境分布

接口描述

1、查询视频终端环境统计数据，包括浏览器环境，操作系统环境，终端环境。从播放行为产生到数据可查询的间隔时间为1~2小时
2、接口URL中的{userid}为点播账号userid，具体参考【获取密钥】
3、接口支持https协议

接口URL

http://api.polyv.net/v2/device/{userid}

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、请求参数中start（开始日期）与end（结束日期）需要同时传入，仅传一个参数不生效

3、同时传入dr（时间段）与start、end的情况下，仅start、end有效；都不传则dr为默认值7days

请求参数描述

示例

http://api.polyv.net/v2/device/1b448be323?start=2021-03-16&sign=F3A24F3621CE3D0B0B5366E56D95A6E3CF34B2AA&end=2021-03-24&ptime=1617875576619&dr=this_year

响应参数描述

Data参数描述

Device参数描述

OperatingSystem参数描述

Browser参数描述

返回错误代码列表

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。

强烈建议您使用点播Java SDK完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
 * 查询视频播放的终端环境分布
 */
@Test
public void testGetDeviceStat() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("https://api.polyv.net/v2/device/%s", userId);
    String dr = "this_year";
    String start = "2021-03-16";
    String end = "2021-03-24";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("dr", dr);
    requestMap.put("start", start);
    requestMap.put("end", end);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));

    String response = HttpUtil.get(url, requestMap);
    log.debug("测试查询视频播放的终端环境分布,{}", response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "device": [{
            "deviceName": "PC端",
            "videoView": 17,
            "formatPlayDuration": "00:03:10",
            "playDuration": 190,
            "uniqueViewer": 4,
            "percentage": "80.95"
        }, {
            "deviceName": "移动端",
            "videoView": 4,
            "formatPlayDuration": "00:00:57",
            "playDuration": 57,
            "uniqueViewer": 3,
            "percentage": "19.05"
        }],
        "operatingSystem": [{
            "operateSystemName": "Windows",
            "videoView": 17,
            "formatPlayDuration": "00:03:10",
            "playDuration": 190,
            "uniqueViewer": 4,
            "percentage": "80.95"
        }, {
            "operateSystemName": "Android",
            "videoView": 4,
            "formatPlayDuration": "00:00:57",
            "playDuration": 57,
            "uniqueViewer": 3,
            "percentage": "19.05"
        }],
        "browser": [{
            "browserName": "Chrome",
            "formatPcPlayDuration": "00:02:47",
            "pcPlayDuration": 167,
            "pcVideoView": 14,
            "pcUniqueViewer": 3,
            "formatMobilePlayDuration": "00:00:00",
            "mobilePlayDuration": 0,
            "mobileVideoView": 0,
            "mobileUniqueViewer": 0,
            "pcPercentage": "82.35",
            "mobilePercentage": "0.00"
        }, {
            "browserName": "Firefox",
            "formatPcPlayDuration": "00:00:23",
            "pcPlayDuration": 23,
            "pcVideoView": 3,
            "pcUniqueViewer": 1,
            "formatMobilePlayDuration": "00:00:00",
            "mobilePlayDuration": 0,
            "mobileVideoView": 0,
            "mobileUniqueViewer": 0,
            "pcPercentage": "17.65",
            "mobilePercentage": "0.00"
        }, {
            "browserName": "微信",
            "formatPcPlayDuration": "00:00:00",
            "pcPlayDuration": 0,
            "pcVideoView": 0,
            "pcUniqueViewer": 0,
            "formatMobilePlayDuration": "00:00:57",
            "mobilePlayDuration": 57,
            "mobileVideoView": 4,
            "mobileUniqueViewer": 3,
            "pcPercentage": "0.00",
            "mobilePercentage": "100.00"
        }]
    }
}

异常示例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}