查询多个频道概览统计数据

接口描述

1、根据提交的频道号，查询频道有关信息的统计数据，数据会根据频道号进行汇总，返回pc端播放时长、pc端播放流量、移动端播放时长、移动端播放流量等。
2、接口URL中的{userId}为直播账号ID
3、接口支持https协议

接口URL

http://api.polyv.net/live/v2/statistics/{userId}/channel_summary

在线API调用

请求方式

POST

接口约束

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

请求参数描述

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

示例

http://api.polyv.net/live/v2/statistics/1b448be323/channel_summary

表单参数：

endDate=2021-3-10&appId=frlr1zazn3&sign=F41732400823BE2D36DF9BF3294AC3F2&channelIds=1965681%2C2149813&startDate=2021-3-9&timestamp=1621842318097

响应参数描述

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

Data参数描述

参数名	类型	说明
userId	String	账号Id
channelId	String	频道号
name	String	频道名称
pcPlayDuration	Integer	pc端播放时长，单位：分钟
pcFlowSize	Long	pc端播放流量，单位：bytes
pcVideoView	Integer	pc端播放量
pcUniqueViewer	Integer	pc端唯一观众数
mobilePlayDuration	Integer	移动端播放时长，单位：分钟
mobileFlowSize	Long	移动端播放流量，单位：bytes
mobileVideoView	Integer	移动端播放量
mobileUniqueViewer	Integer	移动端唯一观众数
livePcPlayDuration	Integer	PC直播播放时长，单位：分钟
playbackPcPlayDuration	Integer	PC回放播放时长，单位：分钟
liveMobilePlayDuration	Integer	移动端直播播放时长，单位：分钟
playbackMobilePlayDuration	Integer	移动端回放播放时长，单位：分钟
unknownPcPlayDuration	Integer	pc其他播放时长，单位：分钟
unknownMobilePlayDuration	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 testChannelSummary() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/statistics/%s/channel_summary",userId);
    String startDate = "2021-3-9";
    String endDate = "2021-3-10";
    String channelIds = "1965681,2149813";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("startDate",startDate);
    requestMap.put("endDate",endDate);
    requestMap.put("channelIds",channelIds);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试查询多个频道概览统计数据，返回值：{}",response);
    //do somethings

}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "userId":null,
            "channelId":2149813,
            "name":"创建并初始化频道-验证码观看直播一次",
            "categoryName":null,
            "pcPlayDuration":0,
            "pcFlowSize":0,
            "pcVideoView":0,
            "pcUniqueViewer":0,
            "mobilePlayDuration":0,
            "mobileFlowSize":0,
            "mobileVideoView":0,
            "mobileUniqueViewer":0,
            "livePcPlayDuration":0,
            "playbackPcPlayDuration":0,
            "unknownPcPlayDuration":0,
            "liveMobilePlayDuration":0,
            "playbackMobilePlayDuration":0,
            "unknownMobilePlayDuration":0,
            "creatorName":null
        },
        {
            "userId":null,
            "channelId":1965681,
            "name":"Junit测试(勿删)",
            "categoryName":null,
            "pcPlayDuration":0,
            "pcFlowSize":0,
            "pcVideoView":0,
            "pcUniqueViewer":0,
            "mobilePlayDuration":0,
            "mobileFlowSize":0,
            "mobileVideoView":0,
            "mobileUniqueViewer":0,
            "livePcPlayDuration":0,
            "playbackPcPlayDuration":0,
            "unknownPcPlayDuration":0,
            "liveMobilePlayDuration":0,
            "playbackMobilePlayDuration":0,
            "unknownMobilePlayDuration":0,
            "creatorName":null
        }
    ]
}

异常示例

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