Query Video Statistics Summary Data

API Description

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

API URL

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

<a href="/req.html?api=http://api.polyv.net/v2/summary/video"" target="_blank">Online API Call

Request Method

GET

API Constraints

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

2. The request parameters startDate and endDate must be passed together; passing only one parameter will not take effect.

3. If dr is passed together with startDate and endDate, only startDate and endDate are valid. If none are passed, dr defaults to 7days.

Request Parameter Description

Example

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

Response Parameter Description

data Field Description

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click 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);
/**
 * 查询视频统计汇总数据
 */
@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
        
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

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

When passing video IDs in batch, valid video IDs will return normal data, while invalid video IDs will return '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"
        }
    ]
}