Get Channel Product Statistics Overview

Updated: 2026-07-13 11:28:48

API Description

1、查询频道商品整体统计数据概览（点击、下单、成交等指标汇总）
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/product/stats/summary

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
Incorrect parameters will result in a 400 error response.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	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 not 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 signature generation rules
channelId	true	Integer	Channel ID
sessionId	false	String	Session ID

Example

http://api.polyv.net/live/v4/channel/product/stats/summary?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=2974342

Response Description

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 business logic. 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, not tied to business logic
error	Object	Error information when status code is not 200 See Error response description
data	Object	Product statistics overview data See data response description
encryption	Boolean	Whether the data is encrypted

Error Response Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error reason
desc	String	Error description, corresponding to error.code

data Response Description

Parameter	Type	Description
payPageNum	Integer	Number of checkout button clicks
payPageViewers	Integer	Number of users who clicked the checkout button
payViewers	Integer	Number of users who completed a purchase
productClickNum	Integer	Number of product clicks
productClickViewers	Integer	Number of users who clicked on products
saleQuantity	Integer	Product sales volume
totalPayAmount	Number	Total transaction amount (in yuan)

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 encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询频道商品统计概览
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChannelProductStatsSummary() 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/product/stats/summary";
    String channelId = "2779045";
    
    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": "f46e79d6c5a94dcc9a40de76a8ffa777.74.17306917836670585",
  "data": {
    "payPageNum": 0,
    "payPageViewers": 0,
    "payViewers": 0,
    "productClickNum": 0,
    "productClickViewers": 0,
    "saleQuantity": 0,
    "totalPayAmount": 0
  },
  "encryption": true,
  "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