查詢影片分析

更新時間：2025-01-14 16:23:30

介面說明

1、通过视频id查询视频分析
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

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

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

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

範例

http://api.polyv.net/v2/advance/video/1b448be323?vid=1b448be323fb327a42539cbb788913b4_1&sign=0FF2C07D900C3ABC777A39A210B6CAF118537C06&ptime=1617789916637

回應參數說明

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

data欄位說明

參數名	類型	說明
videoId	String	影片id
videoName	String	影片名稱
duration	Integer	影片時長，單位：秒
playTimes	Integer	播放次數
uniqueViewerCount	Integer	唯一觀眾數
avgCompletionRate	Double	平均觀看完成度
viewHeatmap	String	觀看熱力圖，例如["0-20:662","21-100:665"]代表影片內容的0到20秒有662次觀看，21到100秒有665次觀看
uniqueViewHeatmap	String	唯一觀看熱力圖，例如["0-20:614","21-100:615"]代表影片內容的0到20秒有614個觀眾觀看，21到100秒有615個觀眾觀看

返回錯誤代碼列表

錯誤代碼	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	vid is blank.	影片id為空
402/403	cannot find this video data.	查不到影片分析資料
404	get video analytics detail failed.	後台獲取資料失敗
500	get play list 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 testGetVideoAnalysis() 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/video/%s", userId);
    String vid = "1b448be323fb327a42539cbb788913b4_1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    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": {
        "videoId": "1b448be323fb327a42539cbb788913b4_1",
        "videoName": "防爆演习2",
        "duration": 13,
        "playTimes": 19,
        "uniqueViewerCount": 4,
        "avgCompletionRate": 0.96,
        "viewHeatmap": "[\"0-2:1\"]",
        "uniqueViewHeatmap": "[\"0-2:1\"]"
    }
}

異常範例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}