Query Channel Product Click Statistics

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

API Description

1、分页查询直播频道商品点击数据
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/product/click

Online API Call

Request Method

GET

API Constraints

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

Request Parameters

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 for signature generation is critical for communication data security. It 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 and obtain response data.` See Signature Generation Rules
channelId	true	String	Channel ID
sessionId	false	String	Session ID
startTime	false	Long	Start time, 13-digit millisecond timestamp
endTime	false	Long	End time, 13-digit millisecond timestamp
pageNumber	false	Integer	Current page number
pageSize	false	Integer	Data size per page, default 10, maximum 1000

Example

Response Parameters

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine 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. For debugging and troubleshooting only, should not be used in business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	See data Field Description

Error Parameters

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

data Parameters

Parameter	Type	Description
pageNumber	Integer	Current page number
pageSize	Integer	Data size per page
totalPages	Long	Total number of pages
totalItems	Long	Total number of items
contents	Array	Content of the current page See contents Field Description

contents Parameters

Parameter	Type	Description
channelId	String	Channel ID
sessionId	String	Session ID
productId	Long	Product ID
name	Integer	Product name
productType	String	Product type: normal (regular product), finance (financial product)
productClickNum	Integer	Total product clicks, sum of clicks across all channels
linkClickNum	Integer	Number of unique link clicks
pcClickNum	Integer	Number of PC web clicks
mobileClickNum	Integer	Number of mobile web clicks
wxMiniProgramClickNum	Integer	Number of WeChat Mini Program clicks
iosClickNum	Integer	Number of iOS app native clicks
androidClickNum	Integer	Number of Android app native clicks

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 code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included 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.

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "8f969a60-9976-43fe-b983-1efbf65003a3",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "channelId": "1965681",
                "sessionId": "102",
                "productId": "53080",
                "name": "测试添加金融产品1",
                "productType": "finance",
                "productClickNum": 15,
                "linkClickNum": 2,
                "pcClickNum": 3,
                "mobileClickNum": 3,
                "wxMiniProgramClickNum": 5,
                "iosClickNum": 1,
                "androidClickNum": 1
            }
        ]
    },
    "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