v2.livestream.get_session_metric
GET/api/v2/livestream/get_session_metricGọi qua 360: GET https://partner.quantri360.com/v1/shopee_live/api/v2/livestream/get_session_metric
Mô tả API
Lấy chỉ số phòng live theo thời gian thực: doanh số, người xem, thích, bình luận và chia sẻ.
- Gọi qua /v1/shopee_live/api/v2/livestream/get_session_metric với Authorization: Bearer <key>. 360 tự gắn token và chữ ký.
- API chỉ đọc; error rỗng mới là thành công. HTTP 200 vẫn có thể chứa lỗi nghiệp vụ trong error/message.
- Áp dụng TW, ID, TH, PH, MY, SG, VN.
- session_id lấy từ create_session. Luồng phiên live: create_session → start_session → end_session.
- Phiên phải đang live; phiên chưa phát hoặc đã kết thúc bị từ chối.
Request
Địa chỉ
GET https://partner.quantri360.com/v1/shopee_live/api/v2/livestream/get_session_metric
Xác thực & gian hàng
| Tên | Vị trí | Kiểu | Mẫu | Mô tả |
|---|---|---|---|---|
| Authorization | header | header | Bearer q360_live_ab12cd34_… | Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand. |
| platform_shop_id | query | string | 100001 | Gian hàng (lấy ở GET /v1/platforms → shops[].platform_shop_id). BẮT BUỘC khi brand có > 1 gian hàng trên nền tảng; 360 bỏ tham số này trước khi chuyển tiếp. |
Tham số request
| Tên | Vị trí | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|---|
| session_id | query | int64 | Có | 900001 | Mã phiên live lấy từ create_session; phiên phải tồn tại và thuộc tài khoản đang gọi. |
Ví dụ request
curl -s "https://partner.quantri360.com/v1/shopee_live/api/v2/livestream/get_session_metric?session_id=900001" \ -H "Authorization: Bearer $KEY"
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.get(
"https://partner.quantri360.com/v1/shopee_live/api/v2/livestream/get_session_metric",
params={
"session_id": 900001
},
headers={"Authorization": f"Bearer {KEY}"},
timeout=60,
)
print(r.status_code)
print(r.json())Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/shopee_live/api/v2/livestream/get_session_metric');
for (const [k, v] of Object.entries({"session_id":900001})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
method: 'GET',
headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());PHP
<?php $key = 'q360_live_...'; // khóa API của brand $url = 'https://partner.quantri360.com/v1/shopee_live/api/v2/livestream/get_session_metric' . '?' . http_build_query(['session_id' => 900001]); $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]); $res = curl_exec($ch); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); echo $status, "\n", $res;
Response
Tham số phản hồi (nguyên của Shopee Live)
Mẫu thành công dùng dữ liệu minh họa; kiểm error và message trước khi đọc response.
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| request_id | string | d52ca43b277a4f9292fb8be658bfd33d | Mã request của Shopee để tra lỗi. |
| error | string | Mã lỗi Shopee; rỗng = thành công. | |
| message | string | Mô tả lỗi. | |
| response | object | Kết quả nghiệp vụ. | |
| gmv | float | 10 | Giá trị đơn đặt trong phiên, gồm đã và chưa thanh toán, kể cả đơn hủy. |
| atc | int64 | 10 | Số lượt nhấn thêm vào giỏ cho các sản phẩm trong túi cam khi live. |
| ctr | float | 10 | Số lượt nhấp sản phẩm chia cho lượt xem live. |
| co | float | 10 | Số đơn sản phẩm từ phiên chia cho lượt nhấp sản phẩm. |
| orders | int64 | 10 | Số đơn đặt trong phiên, gồm đã và chưa thanh toán, kể cả đơn hủy. |
| ccu | int64 | 10 | Số người xem đồng thời trong phiên. |
| engage_ccu_1m | int64 | 10 | Số người xem đồng thời đã xem hơn một phút. |
| peak_ccu | int64 | 10 | Số người xem đồng thời cao nhất. |
| likes | int64 | 10 | Số lượt nhấn thích trong phiên. |
| comments | int64 | 10 | Số bình luận trong phiên. |
| shares | int64 | 10 | Số lượt chia sẻ phiên. |
| views | int64 | 10 | Số lượt xem phiên. |
| avg_viewing_duration | int64 | 10 | Thời lượng xem trung bình của người xem. |
Mẫu phản hồi
{
"error": "",
"message": "",
"request_id": "demo-request",
"response": {
"gmv": 10,
"atc": 10,
"ctr": 10,
"co": 10,
"orders": 10,
"ccu": 10,
"engage_ccu_1m": 10,
"peak_ccu": 10,
"likes": 10,
"comments": 10,
"shares": 10,
"views": 10,
"avg_viewing_duration": 10
}
}
Mã lỗi của Shopee Live (8)
Bấm để xem
| Mã | Ý nghĩa |
|---|---|
| error_data | Dữ liệu không tồn tại hoặc không hợp lệ cho thao tác (vd mã không có, loại yêu cầu không cho phép). |
| error_param | Tham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào. |
| error_auth | Ủy quyền gian hàng cho 360 đã hết hạn hoặc bị thu hồi (360 đã tự làm mới token một lần) — chủ gian hàng kết nối lại Shopee trong Partner. |
| error_server | Lỗi hệ thống Shopee — thử lại sau ít phút. |
| error_limit | Chạm hạn mức gọi Shopee trong ngày của kết nối — 360 trả kèm thời điểm thử lại; giảm tần suất gọi. |
| error_rate_limit | Gọi quá nhanh — chờ vài giây rồi gọi lại (360 cũng giới hạn theo key: 429 + Retry-After). |
| user_no_linked | Tài khoản chưa liên kết với 360 — kết nối lại trong Partner. |
| user_banned | Tài khoản đang bị Shopee khóa, mọi API tạm ngưng tới khi gỡ khóa. |
Bắt đầu dùng
- Đăng ký tài khoản Partner
- Mở loại dữ liệu thuộc nhóm Livestream ở trang nền tảng
- Tạo API key (tick kênh Shopee Live)
- Gọi theo ví dụ ở trên