查詢播放時長統計

介面描述

1、通过视频id和时间范围查询单个或全部视频的播放时长统计数据，播放后生成数据需间隔一到两小时
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/play-duration/{userid}

線上API呼叫

請求方式

GET

介面限制

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

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

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

請求參數描述

範例

http://api.polyv.net/v2/play-duration/1b448be323?vid=1b448be323b8d9b9489dcd7e8e09f087_1&start=2021-03-30&sign=645AB5A43A556E6D6AF8A577C287266E0BC822D1&end=2021-04-01&ptime=1617767033059

回應參數描述

data參數描述

返回錯誤代碼列表

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
 * 查询播放时长统计
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetPlayDuration() 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/play-duration/%s", userId);
    String vid = "1b448be323b8d9b9489dcd7e8e09f087_1";
    String dr = "last_month";
    String start = "2021-03-30";
    String end = "2021-04-01";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("start", start);
    requestMap.put("end", end);
    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": [
        {
            "currentDay": "2021-03-30",
            "pcPlayDuration": 0,
            "formatPcPlayDuration": "00:00:00",
            "pcPlayDurationVideoAvg": 0,
            "formatPcPlayDurationVideoAvg": "00:00:00",
            "pcPlayDurationPersonAvg": 0,
            "formatPcPlayDurationPersonAvg": "00:00:00",
            "mobilePlayDuration": 0,
            "formatMobilePlayDuration": "00:00:00",
            "mobilePlayDurationVideoAvg": 0,
            "formatMobilePlayDurationVideoAvg": "00:00:00",
            "mobilePlayDurationPersonAvg": 0,
            "formatMobilePlayDurationPersonAvg": "00:00:00"
        },
        {
            "currentDay": "2021-03-31",
            "pcPlayDuration": 1,
            "formatPcPlayDuration": "00:00:01",
            "pcPlayDurationVideoAvg": 1,
            "formatPcPlayDurationVideoAvg": "00:00:01",
            "pcPlayDurationPersonAvg": 1,
            "formatPcPlayDurationPersonAvg": "00:00:01",
            "mobilePlayDuration": 0,
            "formatMobilePlayDuration": "00:00:00",
            "mobilePlayDurationVideoAvg": 0,
            "formatMobilePlayDurationVideoAvg": "00:00:00",
            "mobilePlayDurationPersonAvg": 0,
            "formatMobilePlayDurationPersonAvg": "00:00:00"
        },
        {
            "currentDay": "2021-04-01",
            "pcPlayDuration": 0,
            "formatPcPlayDuration": "00:00:00",
            "pcPlayDurationVideoAvg": 0,
            "formatPcPlayDurationVideoAvg": "00:00:00",
            "pcPlayDurationPersonAvg": 0,
            "formatPcPlayDurationPersonAvg": "00:00:00",
            "mobilePlayDuration": 0,
            "formatMobilePlayDuration": "00:00:00",
            "mobilePlayDurationVideoAvg": 0,
            "formatMobilePlayDurationVideoAvg": "00:00:00",
            "mobilePlayDurationPersonAvg": 0,
            "formatMobilePlayDurationPersonAvg": "00:00:00"
        }
    ]
}

異常範例

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