v2.ams.get_campaign_key_metrics_performance

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:11:04

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.ams.get_campaign_key_metrics_performance

Retrieve key metrics for Open and Targeted campaigns

§2 Overview

Overview

Field	Value
Module	AMS
API type	Shop
HTTP method	GET
Path	/api/v2/ams/get_campaign_key_metrics_performance
Production URL	https://partner.shopeemobile.com/api/v2/ams/get_campaign_key_metrics_performance
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/ams/get_campaign_key_metrics_performance
Permission	Affiliate Marketing Solution Management

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
period_type	string	Yes	Last30d	Period Type. Applicable values: Day Week Month Last7d Last30d; Note: The start date and end date must align with the Period Type.
start_date	string	Yes	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	Yes	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.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string	error_param	Indicate error type if hit error. Empty if no error happened.
message	string	Invalid period type	Indicate error details if hit error. Empty if no error happened.
request_id	string	b937c04e554847789cbf3fe33a0ad5f1	The identifier for an API request for error tracking.
response	object
response.open_campaign_key_metircs	object		Performance data of Open Campaign.
response.open_campaign_key_metircs.affiliates	int64	34	Total number of affiliates who drove orders from Open Campaigns.
response.open_campaign_key_metircs.items_sold	int64	44	Total number of items sold from Open Campaigns.
response.open_campaign_key_metircs.sales	string	3233454	Total value of orders from Open Campaigns.
response.open_campaign_key_metircs.est_commission	string	5675675	Total estimated commission for orders placed from Open Campaigns.
response.targeted_campaign_key_metircs	object		Performance data of Target Campaign.
response.targeted_campaign_key_metircs.affiliates	int64	34	Total number of affiliates who drove orders from Targeted Campaigns.
response.targeted_campaign_key_metircs.items_sold	int64	56	Total number of items sold from Targeted Campaigns.
response.targeted_campaign_key_metircs.sales	string	6767	Total value of orders from Targeted Campaigns.
response.targeted_campaign_key_metircs.est_commission	string	46775	Total estimated commission for orders placed from Targeted Campaigns.
response.fetched_date_range	string	20250801-20250831	Effective query date range. Invalid input ranges will be automatically shifted.

§5 Common parameters

Common parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
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

§6 Request samples

Request samples

§7 Java

Java

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();

§8 PHP

PHP

<?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;

§9 cURL

cURL

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'

§10 Python

Python

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)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"error": "",
	"message": "",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1",
	"response": {
		"open_campaign_key_metircs": {
			"affiliates": 34,
			"items_sold": 44,
			"sales": "3233454",
			"est_commission": "5675675"
		},
		"targeted_campaign_key_metircs": {
			"affiliates": 34,
			"items_sold": 56,
			"sales": "6767",
			"est_commission": "46775"
		},
		"fetched_date_range": "20250801-20250831"
	}
}

§13 Error example

Error example

§14 JSON

JSON

{
	"error": "error_param",
	"message": "Invalid period type",
	"request_id": "b937c04e554847789cbf3fe33a0ad5f1"
}

§15 Errors

Errors

Error	Description	Solution
error_param	invalid param
error_param	invalid period type
error_param	invalid time range, detail:{detail}
error_server	Something wrong. Please try later.

§16 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§17 Update log

Update log

Date	Change
2025-10-15	New API

这条内容对你有帮助吗？