查詢後台頻道統計資訊

更新時間：2025-08-29 14:14:25

介面描述

1、查询后台频道统计信息

2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	String	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
endDate	true	String	結束日期，格式：yyyy-MM-dd
startDate	true	String	開始日期，格式：yyyy-MM-dd

範例

https://api.polyv.net/live/v4/channel/statistics/channel-statistic?appId=frlr1zazn3&sign=739AE57DEEFD537131C7F30E85A35480&channelId=3346714&startDate=2023-07-01&endDate=2023-07-10&timestamp=1689046365000

回應參數描述

參數名	類型	說明
code	Integer	狀態碼，與 http 狀態碼相同，用於確定基本的回應狀態
data	Object	頻道統計檢視物件【詳見Data參數描述】
error	Object	狀態碼非200時的錯誤資訊【詳見Error參數描述】
requestId	String	請求ID，每次請求產生的唯一 UUID，僅可用於排查、除錯，不應該和業務掛鉤
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應

Data參數描述

參數名	類型	說明
averagePlayDuration	Integer	人均觀看時長，為(觀看時長/觀看人數ips)向下取整，單位:分鐘
averageTime	Float	人均觀看次數，為(觀看次數/觀看人數ips)*10後向下取整後再除10，所以有一位小數，單位：次
ips	Integer	觀看人數（根據ip地址去重）
viewers	Integer	觀看人數（根據viewerId計算）
playDuration	Integer	觀看時長，單位:分鐘
plays	Integer	觀看次數
uniqueVisitor	Integer	訪問人數
statisticsByViewer	String	是否根據viewerId統計平均觀看時長和次數，Y是，N否
averagePlayDurationByViewer	Integer	人均觀看時長，為(觀看時長/觀看人數viewers)向下取整，單位:分鐘
averageTimeByViewer	Float	人均觀看次數，為(觀看次數/觀看人數viewers)*10後向下取整後再除10，所以有一位小數，單位：次

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 statisticsChannelStatisticTest() 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/channel-statistic";
    String channelId = "";
    String endDate = "";
    String startDate = "";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    requestMap.put("endDate", endDate);
    requestMap.put("startDate", startDate);
    requestMap.put("timestamp", timestamp);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试查询后台频道统计信息成功：{}", response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "a5f8e520709b454f9741570aee9625c1.74.16890463649665219",
    "data": {
        "uniqueVisitor": 23,
        "plays": 71,
        "playDuration": 928,
        "ips": 24,
        "averagePlayDuration": 38,
        "averageTime": 2.9
    },
    "success": true
}

異常範例

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