保利威文档中心

幫助中心

取得頻道商品統計概覽

更新時間:2026-07-13 11:28:48

介面說明

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

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、若參數不正確則會回應400異常

請求參數說明

參數名 必填 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
channelId true Integer 頻道號
sessionId false String 場次ID

範例

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

回應說明

參數名 類型 說明
code Integer 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態
status String 回應結果,由業務決定,成功回傳success,失敗回傳error
success Boolean 是否成功回應
requestId String 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應該和業務掛鉤
error Object 狀態碼非200時的錯誤資訊【詳見Error回應說明
data Object 商品統計概覽資料【詳見data回應說明
encryption Boolean 資料是否加密

Error回應說明

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與 error.code 對應

data回應說明

參數名 類型 說明
payPageNum Integer 下單按鈕點擊次數
payPageViewers Integer 下單按鈕點擊人數
payViewers Integer 成交人數
productClickNum Integer 商品點擊次數
productClickViewers Integer 商品點擊人數
saleQuantity Integer 商品銷量
totalPayAmount Number 成交金額(單位:元)

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的 HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

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
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
  "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
}

異常範例

{
  "code": 400,
  "status": "error",
  "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
  "error": {
    "code": 20001,
    "desc": "application not found."
  },
  "success": false
}
联系客服,在线咨询