查詢頻道直播觀看詳情資料
更新時間:2025-08-29 14:14:25
介面說明
1、获取频道观看日志
2、接口URL中的{channelId}为频道号
3、接口支持https协议
4、直播观看详情数据支持查询最近3年内的历史数据,建议将历史数据导出到本地储存,以便后续查询。
介面URL
http://api.polyv.net/live/v1/statistics/{channelId}/viewlog
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、不支援已刪除頻道進行資料查詢
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appid【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| currentDay | true | String | 查詢日期,格式:yyyy-MM-dd |
| userId | true | String | 直播帳號ID |
| param1 | false | String | 觀看用戶ID |
範例
http://api.polyv.net/live/v1/statistics/1965681/viewlog?currentDay=2021-1-20&appId=frlr1zazn3&sign=B4A33B092F5E5B9283C9D8308E10B868&userId=1b448be323¶m1=1b448be323×tamp=1621842550515
回應參數說明
| 欄位 | 類型 | 說明 |
|---|---|---|
| status | String | 狀態值 |
| result | Array | 回應結果集 【詳見Result參數說明】 |
Result參數說明
| 欄位 | 類型 | 說明 |
|---|---|---|
| playId | String | 表示此次播放動作的ID |
| userId | String | 直播帳號ID |
| channelId | String | 頻道號 |
| playDuration | Integer | 播放時長,單位:秒 |
| stayDuration | Integer | 停留時長,單位:秒 |
| sessionId | String | 直播的場次ID |
| param1 | String | 使用POLYV觀看頁的觀眾ID |
| param2 | String | 使用POLYV觀看頁的觀眾暱稱 |
| param3 | String | 觀看日誌類型,預設為live vod:觀看重播 live:直播 |
| param4 | String | POLYV系統參數 |
| param5 | String | POLYV系統參數 |
| ipAddress | String | IP位址 |
| country | String | 國家 |
| province | String | 省份 |
| city | String | 城市 |
| isp | String | ISP電信業者 |
| referer | String | 播放影片頁面地址 |
| userAgent | String | 用戶裝置 |
| operatingSystem | String | 作業系統 |
| browser | String | 瀏覽器 |
| isMobile | String | 是否為行動端 |
| currentDay | String | 查詢日期,格式:yyyy-MM-dd |
| ptype | Integer | 0 或者不傳:一般直播 1:超低延遲直播 rts (已經沒有在使用) 2:PRTC直播(無延遲) |
| firstActiveTime | Long | 進入時間,13位毫秒級時間戳 |
| lastActiveTime | Long | 退出時間,13位毫秒級時間戳 |
| createdTime | Long | 資料入庫時間,13位毫秒級時間戳 |
| lastModified | Long | 資料最後修改時間,13位毫秒級時間戳 |
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 testViewlog() 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/v1/statistics/%s/viewlog","1965681");
String currentDay = "2021-1-20";
String param1 = "1b448be323";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("currentDay",currentDay);
requestMap.put("userId", userId);
requestMap.put("param1",param1);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询频道直播观看详情数据,返回值:{}",response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"status":"success",
"result":[
{
"playId":"1611137360114X1320926",
"userId":"1b448be323",
"channelId":1965681,
"playDuration":182,
"stayDuration":190,
"sessionId":"fv3ma84e63",
"param1":"1b448be323",
"param2":"管理员",
"param3":"live",
"param4":"",
"param5":"",
"ipAddress":"118.249.213.240",
"country":"中国",
"province":"湖南",
"city":"长沙",
"isp":"湖南电信",
"referer":"https://live.polyv.net/#/channel/1965681/monitoring",
"userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:84.0) Gecko/20100101 Firefox/84.0",
"operatingSystem":"Windows",
"browser":"Firefox 8",
"isMobile":"N",
"currentDay":"2021-01-20",
"createdTime":1611137461000,
"lastModified":1611148800000,
"ptype":0
},
{
"playId":"1611127231433X1037457",
"userId":"1b448be323",
"channelId":1965681,
"playDuration":154,
"stayDuration":160,
"sessionId":"fv3hmq3qml",
"param1":"1b448be323",
"param2":"管理员",
"param3":"live",
"param4":"",
"param5":"",
"ipAddress":"118.249.213.240",
"country":"中国",
"province":"湖南",
"city":"长沙",
"isp":"湖南电信",
"referer":"https://live.polyv.net/#/channel/1965681/monitoring",
"userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:84.0) Gecko/20100101 Firefox/84.0",
"operatingSystem":"Windows",
"browser":"Firefox 8",
"isMobile":"N",
"currentDay":"2021-01-20",
"createdTime":1611127282000,
"lastModified":1611138733000,
"ptype":0
}
]
}
異常範例
{
"code":"invalid.request",
"msg":"signature error."
}
