Chỉ số chính theo loại chiến dịch — API Shopee AMS

v2.ams.get_campaign_key_metrics_performance

GET/api/v2/ams/get_campaign_key_metrics_performanceGọi qua 360: GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_campaign_key_metrics_performance

Mô tả API

So sánh Chiến dịch mở (Open Campaign) và Chiến dịch riêng (Targeted Campaign) trong một kỳ: số affiliate ra đơn, sản phẩm bán, doanh thu, hoa hồng ước tính của từng loại.

Tên khóa thật là open_campaign_key_metrics / targeted_campaign_key_metrics (đúng chính tả "metrics").
Không có order_type / channel: số liệu gộp mọi kênh.
Thương hiệu mẫu 30 ngày: chiến dịch riêng = 0 (không có chiến dịch riêng đang chạy).

Request

Địa chỉ

GET https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_campaign_key_metrics_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ó	Last30d	`Day` · `Week` · `Month` · `Last7d` · `Last30d` — quy tắc ngày như get_shop_performance.
start_date	query	string	Có	20260929	YYYYMMDD.
end_date	query	string	Có	20261028	YYYYMMDD.

Ví dụ request

curl -s "https://partner.quantri360.com/v1/shopee_ams/api/v2/ams/get_campaign_key_metrics_performance?period_type=Last30d&start_date=20260929&end_date=20261028" \
  -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_ams/api/v2/ams/get_campaign_key_metrics_performance",
    params={
        "period_type": "Last30d",
        "start_date": "20260929",
        "end_date": "20261028"
    },
    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_ams/api/v2/ams/get_campaign_key_metrics_performance');
for (const [k, v] of Object.entries({"period_type":"Last30d","start_date":"20260929","end_date":"20261028"})) 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_ams/api/v2/ams/get_campaign_key_metrics_performance' . '?' . http_build_query(['period_type' => 'Last30d', 'start_date' => '20260929', 'end_date' => '20261028']);
$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 AMS)

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
open_campaign_key_metrics	object		Chiến dịch mở.
affiliates	int	390	Số affiliate có đơn.
items_sold	int	805	Sản phẩm bán.
sales	string	1670000	Doanh thu (VND, chuỗi).
est_commission	string	2427247.6	Hoa hồng ước tính (VND, chuỗi).
targeted_campaign_key_metrics	object		Chiến dịch riêng — cùng cấu trúc.
affiliates	int		Số affiliate.
items_sold	int		Số sản phẩm bán.
sales	string		Doanh số.
est_commission	string		Hoa hồng ước tính.
fetched_date_range	string	20260929-20261028	Khoảng ngày thực tính.
open_campaign_key_metircs	object		Hiệu quả chiến dịch mở (giữ nguyên tên trường trả về).
affiliates	int64		Số affiliate tạo ra đơn hàng.
items_sold	int64		Số sản phẩm đã bán.
sales	string		Tổng giá trị đơn hàng.
est_commission	string		Tổng hoa hồng ước tính.
targeted_campaign_key_metircs	object		Hiệu quả chiến dịch riêng (giữ nguyên tên trường trả về).
affiliates	int64		Số affiliate tạo ra đơn hàng.
items_sold	int64		Số sản phẩm đã bán.
sales	string		Tổng giá trị đơn hàng.
est_commission	string		Tổng hoa hồng ước tính.

Mẫu phản hồi

{
  "error": "",
  "message": "",
  "request_id": "e3e3e7f35ef7a419…",
  "response": {
    "open_campaign_key_metrics": {
      "affiliates": 390,
      "items_sold": 805,
      "sales": "1670000",
      "est_commission": "2427247.6"
    },
    "targeted_campaign_key_metrics": {
      "affiliates": 0,
      "items_sold": 0,
      "sales": "0",
      "est_commission": "0"
    },
    "fetched_date_range": "20260929-20261028"
  }
}

Mã lỗi của Shopee AMS (7)

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_server	Lỗi hệ thống Shopee — thử lại sau ít phút.
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).
shop_banned	Gian hàng đang bị Shopee khóa — mọi API tạm ngưng tới khi gỡ khóa.
error_kyc_auth	Gian hàng chưa hoàn tất đăng ký người bán trên Kênh Người Bán.

Bắt đầu dùng

Đăng ký tài khoản Partner
Mở loại dữ liệu thuộc nhóm Affiliate ở trang nền tảng
Tạo API key (tick kênh Shopee AMS)
Gọi theo ví dụ ở trên