Query Terminal Environment Distribution for Video Playback

API Description

1、查询视频终端环境统计数据，包括浏览器环境，操作系统环境，终端环境。从播放行为产生到数据可查询的间隔时间为1~2小时
2、接口URL中的{userid}为点播账号userid，具体参考【获取密钥】
3、接口支持https协议

API URL

http://api.polyv.net/v2/device/{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 provided together; providing only one parameter is invalid.

3. If dr (time period) is provided together with start and end, only start and end are effective. If none are provided, dr defaults to 7days.

Request Parameter Description

Example

http://api.polyv.net/v2/device/1b448be323?start=2021-03-16&sign=F3A24F3621CE3D0B0B5366E56D95A6E3CF34B2AA&end=2021-03-24&ptime=1617875576619&dr=this_year

Response Parameter Description

Data Parameter Description

Device Parameter Description

OperatingSystem Parameter Description

Browser Parameter Description

Error Code List

Java Request Example

For quick integration, 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 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 testGetDeviceStat() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("https://api.polyv.net/v2/device/%s", userId);
    String dr = "this_year";
    String start = "2021-03-16";
    String end = "2021-03-24";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("dr", dr);
    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": {
        "device": [{
            "deviceName": "PC端",
            "videoView": 17,
            "formatPlayDuration": "00:03:10",
            "playDuration": 190,
            "uniqueViewer": 4,
            "percentage": "80.95"
        }, {
            "deviceName": "移动端",
            "videoView": 4,
            "formatPlayDuration": "00:00:57",
            "playDuration": 57,
            "uniqueViewer": 3,
            "percentage": "19.05"
        }],
        "operatingSystem": [{
            "operateSystemName": "Windows",
            "videoView": 17,
            "formatPlayDuration": "00:03:10",
            "playDuration": 190,
            "uniqueViewer": 4,
            "percentage": "80.95"
        }, {
            "operateSystemName": "Android",
            "videoView": 4,
            "formatPlayDuration": "00:00:57",
            "playDuration": 57,
            "uniqueViewer": 3,
            "percentage": "19.05"
        }],
        "browser": [{
            "browserName": "Chrome",
            "formatPcPlayDuration": "00:02:47",
            "pcPlayDuration": 167,
            "pcVideoView": 14,
            "pcUniqueViewer": 3,
            "formatMobilePlayDuration": "00:00:00",
            "mobilePlayDuration": 0,
            "mobileVideoView": 0,
            "mobileUniqueViewer": 0,
            "pcPercentage": "82.35",
            "mobilePercentage": "0.00"
        }, {
            "browserName": "Firefox",
            "formatPcPlayDuration": "00:00:23",
            "pcPlayDuration": 23,
            "pcVideoView": 3,
            "pcUniqueViewer": 1,
            "formatMobilePlayDuration": "00:00:00",
            "mobilePlayDuration": 0,
            "mobileVideoView": 0,
            "mobileUniqueViewer": 0,
            "pcPercentage": "17.65",
            "mobilePercentage": "0.00"
        }, {
            "browserName": "微信",
            "formatPcPlayDuration": "00:00:00",
            "pcPlayDuration": 0,
            "pcVideoView": 0,
            "pcUniqueViewer": 0,
            "formatMobilePlayDuration": "00:00:57",
            "mobilePlayDuration": 57,
            "mobileVideoView": 4,
            "mobileUniqueViewer": 3,
            "pcPercentage": "0.00",
            "mobilePercentage": "100.00"
        }]
    }
}

Error Example

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