批量查询视频观看日志
更新时间:2025-01-14 16:21:46
接口描述
1、通过自然月批量获取视频观看日志
2、从播放行为产生到数据可查询的间隔时间为1~2小时
3、响应参数消耗流量(flowSize字段)的计算依赖于CDN日志,为了保证数据完整性,流量数据需要间隔一个自然日才会生成
4、接口URL中的{userid}为点播账号userid,具体参考【获取密钥】
5、接口URL中的{month}为查询月份,格式:yyyyMM
6、接口支持https协议
接口URL
http://api.polyv.net/v2/viewlog/{userid}/monthly/{month}
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| ptime | true | Long | 当前时间的毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| month | true | Integer | 查询月份数据,格式:yyyyMM,例如:202101 |
| numPerPage | false | Integer | 每一页的大小,默认为99 |
| pageNum | false | Integer | 第几页,默认为1 |
| start | false | String | 查询开始日期,格式:yyyy-MM-dd,例如:2021-01-01 |
| end | false | String | 查询结束日期,格式:yyyy-MM-dd,例如:2021-01-05 |
| vid | false | String | 视频id,当视频id为空时,查询该用户所有视频的日志 |
| sessionId | false | String | 用户自定义id |
| currentDay | false | String | 月内某一天的数据,格式:yyyy-MM-dd,例如:2021-01-01 |
示例
http://api.polyv.net/v2/viewlog/1b448be323/monthly/202104?currentDay=2021-04-07&month=202104&sign=504AD715A14CE68DA568B2935953A1796994B3D1&numPerPage=2&ptime=1617852294166&pageNum=1
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Array | 响应成功时返回日志详细信息【详见data字段说明】 |
| total | Integer | 总记录数 |
data字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| playId | String | 表示此次播放动作的id |
| userId | String | POLYV用户ID,和保利威官网一致,获取路径:官网->登录->点播(API接口) |
| videoId | String | 视频id |
| playDuration | Integer | 播放时长,单位为秒,与是否倍速播放无关 (用户观看的总时间,例如:18:00开始看一个视频,看到了18:30,这30分钟就是播放时长) |
| stayDuration | Integer | 页面停留时长,单位为秒,与是否播放视频无关 |
| currentTimes | Integer | 播放时间,单位为秒 (用户观看的最后时间,例如:停止观看视频的时候,进度条最后的分钟数为35分钟,播放时间就是35分钟) |
| duration | Integer | 视频总时长,单位为秒 |
| flowSize | Long | 流量大小,单位为字节 |
| sessionId | String | 用户自定义参数,如学员id等 |
| param1/2/3/4/5 | String | POLYV系统参数 |
| ipAddress | String | ip地址 |
| country | String | 国家 |
| province | String | 省份 |
| city | String | 城市 |
| isp | String | ISP运营商 |
| referer | String | 播放视频页面地址 |
| userAgent | String | 用户设备 |
| operatingSystem | String | 操作系统 |
| browser | String | 浏览器 |
| isMobile | String | 是否为移动端 Y:是 N:否 |
| currentDay | String | 日志查询日期,格式:yyyy-MM-dd |
| currentHour | Integer | 日志创建时间(24小时制小时数),例如:18,表示下午六点创建 |
| viewSource | String | 用户观看渠道 vod_ios_sdk:ios端 vod_android_sdk:安卓端 vod_flash:flash vod_wechat_mini_program:微信小程序 vod_pc_html5:pc端web vod_mobile_html5:移动端web vod_mobile_html5_v2:移动端web v2 polyv-android-sdk: 安卓端投屏 polyv-ios-vod-sdk: ios端投屏 |
| createdTime | Long | 日志创建时间,13位毫秒级的时间戳 |
| lastModified | Long | 日志更新日期,13位毫秒级的时间戳 |
| viewerId | String | 观看者id |
| viewerName | String | 观看者名称 |
返回错误代码列表
| 错误代码 | message | 说明 |
|---|---|---|
| 400 | ptime is illegal. | 时间戳格式问题,或者时间戳超过当前时间3分钟 |
| 400 | sign can not be empty. | 加密串为空 |
| 400 | Could not find user by userid. | 用户id不存在 |
| 400 | ptime is too old. | 时间戳过期(3分钟过期) |
| 400 | the sign is not right. | 加密串错误 |
| 401 | pageNum和numPerPage必须为大于0的正整数. | 分页参数不正确 |
| 402 | month必须为合法的yyyyMM格式. | month格式内容不正确 |
| 500 | 查询失败. | 后台发生错误异常 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。
强烈建议您使用点播Java SDK完成API的功能对接,点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
* 批量查询视频观看日志
* @throws Exception
* @throws NoSuchAlgorithmException
*/
@Test
public void testGetViewlog() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String month = "202104";
String url = String.format("http://api.polyv.net/v2/viewlog/%s/monthly/%s", userId, month);
String currentDay = "2021-04-07";
String numPerPage = String.valueOf(2);
String pageNum = String.valueOf(1);
Map<String, String> requestMap = new HashMap<>();
requestMap.put("ptime", ptime);
requestMap.put("currentDay", currentDay);
requestMap.put("month", month);
requestMap.put("numPerPage", numPerPage);
requestMap.put("pageNum", pageNum);
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": [{
"playId": "1617791143803X1210954",
"userId": "1b448be323",
"videoId": "1b448be323a146649ad0cc89d0faed9c_1",
"playDuration": 21,
"stayDuration": 30,
"currentTimes": 22,
"duration": 191,
"flowSize": 0,
"sessionId": "",
"param1": "",
"param2": "",
"param3": "",
"param4": "",
"param5": "",
"ipAddress": "xxxxxxx",
"country": "中国",
"province": "湖南",
"city": "长沙",
"isp": "湖南电信",
"referer": "https://share.plvideo.cn/front/video/preview?vid=1b448be323a146649ad0cc89d0faed9c_1",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36",
"operatingSystem": "Windows",
"browser": "Chrome",
"isMobile": "N",
"currentDay": "2021-04-07",
"currentHour": 18,
"createdTime": 1617791314000,
"lastModified": 1617802680000,
"viewerId": "",
"viewerName": "",
"viewSource": "vod_pc_html5"
}, {
"playId": "1617791015552X1409047",
"userId": "1b448be323",
"videoId": "1b448be323a146649ad0cc89d0faed9c_1",
"playDuration": 33,
"stayDuration": 40,
"currentTimes": 35,
"duration": 191,
"flowSize": 0,
"sessionId": "",
"param1": "",
"param2": "",
"param3": "",
"param4": "",
"param5": "",
"ipAddress": "xxxxxxx",
"country": "中国",
"province": "湖南",
"city": "长沙",
"isp": "湖南电信",
"referer": "https://share.plvideo.cn/front/video/preview?vid=1b448be323a146649ad0cc89d0faed9c_1",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36",
"operatingSystem": "Windows",
"browser": "Chrome",
"isMobile": "N",
"currentDay": "2021-04-07",
"currentHour": 18,
"createdTime": 1617791294000,
"lastModified": 1617802668000,
"viewerId": "",
"viewerName": "",
"viewSource": "vod_pc_html5"
}],
"total": 8
}
异常示例
{
"code": 400,
"status": "error",
"message": "ptime is too old.",
"data": ""
}
