查询频道历史并发数据

接口描述

1、获取频道在某个日期区间并发人数
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/statistics/concurrence

在线API调用

请求方式

GET

接口约束

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

2、开始日期和结束日期的时间跨度：最多查两个月内的数据

3、按照时间升序排序

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	String	频道号
startDate	true	String	开始日期，格式：yyyy-MM-dd
endDate	true	String	结束日期，格式：yyyy-MM-dd

示例

http://api.polyv.net/live/v3/channel/statistics/concurrence?endDate=2021-3-10&appId=frlr1zazn3&sign=8AAC3157EBB79FF42FA07A72335864A0&userId=1b448be323&channelId=1965681&startDate=2021-3-9&timestamp=1621842387331

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Arrray	请求成功时为日期区间内的并发信息【详见Data参数描述】，请求失败时为空

Data参数描述

参数名	类型	说明
day	String	并发日期，格式：yyyy-MM-dd
minute	String	并发时间点，格式：HH:mm
viewers	Integer	并发人数

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelViewDataTest.class);
/**
 * 查询频道历史并发数据
 * @throws IOException
 */
@Test
public void testConcurrence() 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/concurrence";
    String channelId = "1965681";
    String startDate = "2021-3-9";
    String endDate = "2021-3-10";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("userId",userId);
    requestMap.put("channelId",channelId);
    requestMap.put("startDate",startDate);
    requestMap.put("endDate",endDate);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道历史并发数据，返回值：{}",response);
    //do somethings

}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "day":"2021-03-09",
            "minute":"00:00",
            "viewers":0
        },
        {
            "day":"2021-03-10",
            "minute":"00:00",
            "viewers":0
        }
    ]
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}