获取观众观看详情列表
更新时间:2025-08-29 14:14:25
接口描述
1、获取观众观看详情列表
2、接口支持https协议
3、直播观看详情数据支持查询最近3年内的历史数据,建议将历史数据导出到本地储存,以便后续查询。
接口URL
http://api.polyv.net/live/v4/user/viewlog/detail
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | String | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| viewerId | true | String | 观众ID |
| startDate | false | String | 开始日期。格式为yyyy-MM-dd |
| endDate | false | String | 结束日期,必须和开始日期在同一个月。格式为yyyy-MM-dd |
| pageNumber | false | String | 当前页数,第几页 |
| pageSize | false | String | 分页大小 |
示例
http://api.polyv.net/live/v4/user/viewlog/detail?viewerId=1690850466494&pageNumber=1&endDate=2023-08-30&appId=frlr1zazn3&sign=F689BD863E17C07992D636250C82E59C&pageSize=10&startDate=2023-08-01×tamp=1691131188500
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| data | Object | 【详见Data参数描述】 |
| error | Object | 状态码非200时的错误信息【详见Error参数描述】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| contents | Array | 分页数据集合【详见Contents参数描述】 |
| pageNumber | Integer | 当前页数,第几页 |
| pageSize | Integer | 分页大小 |
| totalItems | Integer | 总记录数 |
| totalPages | Integer | 总页数 |
Contents参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| area | String | 地区 |
| browser | String | 观看终端 |
| ip | String | 观众IP |
| nick | String | 昵称 |
| playDuration | String | 观看时长 |
| channelId | Integer | 频道号 |
| sessionId | String | 场次号 |
| startTime | String | 开始时间 |
| viewType | String | 观看类型 |
| viewerId | String | 观众viewerId |
| param4 | String | 自定义参数param4 |
| param5 | String | 自定义参数param5 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 获取观众观看详情列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void viewlogDetailTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/user/viewlog/detail";
String viewerId = "1690850466494";
String startDate = "2023-08-01";
String endDate = "2023-08-30";
String pageNumber = "1";
String pageSize = "10";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("viewerId", viewerId);
requestMap.put("endDate", endDate);
requestMap.put("pageNumber", pageNumber);
requestMap.put("pageSize", pageSize);
requestMap.put("startDate", startDate);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试获取观众观看详情列表成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "7fb274a7c6744907838f4a25096a1fa5.73.16911311915969377",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 1,
"contents": [
{
"viewerId": "1690850466494",
"nick": "1690850466494",
"viewType": "直播",
"sessionId": "gncu0mtdz6",
"startTime": 1690850595000,
"playDuration": "00:00:30",
"channelId": 10002,
"area": "湖南长沙市",
"ip": "175.10.235.43",
"browser": "Mobile Safari"
}
]
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
