查詢影片統計彙總資料

介面描述

1、批量查询视频播放统计汇总数据
2、从播放行为产生到数据可查询的间隔时间为1~2小时，流量消耗（flowSize字段）的计算依赖于CDN日志，为了保证数据完整性，流量数据需要间隔一个自然日才会生成
3、接口支持https协议

介面URL

http://api.polyv.net/v2/summary/video

線上API呼叫

請求方式

GET

介面限制

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

2、請求參數中startDate（開始日期）與endDate（結束日期）需要同時傳入，僅傳一個參數不生效

3、同時傳入dr（時間段）與startDate、endDate的情況下，僅startDate、endDate有效；都不傳則dr為預設值7days

請求參數說明

範例

http://api.polyv.net/v2/summary/video?vids=1b448be323251079dabeb2066d70fd44_1%2Cabc&sign=8631D872371A8D3BB37C03D261EA5B4AC70AA1D0&ptime=1631245812623&userid=1b448be323&dr=this_year

回應參數說明

data欄位說明

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
 * 查询视频统计汇总数据
 */
@Test
public void videoSummaryData() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/summary/video";
    String vids = "1b448be323251079dabeb2066d70fd44_1,abc";
    String dr = "this_year";
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", timestamp);
    requestMap.put("dr", dr);
    requestMap.put("vids", vids);
    requestMap.put("userid", userId);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询视频统计汇总数据：{}", response);
    //do somethings
        
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": [
        {
            "videoId": "1b448be323251079dabeb2066d70fd44_1",
            "pcVideoView": "8",
            "mobileVideoView": "0",
            "pcUniqueViewer": "8",
            "mobileUniqueViewer": "0",
            "pcFlowSize": 61335157,
            "mobileFlowSize": 0
        },
        {
            "videoId": "abc_a",
            "pcVideoView": "invalid vid",
            "mobileVideoView": "invalid vid",
            "pcUniqueViewer": "invalid vid",
            "mobileUniqueViewer": "invalid vid"
        }
    ]
}

異常範例

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

若是批量傳vid的形式，正常的vid資料會正常返回，異常的vid則返回'invalid vid'

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": [
        {
            "videoId": "1b448be323251079dabeb2066d70fd44_1",
            "pcVideoView": "2",
            "mobileVideoView": "0",
            "pcUniqueViewer": "2",
            "mobileUniqueViewer": "0",
            "pcFlowSize": 11827449,
            "mobileFlowSize": 0
        },
        {
            "videoId": "aaabbb",
            "pcVideoView": "invalid vid",
            "mobileVideoView": "invalid vid",
            "pcUniqueViewer": "invalid vid",
            "mobileUniqueViewer": "invalid vid"
        }
    ]
}