Query Channel Historical Peak Concurrent Data

Updated: 2022-09-02 18:08:07

API Description

1、获取频道一定时间范围之内的历史最高并发人数
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/statistics/get-max-history-concurrent

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls have frequency limits. See details
The time span is limited to a maximum of 3 months.
Granularity is limited to minutes only.
Due to the large volume of data and computation, accurate concurrent data can only be queried the next day (aggregated at 2:00 AM).

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details for obtaining keys
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 never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and 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/v3/channel/statistics/get-max-history-concurrent?appId=frlr1zazn3&sign=B3210BAC73B49B619981DA02CE09AAB3&startTime=1609430400000&endTime=1616515200000&channelId=1965681&timestamp=1621842497302

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See global error description
status	String	"success" for success, "error" for failure
message	String	Response description. When code is 400 or 500, provides additional error details
data	String	On success, the maximum historical concurrent user count within the date range. On failure, empty

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source 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(ChannelViewDataTest.class);
/**
 * 查询频道历史最高并发数据
 * @throws IOException
 */
@Test
public void testGetMaxHistoryConcurrent() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/statistics/get-max-history-concurrent";
    String channelId = "1965681";
    String startTime = "1609430400000";
    String endTime = "1616515200000";

    //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 system-wide global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":1
}

Error Example

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

Live Streaming Server API