Polyv Help Center

Help Center

Export Channel Session Report (Chart)

Updated: 2024-07-05 11:35:08

API Description

1、导出频道场次报表(图表)
3、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/session/stats/export

Request Method

GET

API Constraints

  1. The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency limits. See details

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 information for communication data security. It must not 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 to obtain response data. See Signature Generation Rules
channelId true String Live channel ID
sessionId true String Live session ID

Example

http://api.polyv.net/live/v3/channel/session/stats/export?appId=fso8gzbxlr&timestamp=1636421147000&channelId=2659445&sessionId=sisssssdfd&sign=56933052D433EB34E9BA0F9DA5197728

Response Parameter Description

Parameter Type Description
code Integer Response status code, 200 for success, non-200 for failure See Global Error Description
status String Response status text
message String Response description, provides error details when code is 400 or 500
data String Download URL for the live session report (URL is valid for 60 days, re-call the API to generate a new one after expiration)

Java Request Example

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 导出频道场次报表(画图表)
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testExportChannelSessionIdStats() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/session/stats/export";
    String channelId="2149710";
    String sessionId= "test";
 
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sessionId", sessionId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("导出直播场次报表,返回值:{}", response);
    //do somethings
    
}

Response Example

For system global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "https://liveimages.videocc.net/xx/xxx/xx.xlsx"
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "Report is not ready yet, please try again later.",
    "data": ""
}
联系客服,在线咨询