保利威文档中心

幫助中心

查詢多個頻道概覽統計資料

更新時間:2025-07-30 10:13:32

介面說明

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端播放時長,單位:分鐘
pcVideoView Integer PC端播放量
pcUniqueViewer Integer PC端唯一觀眾數
mobilePlayDuration Integer 行動端播放時長,單位:分鐘
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,
            "pcVideoView":0,
            "pcUniqueViewer":0,
            "mobilePlayDuration":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,
            "pcVideoView":0,
            "pcUniqueViewer":0,
            "mobilePlayDuration":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": ""
}
联系客服,在线咨询