Query Channel Live Streaming Data

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

API Description

1、查询频道直播数据
2、接口支持https协议

API URL

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

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
Viewing data is updated every 10 minutes
Default query time range: from channel creation time to the current time. If the channel was created more than six months ago, only the last six months of data are queried

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See details on 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 stored on the client side for direct use. 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
channelId	true	String	Channel ID
startTime	false	Long	Query start time, 13-digit timestamp
endTime	false	Long	Query end time, 13-digit timestamp. The query time span cannot exceed 180 days

Example

http://api.polyv.net/live/v4/channel/statistics/live-data?appId=frlr1zazn3&sign=4D418459FA42A9F88475022E33945955&channelId=2272655&timestamp=1659056102639

Response Parameters

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 response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, should not be tied to business logic
error	Object	Error information when the 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 identify the specific error reason
desc	String	Error description, corresponding to error.code

data Parameter Description

Parameter	Type	Description
watchData	Object	Live streaming viewing statistics See watchData field description
realTimeData	Object	Live streaming real-time activity See realTimeData field description
provinceData	Array	Province-level viewing data summary See provinceData field description

watchData Parameter Description

Parameter	Type	Description
viewers	Integer	Number of unique viewers (based on param1, i.e., viewerId)
plays	Integer	Number of views
playDuration	Integer	Play duration, in minutes
averagePlayDuration	Integer	Average viewing duration per user, in minutes
pageView	Integer	Cumulative page views, independent of time range
likes	Integer	Cumulative channel likes, independent of time range

realTimeData Parameter Description

Parameter	Type	Description
maxConcurrent	Integer	Maximum concurrent online users
date	Long	Timestamp when the maximum concurrent users occurred, 13-digit millisecond timestamp

provinceData Parameter Description

Parameter	Type	Description
province	String	Province
viewers	Integer	Number of unique viewers
averagePlayDuration	Integer	Average viewing duration per province, in minutes

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 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 a unified wrapper 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 getLiveDataTest() 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/live-data";
    String channelId = "2272655";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    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": "68e5160da1484817bba9ec0b63310e95.60.16520919629800561",
    "data": {
        "watchData": {
            "plays": 36,
            "viewers": 15,
            "averagePlayDuration": 25,
            "playDuration": 0,
            "pageView": 9999,
            "likes": 2000
        },
        "realTimeData": {
            "maxConcurrent": 8,
            "date": 1656474424000
        },
        "provinceData": [
            {
                "viewers": 10,
                "averagePlayDuration": 30,
                "province": "湖南"
            },
            {
                "viewers": 5,
                "averagePlayDuration": 20,
                "province": "广东"
            }
        ]
    },
    "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