取得直播間觀眾統計資料

更新時間：2022-09-02 18:08:07

介面說明

1、获取直播间观众统计数据
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/statistics/listViewLogs

請求方式

GET

介面限制

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

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道ID
startTime	true	Long	開始時間，13位毫秒級時間戳
endTime	true	Long	結束時間，13位毫秒級時間戳（只能查詢開始時間所在當月的資料；如需跨月查詢，請分開請求查詢）
pageSize	false	Integer	每頁資料大小，預設10；最小值10；最大值1000
pageNumber	false	Integer	目前的頁數，預設1

範例

http://api.polyv.net/live/v3/channel/statistics/listViewLogs?appId=f2zgpeyx00&timestamp=1638179488464&sign=C55D7D032E3FFB28324442C4DF74C6B2&startTime=1633017600000&endTime=1638288000000&channelId=2000007&pageSize=10&pageNumber=1

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	回應資料

data參數說明

參數名	類型	說明
pageNumber	Integer	目前頁碼
pageSize	Integer	每頁資料量
totalPages	Long	頁面總數
totalItems	Long	總資料量
contents	Array	目前頁內容【詳見contents欄位說明】

contents參數說明

參數名	類型	說明
param1	String	使用者ID
param2	String	使用者暱稱
param3	String	觀看類型 vod:回放; live:直播
province	String	地區
city	String	城市
ipAddress	String	觀眾IP
createdTime	number	進入時間，13位毫秒級時間戳
endTime	number	退出時間，13位毫秒級時間戳
playDuration	number	觀看時長（單位：秒）
browser	String	觀看終端
sessionId	String	場次

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、例外處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(GetCdnViewLog.class);
/**
 * 获取直播间观众统计数据
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetCdnViewLog() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/statistics/listViewLogs";
    String channelId = "2377623";
    long startTime = 1633017600000L;
    long endTime = 1635696000000L;
    int pageSize = 1;
    int pageNumber = 10;

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("startTime",String.valueOf(startTime));
    requestMap.put("endTime",String.valueOf(endTime));
    requestMap.put("pageSize",String.valueOf(pageSize));
    requestMap.put("startTime",String.valueOf());
    requestMap.put("pageNumber",String.valueOf(pageNumber));
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试获取直播间观众统计数据返回值：{}",response);
    //do somethings
    
}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": {
    "pageSize": 10,
    "pageNumber": 1,
    "totalItems": 2,
    "contents": [{
      "playDuration": 27,
      "stayDuration": 30,
      "param1": "",
      "param2": "",
      "param3": "vod",
      "createdTime": 1635439162000,
      "ipAddress": "116.23.155.239",
      "address": "广东广州",
      "referer": "https://console.polyv.net/live/#/channel/2000007/video-library",
      "browser": "Chrome 9",
      "sessionId": "",
      "province": "广东",
      "city": "广州",
      "ptype": 0,
      "originSessionId": ""
    }, {
      "playDuration": 179,
      "stayDuration": 180,
      "param1": "1634632927097",
      "param2": "直播观众/21234",
      "param3": "live",
      "createdTime": 1634633045000,
      "ipAddress": "61.144.145.78",
      "address": "广东广州",
      "referer": "https://live.polyv.cn/watch/2000007",
      "browser": "Chrome 9",
      "sessionId": "g3ffzv8bkj",
      "province": "广东",
      "city": "广州",
      "ptype": 0,
      "originSessionId": "g3ffzv8bkj"
    }],
    "limit": 2,
    "endRow": 2,
    "totalPages": 1,
    "nextPageNumber": 1,
    "startRow": 1,
    "firstPage": true,
    "lastPage": true,
    "prePageNumber": 1,
    "offset": 0
  }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}