v2.ams.get_campaign_key_metrics_performance

GET /api/v2/ams/get_campaign_key_metrics_performance

Retrieve key metrics for Open and Chiến dịch mục tiêus

Đường dẫn Endpoint

URL: https://partner.shopeemobile.com/api/v2/ams/get_campaign_key_metrics_performance

Tham số chung

Tên	Kiểu	Mẫu	Mô tả
partner_id	int	1	Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu.
timestamp	timestamp	1610000000	Dùng để chỉ định thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	Token truy cập API, dùng để xác định quyền của bạn đối với API. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ.
shop_id	int	600000	Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Tham số Request

Tên	Kiểu	Bắt buộc	Mẫu	Mô tả
period_type	string	True	Last30d	Period Type. Các giá trị áp dụng: Day Week Month Last7d Last30d Note: The start date and end date must align with the Period Type.
start_date	string	True	20250801	The start_date must be: - Any day in the past three calendar months for "Day" period type - Sunday for "Week" period type - The 1st day of a Month for "Month" period type - The date that is 6 days prior to the latest data date for "Last7d" period type - The date that is 29 days prior to the latest data date for "Last30d" period type Note: The latest data date can be obtained by using "AmsMarker" in the v2.ams.get_performance_data_update_time API.
end_date	string	True	20250831	The end_date must be: - Equal to start_date for "Day" period type - Saturday for "Week" period type - The last day of a Month for "Month" period type. If the selected month is the current month, the end_date should be the latest data date - The latest data date for "Last7d" period type - The latest data date for "Last30d" period type Note: - The end_date must be later than the start_date and earlier than the latest data date - The latest data date can be obtained by using "AmsMarker" in the v2.ams.get_performance_data_update_time API.

Tham số Response

Tên	Kiểu	Mẫu	Mô tả
error	string	error_param	Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi.
message	string	Invalid period type	Chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi.
request_id	string	b937c04e554847789cbf3fe33a0ad5f1	Mã định danh của yêu cầu API dùng để theo dõi lỗi.
response	object
open_campaign_key_metircs	object		Dữ liệu hiệu suất of Open Campaign.
affiliates	int64	34	Tổng số affiliates who drove orders from Open Campaigns.
items_sold	int64	44	Tổng số items sold from Open Campaigns.
sales	string	3233454	Total value of orders from Open Campaigns.
est_commission	string	5675675	Total estimated commission for orders placed from Open Campaigns.
targeted_campaign_key_metircs	object		Dữ liệu hiệu suất of Target Campaign.
affiliates	int64	34	Tổng số affiliates who drove orders from Targeted Campaigns.
items_sold	int64	56	Tổng số items sold from Targeted Campaigns.
sales	string	6767	Total value of orders from Targeted Campaigns.
est_commission	string	46775	Total estimated commission for orders placed from Targeted Campaigns.
fetched_date_range	string	20250801-20250831	Effective query date range. Invalid input ranges will be automatically shifted.

Unirest.setTimeouts(0, 0); HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/ams/get\_campaign\_key\_metrics\_performance?access\_token=access\_token&end\_date=20250831&partner\_id=partner\_id&period\_type=Last30d&shop\_id=shop\_id&sign=sign&start\_date=20250801&timestamp=timestamp") .asString();<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/get\_campaign\_key\_metrics\_performance?access\_token=access\_token&end\_date=20250831&partner\_id=partner\_id&period\_type=Last30d&shop\_id=shop\_id&sign=sign&start\_date=20250801&timestamp=timestamp', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; curl --location --request GET 'https://partner.shopeemobile.com/api/v2/ams/get\_campaign\_key\_metrics\_performance?access\_token=access\_token&end\_date=20250831&partner\_id=partner\_id&period\_type=Last30d&shop\_id=shop\_id&sign=sign&start\_date=20250801&timestamp=timestamp' import requests url = "https://partner.shopeemobile.com/api/v2/ams/get\_campaign\_key\_metrics\_performance?access\_token=access\_token&end\_date=20250831&partner\_id=partner\_id&period\_type=Last30d&shop\_id=shop\_id&sign=sign&start\_date=20250801&timestamp=timestamp" payload={} headers = { } response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False) print(response.text)

, "targeted_campaign_key_metircs": { "affiliates": 34, "items_sold": 56, "sales": "6767", "est_commission": "46775" }, "fetched_date_range": "20250801-20250831" } }