保利威文档中心

帮助中心

查询直播场次汇总数据列表

更新时间:2024-12-03 09:22:48

接口描述

1、<p>查询直播场次汇总数据列表</p>

2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/statistics/session-stats/summary/list

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥
sign true String 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
timestamp true String 当前13位毫秒级时间戳,3分钟内有效
channelId false String 频道id
keyword false String 场次名称或场次ID (模糊匹配)
endTime false String 结束时间 时间戳
pageNumber false String 当前页数,第几页
pageSize false String 分页大小
startTime false String 开始时间 时间戳

示例

http://api.polyv.net/live/v4/statistics/session-stats/summary/list?pageNumber=1&appId=frlr1zazn3&sign=76AEC105CAD0C5091FCECCF14FC6DA74&pageSize=10&channelId=1965681&timestamp=1699580616354

响应参数描述

参数名 类型 说明
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参数描述

参数名 类型 说明
id Integer id
channelId Integer 频道id
sessionId String 场次id
name String 场次名称
attendanceActual Integer 实际到场人数
attendanceExpected Integer 报名人数/白名单人数
attendanceType Integer 到场数量类型 0无数据 1报名观看 2白名单观看
averagePlayDuration Integer 平均观看时长,分钟
endTime String 直播结束时间
maxConcurrencyCount Integer 最高并发数
mobileUniqueViewer Integer 移动端观看人数
pcUniqueViewer Integer PC端观看人数
playCount Integer 回放播放量
playDuration Integer 回放播放时长,分钟
startDuration Integer 开播时长,秒
startTime String 直播开始时间
totalPlayDuration Integer 直播总观看时长,分钟
uniqueViewer Integer 观看人数
userId String POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置)
videoView Integer 观看次数
viewerCount Integer 回放人数

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 summaryListTest() 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/statistics/session-stats/summary/list";
    String channelId="1965681";
    String endTime="";
    String pageNumber="1";
    String pageSize="10";
    String startTime="";
    
    //http 调用逻辑
    Map<String, String> requestMap=new HashMap<>();
    requestMap.put("appId",appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
//        requestMap.put("endTime", endTime);
    requestMap.put("pageNumber",pageNumber);
    requestMap.put("pageSize",pageSize);
//        requestMap.put("startTime", startTime);
    
    requestMap.put("sign",LiveSignUtil.getSign(requestMap,appSecret));
    
    String response=HttpUtil.get(url,requestMap);
    
    log.info("测试查询直播场次汇总数据列表成功:{}",response);
    //do somethings
    
    }

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "3a05f8f5f6984232808d9e099f9ee938.3338.16995806199894399",
    "data": {
        "pageNumber": 1,
        "pageSize": 1,
        "totalPages": 9,
        "totalItems": 9,
        "contents": [
            {
                "channelId": 1965681,
                "sessionId": "ggxjxhcvg9",
                "name": "直播测试-页面信息设置",
                "startTime": 1672726467000,
                "endTime": 1686810675000,
                "playDuration": 0,
                "playCount": 0,
                "viewerCount": 0,
                "maxConcurrencyCount": 0,
                "startDuration": 14084208,
                "uniqueViewer": 0,
                "videoView": 0,
                "pcUniqueViewer": 0,
                "mobileUniqueViewer": 0,
                "totalPlayDuration": 0,
                "averagePlayDuration": 0,
                "attendanceType": 0,
                "attendanceExpected": 0,
                "attendanceActual": 0,
                "userId": "1b448be323"
            }
        ]
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询