查询频道直播数据

接口描述

1、查询频道直播数据
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/statistics/live-data

请求方式

GET

接口约束

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

2、观看数据更新频率为10分钟

3、数据默认查询时间范围：频道创建时间~当前时间，频道创建时间超过半年则查询最近半年数据

请求参数描述

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

示例

http://api.polyv.net/live/v4/channel/statistics/live-data?appId=frlr1zazn3&sign=4D418459FA42A9F88475022E33945955&channelId=2272655&timestamp=1659056102639

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	【详见data字段说明】

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

data参数描述

参数名	类型	说明
watchData	Object	直播观看数据统计【详见watchData字段说明】
realTimeData	Object	直播实时活跃【详见realTimeData字段说明】
provinceData	Array	省份观看数据汇总【详见provinceData字段说明】

watchData参数描述

参数名	类型	说明
viewers	Integer	观看用户数（基于param1，即viewerId）
plays	Integer	观看次数
playDuration	Integer	播放时长，单位：分钟
averagePlayDuration	Integer	人均观看时长，单位:分钟
pageView	Integer	页面累计观看数，与时间范围无关
likes	Integer	频道累计点赞数，与时间范围无关

realTimeData参数描述

参数名	类型	说明
maxConcurrent	Integer	最高在线人数
date	Long	发生最高在线人数的时间点，13位毫秒级时间戳

provinceData参数描述

参数名	类型	说明
province	String	省份
viewers	Integer	观看用户数
averagePlayDuration	Integer	省份平均观看时长，单位:分钟

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 getLiveDataTest() 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/channel/statistics/live-data";
    String channelId = "2272655";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道直播数据成功：{}", response);
    //do somethings
    
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "68e5160da1484817bba9ec0b63310e95.60.16520919629800561",
    "data": {
        "watchData": {
            "plays": 36,
            "viewers": 15,
            "averagePlayDuration": 25,
            "playDuration": 0,
            "pageView": 9999,
            "likes": 2000
        },
        "realTimeData": {
            "maxConcurrent": 8,
            "date": 1656474424000
        },
        "provinceData": [
            {
                "viewers": 10,
                "averagePlayDuration": 30,
                "province": "湖南"
            },
            {
                "viewers": 5,
                "averagePlayDuration": 20,
                "province": "广东"
            }
        ]
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}