v2.video.get_overview_performance
GET/api/v2/video/get_overview_performanceGọi qua 360: GET https://partner.quantri360.com/v1/shopee_video/api/v2/video/get_overview_performance
Mô tả API
Tổng quan hiệu quả TOÀN BỘ Shopee Video của gian hàng trong một kỳ: doanh thu / đơn / sản phẩm bán (đặt và xác nhận), lượt xem hiệu quả, người xem, thêm giỏ, tỷ lệ nhấp, tỷ lệ chuyển đổi, GPM, tương tác và người theo dõi mới. Dùng cho thẻ KPI kênh Video.
- Số liệu trễ ít nhất 1 ngày.
- Doanh thu "đặt" (placed) gồm cả đơn sau đó hủy / trả; báo cáo nên dùng "xác nhận" (confirmed).
- Trường thêm giỏ trong key_metric tên là
atc, trong conversion làtotal_atc. period_typeviết thường →error_param"periodType is Illegal".
Request
Địa chỉ
GET https://partner.quantri360.com/v1/shopee_video/api/v2/video/get_overview_performance
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ả |
|---|---|---|---|---|---|
| period_type | query | string | Có | Last7d | Kỳ — phân biệt hoa thường: Day · Week · Month · Last7d · Last15d · Last30d. |
| end_date | query | string | Có | 2026-10-28 | Ngày cuối kỳ dạng YYYY-MM-DD. |
Ví dụ request
curl -s "https://partner.quantri360.com/v1/shopee_video/api/v2/video/get_overview_performance?period_type=Last7d&end_date=2026-10-28" \ -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_video/api/v2/video/get_overview_performance",
params={
"period_type": "Last7d",
"end_date": "2026-10-28"
},
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_video/api/v2/video/get_overview_performance');
for (const [k, v] of Object.entries({"period_type":"Last7d","end_date":"2026-10-28"})) 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_video/api/v2/video/get_overview_performance' . '?' . http_build_query(['period_type' => 'Last7d', 'end_date' => '2026-10-28']); $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 Video)
Mẫu minh họa rút gọn; phản hồi đầy đủ có thêm conversion và engagement như bảng trên.
| 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 | ||
| key_metric | object | Chỉ số chính (VND với trường *_sales). | |
| placed_discovery_orders | int | Số đơn đã đặt từ khám phá. | |
| placed_discovery_sales | float | Doanh số đơn đã đặt từ khám phá. | |
| confirmed_discovery_orders | int | Số đơn đã xác nhận từ khám phá. | |
| confirmed_discovery_sales | float | Doanh số đơn đã xác nhận từ khám phá. | |
| placed_conversion_orders | int | Số đơn đã đặt từ chuyển đổi. | |
| placed_conversion_sales | float | Doanh số đơn đã đặt từ chuyển đổi. | |
| confirmed_conversion_orders | int | Số đơn đã xác nhận từ chuyển đổi. | |
| confirmed_conversion_sales | float | Doanh số đơn đã xác nhận từ chuyển đổi. | |
| sales_trends | string | Xu hướng doanh số trong kỳ. | |
| order_trends | string | Xu hướng số đơn trong kỳ. | |
| placed_sales | float | 1640000 | Doanh thu đặt từ mọi video. |
| placed_orders | int | 275 | Đơn đặt. |
| placed_item_sold | int | 281 | Sản phẩm đặt. |
| confirmed_sales | float | 1650000 | Doanh thu xác nhận. |
| confirmed_orders | int | 196 | Đơn xác nhận. |
| confirmed_item_sold | int | 200 | |
| atc | int | 1390 | Lượt thêm vào giỏ từ giỏ hàng trong video. |
| effective_views | int | 14885 | Lượt xem > 3 giây. |
| total_viewers | int | Người xem (không trùng). | |
| avg_view_duration | int | Thời gian xem trung bình, mili giây. | |
| placed_discovery_orders / placed_discovery_sales / placed_conversion_orders … | int | float | Tách đơn / doanh thu theo nguồn khám phá và chuyển đổi (đặt / xác nhận) — có thể null. | |
| conversion | object | ||
| placed_buyers | int | Người mua đặt (không trùng). | |
| confirmed_buyers | int | ||
| total_atc | int | Thêm giỏ. | |
| ctr | float | Lượt nhấp sản phẩm ÷ lượt xem (0–1). | |
| placed_co_rate | float | Đơn đặt ÷ lượt nhấp sản phẩm. | |
| confirmed_co_rate | float | ||
| placed_abs | float | Giá trị trung bình mỗi đơn đặt (VND). | |
| confirmed_abs | float | ||
| placed_gpm | float | Doanh thu đặt trên 1.000 lượt xem (VND). | |
| confirmed_gpm | float | ||
| video_with_products | int | Số video có gắn sản phẩm. | |
| placed_revenue_generating_videos | int | Số video ra doanh thu đặt. | |
| confirmed_revenue_generating_videos | int | ||
| engagement | object | ||
| total_views | int | Lượt xem. | |
| total_likes | int | ||
| total_shares | int | ||
| total_comments | int | ||
| video_new_followers | int | Người theo dõi mới từ video. | |
| fetched_date_range | string | 2026-10-23 | Ngày số liệu được tính. |
Mẫu phản hồi
{
"error": "",
"message": "",
"request_id": "demo-request",
"response": {
"key_metric": {
"placed_sales": 1640000,
"placed_orders": 275,
"placed_item_sold": 281,
"confirmed_sales": 1650000,
"confirmed_orders": 196,
"confirmed_item_sold": 200,
"atc": 1390,
"effective_views": 14885
},
"fetched_date_range": "2026-10-23"
}
}
Mã lỗi của Shopee Video (6)
Bấm để xem
| Mã | Ý nghĩa |
|---|---|
| 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_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 Video ở trang nền tảng
- Tạo API key (tick kênh Shopee Video)
- Gọi theo ví dụ ở trên