查詢頻道直播資料
更新時間:2022-09-02 18:08:07
介面描述
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×tamp=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
}
