查詢頻道多場次概覽統計資料
更新時間:2026-05-29 16:52:15
介面描述
1、接口用于统计直播间内多场次的直播的观看数据,数据会根据场次号进行汇总,返回观看UV、观看PV等。
2、接口支持https协议
3、需要在直播完成后一小时才生成最新场次的统计数据
介面URL
http://api.polyv.net/live/v3/channel/statistics/get-session-stats
請求方式
GET
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、場次ID和直播開始結束時間必填一項,場次ID和直播開始結束時間同時存在的情況下,只取場次ID
3、startTime和endTime相隔不可以超過30天
4、觀看時長是根據每條觀看記錄無條件進位(不足1分鐘按1分鐘計算),最後再加總後的結果。例如:單條觀看記錄時長為1分36秒,統計時會計算為2分鐘。
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | String | 頻道號 |
| sessionIds | false | String | 場次ID,多個場次使用逗號分隔,如:fw82mayhuy,fvipafupmh,場次ID和直播開始結束時間必填一項,場次ID和直播開始結束時間同時存在時,使用場次ID進行查詢 |
| startTime | false | Long | 直播開始時間,13位毫秒級時間戳,開始時間和結束時間相隔不可以超過30天 |
| endTime | false | Long | 直播結束時間,13位毫秒級時間戳,場次ID和直播開始結束時間必填一項 |
範例
http://api.polyv.net/live/v3/channel/statistics/get-session-stats?appId=frlr1zazn3&sign=F4DF8748424C8FDCE3DBF9C96C134C1A&startTime=1621842273181&endTime=1621842273181&userId=1b448be323&channelId=1965681×tamp=1621842273181&sessionIds=ftmnaan4l3%2Cfv3ma84e63
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 請求成功時為直播觀看資料資訊【詳見Data參數描述】,請求失敗時為空 |
Data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| list | Array | 直播間內多場次的觀看資料列表【詳見List參數描述】 |
List參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| channelId | String | 頻道號 |
| sessionId | String | 場次ID |
| name | String | 場次名稱 |
| startTime | Long | 場次開始時間,13位毫秒級時間戳 |
| endTime | Long | 場次結束時間,13位毫秒級時間戳 |
| duration | Integer | 直播時長,單位秒 |
| liveUV | Integer | 直播觀看用戶數 |
| livePV | Integer | 直播觀看次數 |
| playbackUV | Integer | 回放觀看用戶數 |
| playbackPV | Integer | 回放觀看次數 |
| totalPlayDuration | Integer | 觀看直播總時長,單位秒 |
| totalPlaybackDuration | 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 testGetSessionStats() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "https://api.polyv.net/live/v3/channel/statistics/get-session-stats";
String channelId = "1965681";
String sessionIds = "ftmnaan4l3,fv3ma84e63";
String startTime = String.valueOf(System.currentTimeMillis());
String endTime = String.valueOf(System.currentTimeMillis());
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("userId",userId);
requestMap.put("channelId",channelId);
requestMap.put("sessionIds",sessionIds);
requestMap.put("startTime",startTime);
requestMap.put("endTime",endTime);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询频道多场次概览统计数据,返回值:{}",response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":{
"list":[
{
"channelId":1965681,
"sessionId":"ftmnaan4l3",
"name":"Junit测试(勿删)",
"startTime":1606986241000,
"duration":174,
"liveUV":1,
"livePV":1,
"playbackPV":0,
"playbackUV":0
},
{
"channelId":1965681,
"sessionId":"fv3ma84e63",
"name":"Junit测试(勿删)",
"startTime":1611137359000,
"duration":203,
"liveUV":1,
"livePV":1,
"playbackPV":0,
"playbackUV":0
}
]
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
