查询频道多场次概览统计数据

接口描述

1、接口用于统计直播间内多场次的直播的观看数据，数据会根据场次号进行汇总，返回观看UV、观看PV等。
2、接口支持https协议
3、需要在直播完成后一小时才生成最新场次的统计数据

接口URL

http://api.polyv.net/live/v3/channel/statistics/get-session-stats

在线API调用

请求方式

GET

接口约束

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

2、场次ID和直播开始结束时间必填一项，场次ID和直播开始结束时间同时存在的情况下，只取场次ID

3、startTime和endTime相隔不可以超过30天

4、观看时长是根据每条观看记录向上取整(不足1分钟按1分钟计算)，最后再相加后的结果。例如：单条观看记录时长为1分36秒，统计时会计算为2分钟。

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	String	频道号
sessionIds	false	String	场次ID，多个场次使用逗号分隔，如：fw82mayhuy,fvipafupmh，场次ID和直播开始结束时间必填一项，场次ID和直播开始结束时间同时存在时，使用场次ID进行查询
startTime	false	Long	直播开始时间，13位毫秒级时间戳，开始时间和结束时间相隔不可以超过30天
endTime	false	Long	直播结束时间，13位毫秒级时间戳，场次ID和直播开始结束时间必填一项

示例

http://api.polyv.net/live/v3/channel/statistics/get-session-stats?appId=frlr1zazn3&sign=F4DF8748424C8FDCE3DBF9C96C134C1A&startTime=1621842273181&endTime=1621842273181&userId=1b448be323&channelId=1965681&timestamp=1621842273181&sessionIds=ftmnaan4l3%2Cfv3ma84e63

响应参数描述

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

Data参数描述

参数名	类型	说明
list	Array	直播间内多场次的观看数据列表【详见List参数描述】

List参数描述

参数名	类型	说明
channelId	String	频道号
sessionId	String	场次ID
name	String	场次名称
startTime	Long	场次开始时间，13位毫秒级时间戳
endTime	Long	场次结束时间，13位毫秒级时间戳
duration	Integer	直播时长，单位秒
liveUV	Integer	直播观看用户数
livePV	Integer	直播观看次数
playbackUV	Integer	回放观看用户数
playbackPV	Integer	回放观看次数
totalPlayDuration	Integer	观看直播总时长，单位秒
totalPlaybackDuration	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 testGetSessionStats() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/statistics/get-session-stats";
    String channelId = "1965681";
    String sessionIds = "ftmnaan4l3,fv3ma84e63";
    String startTime = String.valueOf(System.currentTimeMillis());
    String endTime = String.valueOf(System.currentTimeMillis());

    //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("sessionIds",sessionIds);
    requestMap.put("startTime",startTime);
    requestMap.put("endTime",endTime);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道多场次概览统计数据，返回值：{}",response);
    //do somethings

}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "list":[
            {
                "channelId":1965681,
                "sessionId":"ftmnaan4l3",
                "name":"Junit测试(勿删)",
                "startTime":1606986241000,
                "duration":174,
                "liveUV":1,
                "livePV":1,
                "playbackPV":0,
                "playbackUV":0
            },
            {
                "channelId":1965681,
                "sessionId":"fv3ma84e63",
                "name":"Junit测试(勿删)",
                "startTime":1611137359000,
                "duration":203,
                "liveUV":1,
                "livePV":1,
                "playbackPV":0,
                "playbackUV":0
            }
        ]
    }
}

异常示例

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