获取直播间观众统计数据
更新时间:2022-09-02 18:08:07
接口描述
1、获取直播间观众统计数据
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/statistics/listViewLogs
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道ID |
| startTime | true | Long | 开始时间,13位毫秒级时间戳 |
| endTime | true | Long | 结束时间,13位毫秒级时间戳(只能查询开始时间所在当月的数据;如需跨月查询,请分开请求查询) |
| pageSize | false | Integer | 每页数据大小,默认10;最小值10;最大值1000 |
| pageNumber | false | Integer | 当前的页数,默认1 |
示例
http://api.polyv.net/live/v3/channel/statistics/listViewLogs?appId=f2zgpeyx00×tamp=1638179488464&sign=C55D7D032E3FFB28324442C4DF74C6B2&startTime=1633017600000&endTime=1638288000000&channelId=2000007&pageSize=10&pageNumber=1
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 响应数据 |
data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageNumber | Integer | 当前页码 |
| pageSize | Integer | 每页数据量 |
| totalPages | Long | 页面总数 |
| totalItems | Long | 总数据量 |
| contents | Array | 当前页内容【详见contents字段说明】 |
contents参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| param1 | String | 用户ID |
| param2 | String | 用户昵称 |
| param3 | String | 观看类型 vod:回放; live:直播 |
| province | String | 地区 |
| city | String | 城市 |
| ipAddress | String | 观众IP |
| createdTime | number | 进入时间,13位毫秒级时间戳 |
| endTime | number | 退出时间,13位毫秒级时间戳 |
| playDuration | number | 观看时长(单位:秒) |
| browser | String | 观看终端 |
| sessionId | String | 场次 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(GetCdnViewLog.class);
/**
* 获取直播间观众统计数据
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testGetCdnViewLog() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/statistics/listViewLogs";
String channelId = "2377623";
long startTime = 1633017600000L;
long endTime = 1635696000000L;
int pageSize = 1;
int pageNumber = 10;
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
requestMap.put("startTime",String.valueOf(startTime));
requestMap.put("endTime",String.valueOf(endTime));
requestMap.put("pageSize",String.valueOf(pageSize));
requestMap.put("startTime",String.valueOf());
requestMap.put("pageNumber",String.valueOf(pageNumber));
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试获取直播间观众统计数据返回值:{}",response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"pageSize": 10,
"pageNumber": 1,
"totalItems": 2,
"contents": [{
"playDuration": 27,
"stayDuration": 30,
"param1": "",
"param2": "",
"param3": "vod",
"createdTime": 1635439162000,
"ipAddress": "116.23.155.239",
"address": "广东广州",
"referer": "https://console.polyv.net/live/#/channel/2000007/video-library",
"browser": "Chrome 9",
"sessionId": "",
"province": "广东",
"city": "广州",
"ptype": 0,
"originSessionId": ""
}, {
"playDuration": 179,
"stayDuration": 180,
"param1": "1634632927097",
"param2": "直播观众/21234",
"param3": "live",
"createdTime": 1634633045000,
"ipAddress": "61.144.145.78",
"address": "广东广州",
"referer": "https://live.polyv.cn/watch/2000007",
"browser": "Chrome 9",
"sessionId": "g3ffzv8bkj",
"province": "广东",
"city": "广州",
"ptype": 0,
"originSessionId": "g3ffzv8bkj"
}],
"limit": 2,
"endRow": 2,
"totalPages": 1,
"nextPageNumber": 1,
"startRow": 1,
"firstPage": true,
"lastPage": true,
"prePageNumber": 1,
"offset": 0
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
