查询单个视频的观看完成度

接口描述

1、查询观众累计观看单个视频的完成度情况
2、数据的查询需要间隔一天,该接口需联系客服开通后才能使用
3、观看完成度=用户观看有效时长/视频时长，例如：视频A时长为50分钟，用户使用PC H5观看了第0~20分钟，又使用APP观看了第10~30分钟，此时用户有效观看时长为30分钟，则完成度为 30/50=60%
4、接口URL中的{userid}为点播账号userid，具体参考【获取密钥】
5、接口支持https协议

接口URL

http://api.polyv.net/v2/video/engagement/{userid}/get

在线API调用

请求方式

GET

接口约束

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

请求参数描述

示例

http://api.polyv.net/v2/video/engagement/1b448be323/get?vid=1b448be3230a0194d959426ae005645f_1%27&viewerId=1555313336634&sign=193CA2727C33AA5B439F2FD55C23C0BBC2DAAB4C&ptime=1617931245211

响应参数描述

返回错误代码列表

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
 * 查询单个视频的观看完成度
 */
@Test
public void testGetEngageStat() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/video/engagement/%s/get", userId);
    String vid = "1b448be3230a0194d959426ae005645f_1'";
    String viewerId = "1555313336634";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid",vid);
    requestMap.put("viewerId", viewerId);
    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": 0.33
}

异常示例

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