查詢直播場次彙總資料列表
更新時間:2024-12-03 09:22:48
介面描述
1、<p>查询直播场次汇总数据列表</p>
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/statistics/session-stats/summary/list
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| timestamp | true | String | 當前13位毫秒級時間戳,3分鐘內有效 |
| channelId | false | String | 頻道id |
| keyword | false | String | 場次名稱或場次ID (模糊比對) |
| endTime | false | String | 結束時間 時間戳 |
| pageNumber | false | String | 當前頁數,第幾頁 |
| pageSize | false | String | 分頁大小 |
| startTime | false | String | 開始時間 時間戳 |
範例
http://api.polyv.net/live/v4/statistics/session-stats/summary/list?pageNumber=1&appId=frlr1zazn3&sign=76AEC105CAD0C5091FCECCF14FC6DA74&pageSize=10&channelId=1965681×tamp=1699580616354
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態 |
| data | Object | 【詳見Data參數描述】 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error參數描述】 |
| requestId | String | 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應該和業務掛上鉤 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
Data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| contents | Array | 分頁資料集合【詳見Contents參數描述】 |
| pageNumber | Integer | 當前頁數,第幾頁 |
| pageSize | Integer | 分頁大小 |
| totalItems | Integer | 總記錄數 |
| totalPages | Integer | 總頁數 |
Contents參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| id | Integer | id |
| channelId | Integer | 頻道id |
| sessionId | String | 場次id |
| name | String | 場次名稱 |
| attendanceActual | Integer | 實際到場人數 |
| attendanceExpected | Integer | 報名人數/白名單人數 |
| attendanceType | Integer | 到場數量類型 0無資料 1報名觀看 2白名單觀看 |
| averagePlayDuration | Integer | 平均觀看時長,分鐘 |
| endTime | String | 直播結束時間 |
| maxConcurrencyCount | Integer | 最高並發數 |
| mobileUniqueViewer | Integer | 行動端觀看人數 |
| pcUniqueViewer | Integer | PC端觀看人數 |
| playCount | Integer | 回放播放量 |
| playDuration | Integer | 回放播放時長,分鐘 |
| startDuration | Integer | 開播時長,秒 |
| startTime | String | 直播開始時間 |
| totalPlayDuration | Integer | 直播總觀看時長,分鐘 |
| uniqueViewer | Integer | 觀看人數 |
| userId | String | POLYV用戶ID,和保利威官網一致,取得路徑:官網->登入->直播(開發設定) |
| videoView | Integer | 觀看次數 |
| viewerCount | Integer | 回放人數 |
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 summaryListTest() 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/statistics/session-stats/summary/list";
String channelId="1965681";
String endTime="";
String pageNumber="1";
String pageSize="10";
String startTime="";
//http 调用逻辑
Map<String, String> requestMap=new HashMap<>();
requestMap.put("appId",appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
// requestMap.put("endTime", endTime);
requestMap.put("pageNumber",pageNumber);
requestMap.put("pageSize",pageSize);
// requestMap.put("startTime", startTime);
requestMap.put("sign",LiveSignUtil.getSign(requestMap,appSecret));
String response=HttpUtil.get(url,requestMap);
log.info("测试查询直播场次汇总数据列表成功:{}",response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "3a05f8f5f6984232808d9e099f9ee938.3338.16995806199894399",
"data": {
"pageNumber": 1,
"pageSize": 1,
"totalPages": 9,
"totalItems": 9,
"contents": [
{
"channelId": 1965681,
"sessionId": "ggxjxhcvg9",
"name": "直播测试-页面信息设置",
"startTime": 1672726467000,
"endTime": 1686810675000,
"playDuration": 0,
"playCount": 0,
"viewerCount": 0,
"maxConcurrencyCount": 0,
"startDuration": 14084208,
"uniqueViewer": 0,
"videoView": 0,
"pcUniqueViewer": 0,
"mobileUniqueViewer": 0,
"totalPlayDuration": 0,
"averagePlayDuration": 0,
"attendanceType": 0,
"attendanceExpected": 0,
"attendanceActual": 0,
"userId": "1b448be323"
}
]
},
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
