Query Video Viewing Logs for a Specific Day

API Description

1、通过具体时间查询观看日志
2、从播放行为产生到数据可查询的间隔时间为1~2小时
3、响应参数消耗流量（flowSize字段）的计算依赖于CDN日志，为了保证数据完整性，流量数据需要间隔一个自然日才会生成
4、接口URL中的{userid}为点播账号userid，具体参考【获取密钥】
5、接口支持https协议

API URL

http://api.polyv.net/v2/data/{userid}/viewlog

Online API Call

Request Method

POST

API Constraints

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

2. The concatenation rule for sign (signature) is: userid=parameter&ptime=parameter&day=parametersecretkey, and it is passed along with sign via the URL.

Request Parameter Description

Example

http://api.polyv.net/v2/data/1b448be323/viewlog

Form Parameters:

vid=1b448be323615635294a548b3c8a9953_1&sign=AD77F4AFEFA3D3DE07BDD31503A363A21D1A4536&cataid=1602671097888&type=json&ptime=1617847185866&day=20210407

Response Parameter Description

data Field Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The test case files HttpUtil.java and VodSignUtil.java are included in the download package.

It is strongly recommended to use the VOD Java SDK for API integration. The VOD Java SDK provides a 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 testGetDailyViewlog() 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/data/%s/viewlog", userId);
    String day = "20210407";
    String type = "json";
    String vid = "1b448be323615635294a548b3c8a9953_1";
    String cataid = "1602671097888";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("day", day);
    requestMap.put("type", type);
    requestMap.put("vid", vid);
    requestMap.put("cataid", cataid);

    //系统只对部分参数进行签名
    Map<String, String> signMap = new HashMap<>();
    signMap.put("userid", userId);
    signMap.put("ptime", ptime);
    signMap.put("day", day);
    requestMap.put("sign", VodSignUtil.getSign(signMap, secretKey));

    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试查询某一天的视频观看日志,{}", response);
    //do somethings
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": [{
        "playId": "1617789715498X1074620",
        "userId": "1b448be323",
        "videoId": "1b448be323615635294a548b3c8a9953_1",
        "playDuration": 6,
        "stayDuration": 10,
        "currentTimes": 2,
        "duration": 11,
        "flowSize": 0,
        "sessionId": "",
        "param1": "",
        "param2": "",
        "param3": "",
        "param4": "",
        "param5": "",
        "ipAddress": "xxxxxxx",
        "country": "中国",
        "province": "湖南",
        "city": "长沙",
        "isp": "湖南电信",
        "referer": "https://share.plvideo.cn/front/video/preview?vid=1b448be323615635294a548b3c8a9953_1",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36",
        "operatingSystem": "Windows",
        "browser": "Chrome",
        "isMobile": "N",
        "currentDay": "2021-04-07",
        "currentHour": 18,
        "createdTime": 1617790069000,
        "lastModified": 1617800772000,
        "viewerId": "",
        "viewerName": "",
        "viewSource": "vod_pc_html5"
    }, {
        "playId": "1617766244609X1752092",
        "userId": "1b448be323",
        "videoId": "1b448be323615635294a548b3c8a9953_1",
        "playDuration": 7,
        "stayDuration": 10,
        "currentTimes": 10,
        "duration": 11,
        "flowSize": 0,
        "sessionId": "",
        "param1": "",
        "param2": "",
        "param3": "",
        "param4": "",
        "param5": "",
        "ipAddress": "xxxxxxx",
        "country": "中国",
        "province": "湖南",
        "city": "长沙",
        "isp": "湖南电信",
        "referer": "https://my.polyv.net/secure/video/",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36 Edg/89.0.774.68",
        "operatingSystem": "Windows",
        "browser": "Chrome",
        "isMobile": "N",
        "currentDay": "2021-04-07",
        "currentHour": 11,
        "createdTime": 1617766571000,
        "lastModified": 1617777096000,
        "viewerId": "",
        "viewerName": "",
        "viewSource": "vod_pc_html5"
    }]
}

Error Example

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