Paginated Query of Channel Product Statistics List

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

API Description

1、分页查询频道商品统计列表
2、接口支持https协议

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have a frequency limit. 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 for generating the signature is critical for communication data security and must never be saved 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
channelId	true	Integer	Channel ID
pageNumber	false	Integer	Page number for pagination
pageSize	false	Integer	Page size (maximum 300)
productId	false	String	Channel product ID
productName	false	String	Channel product name
sessionId	false	String	Session ID

Example

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

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 related to business logic
error	Object	Error information when the status code is not 200 See Error field description
data	Object	Detailed response information See data field description

Error Response Description

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

data Response Description

Parameter	Type	Description
pageNumber	String	Page number
pageSize	Integer	Page size
totalPages	String	Total number of pages
totalItems	String	Total number of records
contents	Array	Statistical list information [See contents response description]

contents Response Description

Parameter	Type	Description
productId	Long	Product ID
productName	String	Product name
productCover	String	Product cover image URL
productClickNum	Integer	Number of product clicks
productClickViewers	Integer	Number of unique users who clicked the product
payPageNum	Integer	Number of checkout button clicks
payPageViewers	Integer	Number of unique users who clicked the checkout button
payViewers	Integer	Number of unique users who completed a purchase
saleQuantity	Integer	Product sales volume
totalPayAmount	BigDecimal	Total transaction amount
productExplainNum	Integer	Number of product explanations

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 分页查询频道商品统计列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChannelProductStatsPage() 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/page";
    String channelId = "2779045";
    String pageNumber = "1";
    String pageSize = "10";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    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": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 3,
    "contents": [
      {
        "productId": 341043,
        "productName": "333",
        "productCover": "//liveimages.videocc.net/uploaded/images/2024/10/h0pzj7tjz5.png",
        "productClickNum": 0,
        "productClickViewers": 0,
        "payPageNum": 0,
        "payPageViewers": 0,
        "payViewers": 0,
        "saleQuantity": 0,
        "totalPayAmount": 0
      },
      {
        "productId": 341039,
        "productName": "222",
        "productCover": "//liveimages.videocc.net/uploaded/images/2024/10/h0pzjoo4ju.jpg",
        "productClickNum": 0,
        "productClickViewers": 0,
        "payPageNum": 0,
        "payPageViewers": 0,
        "payViewers": 0,
        "saleQuantity": 0,
        "totalPayAmount": 0
      },
      {
        "productId": 341036,
        "productName": "1111",
        "productCover": "//liveimages.videocc.net/uploaded/images/2024/10/h0pylp4mkb.png",
        "productClickNum": 0,
        "productClickViewers": 0,
        "payPageNum": 0,
        "payPageViewers": 0,
        "payViewers": 0,
        "saleQuantity": 0,
        "totalPayAmount": 0
      }
    ]
  },
  "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}