Query Play Duration Statistics

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

2. The request parameters start (start date) and end (end date) must be passed together. Passing only one parameter will not take effect.

3. If both dr (time range) and start/end are passed, only start and end are valid. If none are passed, dr defaults to 7days.

Request Parameter Description

Example

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

Response Parameter Description

Data Parameter Description

Error Code List

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and VodSignUtil.java in the downloaded file.

It is strongly recommended to use the VOD Java SDK for API integration. The VOD Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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"
        }
    ]
}

Error Example

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