Query Channel Terminal Distribution Statistics

Updated: 2023-02-20 13:00:22

API Description

1、查询频道观看终端分布统计信息
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/statistics/browser-summary

Request Method

GET

API Constraints

This API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details
The maximum time span is 90 days.
Statistical data has a 30-minute delay.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server to obtain response data.` [See Signature Generation Rules]
channelId	true	String	Channel ID
startTime	true	Long	Start time, 13-digit millisecond timestamp
endTime	true	Long	End time, 13-digit millisecond timestamp

Example

http://api.polyv.net/live/v4/channel/statistics/browser-summary?appId=frlr1zazn3&sign=BC1EE579585A98E69120E3350FE3DAC0&startTime=1651386101000&endTime=1652336501462&channelId=2272655&timestamp=1652414352304

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. Returns `success` on success, `error` on failure
success	Boolean	Whether the request was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not related to business logic
error	Object	Error information when status code is not 200 [See Error Field Description]
data	Object	[See data Field Description]

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponds to error.code

data Parameter Description

Parameter	Type	Description
name	String	Terminal name
platform	String	Terminal type pc: PC mobile: Mobile
plays	Integer	Number of views
viewers	Integer	Number of unique viewers (based on param1, i.e., viewerId)
ips	Integer	Number of unique IPs
playDuration	Integer	Viewing duration, in minutes
percent	Double	Percentage, rounded to two decimal places (based on number of views)

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 cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询频道终端分布数据统计
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getBrowsersSummaryTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/statistics/browser-summary";
    String channelId = "2272655";
    String startTime = "1651386101000";
    String endTime = "1652336501462";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("startTime", startTime);
    requestMap.put("endTime", endTime);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    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",
    "requestId": "1375e52c9fc041a89ce61daf28f79737.58.16520842026550383",
    "data": [
        {
            "name": "Chrome",
            "platform": "pc",
            "plays": 101,
            "viewers": 11,
            "ips": 28,
            "playDuration": 586,
            "percent": 69.18
        },
        {
            "name": "weixin",
            "platform": "mobile",
            "plays": 29,
            "viewers": 13,
            "ips": 10,
            "playDuration": 49,
            "percent": 19.86
        },
        {
            "name": "Safari",
            "platform": "mobile",
            "plays": 11,
            "viewers": 4,
            "ips": 5,
            "playDuration": 12,
            "percent": 7.53
        },
        {
            "name": "android-sdk",
            "platform": "mobile",
            "plays": 4,
            "viewers": 1,
            "ips": 1,
            "playDuration": 24,
            "percent": 2.74
        },
        {
            "name": "Other",
            "platform": "mobile",
            "plays": 1,
            "viewers": 1,
            "ips": 1,
            "playDuration": 7,
            "percent": 0.68
        }
    ],
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API