Query Live Session Summary Data List
Updated: 2024-12-03 09:22:48
API Description
1、<p>查询直播场次汇总数据列表</p>
2、接口支持https协议
API URL
http://api.polyv.net/live/v4/statistics/session-stats/summary/list
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate limits. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See details on obtaining keys |
| 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 stored 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 for response data. See signature generation rules |
| timestamp | true | String | Current 13-digit millisecond timestamp, valid for 3 minutes |
| channelId | false | String | Channel ID |
| keyword | false | String | Session name or session ID (fuzzy match) |
| endTime | false | String | End time timestamp |
| pageNumber | false | String | Current page number |
| pageSize | false | String | Page size |
| startTime | false | String | Start time timestamp |
Example
http://api.polyv.net/live/v4/statistics/session-stats/summary/list?pageNumber=1&appId=frlr1zazn3&sign=76AEC105CAD0C5091FCECCF14FC6DA74&pageSize=10&channelId=1965681×tamp=1699580616354
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Status code, same as HTTP status code, used to determine the basic response status |
| data | Object | See Data parameter description |
| error | Object | Error information when status code is not 200 See Error parameter description |
| requestId | String | Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, should not be tied to business logic |
| status | String | Response result, determined by business logic. Returns "success" on success, "error" on failure |
| success | Boolean | Whether the response was successful |
Data Parameter Description
| Parameter | Type | Description |
|---|---|---|
| contents | Array | Paginated data collection See Contents parameter description |
| pageNumber | Integer | Current page number |
| pageSize | Integer | Page size |
| totalItems | Integer | Total number of records |
| totalPages | Integer | Total number of pages |
Contents Parameter Description
| Parameter | Type | Description |
|---|---|---|
| id | Integer | ID |
| channelId | Integer | Channel ID |
| sessionId | String | Session ID |
| name | String | Session name |
| attendanceActual | Integer | Actual attendance count |
| attendanceExpected | Integer | Registered/whitelist count |
| attendanceType | Integer | Attendance count type: 0 No data, 1 Registered viewing, 2 Whitelist viewing |
| averagePlayDuration | Integer | Average viewing duration in minutes |
| endTime | String | Live broadcast end time |
| maxConcurrencyCount | Integer | Maximum concurrent viewers |
| mobileUniqueViewer | Integer | Mobile viewers count |
| pcUniqueViewer | Integer | PC viewers count |
| playCount | Integer | Replay play count |
| playDuration | Integer | Replay play duration in minutes |
| startDuration | Integer | Broadcast duration in seconds |
| startTime | String | Live broadcast start time |
| totalPlayDuration | Integer | Total live viewing duration in minutes |
| uniqueViewer | Integer | Unique viewers count |
| userId | String | POLYV user ID, consistent with the Polyv official website. Retrieval path: Official website -> Login -> Live (Development Settings) |
| videoView | Integer | View count |
| viewerCount | Integer | Replay viewers count |
Error Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to identify the specific error cause |
| desc | String | Error description, corresponding to error.code |
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. HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.
It is strongly recommended to use the Live Java SDK for API functionality integration. The Live Java SDK provides a unified encapsulation 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 summaryListTest() 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/statistics/session-stats/summary/list";
String channelId="1965681";
String endTime="";
String pageNumber="1";
String pageSize="10";
String startTime="";
//http 调用逻辑
Map<String, String> requestMap=new HashMap<>();
requestMap.put("appId",appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
// requestMap.put("endTime", endTime);
requestMap.put("pageNumber",pageNumber);
requestMap.put("pageSize",pageSize);
// requestMap.put("startTime", startTime);
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": "3a05f8f5f6984232808d9e099f9ee938.3338.16995806199894399",
"data": {
"pageNumber": 1,
"pageSize": 1,
"totalPages": 9,
"totalItems": 9,
"contents": [
{
"channelId": 1965681,
"sessionId": "ggxjxhcvg9",
"name": "直播测试-页面信息设置",
"startTime": 1672726467000,
"endTime": 1686810675000,
"playDuration": 0,
"playCount": 0,
"viewerCount": 0,
"maxConcurrencyCount": 0,
"startDuration": 14084208,
"uniqueViewer": 0,
"videoView": 0,
"pcUniqueViewer": 0,
"mobileUniqueViewer": 0,
"totalPlayDuration": 0,
"averagePlayDuration": 0,
"attendanceType": 0,
"attendanceExpected": 0,
"attendanceActual": 0,
"userId": "1b448be323"
}
]
},
"success": true
}
Error Example
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
