Query Viewing History

Updated: 2025-09-17 09:49:01

API Description

1、查询观看记录

2、接口支持https协议

3、直播观看详情数据支持查询最近3年内的历史数据，建议将历史数据导出到本地储存，以便后续查询。

4、日期不传查当月数据

API URL

http://api.polyv.net/live/v4/user/viewlog/list

Online API Call

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: Get Secret Key
timestamp	true	String	Current 13-digit millisecond timestamp, valid within 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 stored or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See details: Signature Generation Rules
startDate	false	String	Start date. Format: yyyy-MM-dd
endDate	false	String	End date, must be in the same month as the start date. Format: yyyy-MM-dd
pageNumber	false	String	Current page number
pageSize	false	String	Page size
viewerId	false	String	Viewer ID
channelId	false	Integer	Channel ID

Example

http://api.polyv.net/live/v4/user/viewlog/list?pageNumber=1&viewerId=123456&endDate=2023-08-30&appId=frlr1zazn3&sign=D68D18B56C800A7BF56597855336BA75&pageSize=10&startDate=2023-08-01&timestamp=1691130500787

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 details: Data Parameter Description
error	Object	Error information when status code is not 200 See details: Error Parameter Description
requestId	String	Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, not for 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 details: 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
avgDuration	String	Average viewing duration
nick	String	Nickname
totalDuration	String	Total viewing duration
viewCount	Integer	Number of views
viewerId	String	User ID
param4	String	Custom parameter param4
param5	String	Custom parameter param5

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 the basic code, please 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, both contained in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live 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(getClass());
/**
 * 查询观看记录
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void viewlogListTest() 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/user/viewlog/list";
    String viewerId = "123456";
    Integer channelId = 5004544;
    String startDate = "2023-08-01";
    String endDate = "2023-08-30";
    String pageNumber = "1";
    String pageSize = "10";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("endDate", endDate);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    requestMap.put("startDate", startDate);
    requestMap.put("viewerId", viewerId);
    requestMap.put("channelId", channelId);
    
    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": "0b908277c2b44d719d158edcd05e98a3.2379.16911305029825653",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "viewerId": "123456",
                "nick": "1122",
                "viewCount": 4,
                "totalDuration": "00:02:37",
                "avgDuration": "00:00:39"
            }
        ]
    },
    "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