保利威文档中心

幫助中心

查詢觀眾分析

更新時間:2025-01-14 16:24:03

介面描述

1、通过观众id查询观众分析
2、接口URL中的{userid}为点播账号userid,具体参考【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/advance/viewer/{userid}

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、進階分析功能介紹詳見:影片進階分析
3、由於資料量和計算量大,資料分析結果次日才可查詢

請求參數描述

參數名 必選 類型 說明
ptime true Long 當前時間的毫秒級時間戳,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
viewerId true String 自訂觀眾id

範例

http://api.polyv.net/v2/advance/viewer/1b448be323?viewerId=1555313336634&sign=2178D4B940BA22F790D642341947E87631C7C455&ptime=1617790781595

回應參數描述

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

data欄位說明

參數名 類型 說明
userId String POLYV使用者ID,和保利威官網一致,取得路徑:官網->登入->點播(API介面)
viewerId String 觀眾id
viewerNickName String 觀眾暱稱
viewerAatar String 觀眾頭像
ip String ip地址
firstWatchTime Long 首次觀看時間,13位毫秒級時間戳
lastWatchTime Long 最後觀看時間,13位毫秒級時間戳
totalVideoCount Integer 觀看影片總數
totalWatchDuration Integer 觀看總時長,單位:秒
avgCompletionRate Double 平均觀看完成度
返回錯誤代碼列表
錯誤代碼 message 說明
400 sign can not be empty. 加密串為空
400 ptime is too old. 時間戳過期
400 ptime is illegal. ptime超出當前時間3分鐘
400 Could not find user by userid. userid不存在
400 the sign is not right. 加密串錯誤
401 viewerId is blank. viewerId為空
402 cannot find the viewer analytics data. 查不到對應的觀眾分析資料
403 get viewer analytics failed. 查詢觀眾分析資料失敗
500 get viewer analytics failed. please check the backend log 後台拋異常

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodBigdataTest.class);
/**
 * 查询观众分析
 */
@Test
public void testGetViewerAnalysis() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/advance/viewer/%s", userId);
    String viewerId = "1555313336634";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("viewerId", viewerId);

    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.get(url, requestMap);
    log.debug("测试查询观众分析,{}", response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "userId": "1b448be323",
        "viewerId": "1555313336634",
        "viewerNickName": "polyv_user_junit",
        "viewerAatar": null,
        "ip": "xxxxxxx",
        "firstWatchTime": 1617014826000,
        "lastWatchTime": 1617014871000,
        "totalVideoCount": 1,
        "totalWatchDuration": 68,
        "avgCompletionRate": 0.261
    }
}

異常範例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}
联系客服,在线咨询