Queries livestream performance data for the specified principal within the selected time range — Shopee API

v2.principal.get_principal_livestream_performance

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s -X POST "https://partner.quantri360.com/v1/shopee/api/v2/principal/get_principal_livestream_performance" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"start_date":"2026-10-01","end_date":"2026-10-07","timezone":"GMT+7","granularity":"customize","region_list":[]}'

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.post(
    "https://partner.quantri360.com/v1/shopee/api/v2/principal/get_principal_livestream_performance",
    params={},
    json={
        "start_date": "2026-10-01",
        "end_date": "2026-10-07",
        "timezone": "GMT+7",
        "granularity": "customize",
        "region_list": []
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())

const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/shopee/api/v2/principal/get_principal_livestream_performance');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'POST',
  headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"start_date":"2026-10-01","end_date":"2026-10-07","timezone":"GMT+7","granularity":"customize","region_list":[]}),
});
console.log(r.status, await r.json());

<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/shopee/api/v2/principal/get_principal_livestream_performance' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"start_date":"2026-10-01","end_date":"2026-10-07","timezone":"GMT+7","granularity":"customize","region_list":[]}');
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by Shopee)

Mẫu thành công chỉ dùng số liệu minh họa; kiểm error/message trước khi đọc response. response.summary và response.details là mảng.

Response sample

{
  "request_id": "demo-request",
  "error": "",
  "message": "",
  "response": {
    "summary": [
      {
        "currency": "USD",
        "orders": 10,
        "buyers": 10,
        "likes": 10,
        "comments": 10,
        "sales_gross": 10,
        "units_sold": 10,
        "total_views": 10,
        "total_live_duration": 10,
        "unique_viewers": 10,
        "atc_units": 10,
        "total_livestreams": 10,
        "average_live_duration": 10,
        "average_views_duration": 10,
        "new_followers": 10,
        "new_buyers": 10,
        "existing_buyers": 10,
        "sales_net": 10,
        "conversion_rate": 0.1
      }
    ],
    "details": [
      {
        "region": "SG",
        "currency": "USD",
        "orders": 10,
        "buyers": 10,
        "likes": 10,
        "comments": 10,
        "sales_gross": 10,
        "units_sold": 10,
        "total_views": 10,
        "total_live_duration": 10,
        "unique_viewers": 10,
        "atc_units": 10,
        "total_livestreams": 10,
        "average_live_duration": 10,
        "average_views_duration": 10,
        "new_followers": 10,
        "new_buyers": 10,
        "existing_buyers": 10,
        "sales_net": 10,
        "conversion_rate": 0.1
      }
    ]
  }
}

Shopee error codes (5)

Get started

1. Sign up for Partner
2. Enable a data type of the Sản phẩm group on the platform page
3. Create an API key (tick the Shopee channel)
4. Call it as in the examples above