v2.ams.get_campaign_key_metrics_performance
GET /api/v2/ams/get_campaign_key_metrics_performance
Retrieve key metrics for Open and Targeted campaigns
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ams/get_campaign_key_metrics_performance
Common Request 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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| period_type | string | True | 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 | 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. |
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 | ||
| open_campaign_key_metircs | object | Performance data of Open Campaign. | |
| affiliates | int64 | 34 | Total number of affiliates who drove orders from Open Campaigns. |
| items_sold | int64 | 44 | Total number of 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 | Performance data of Target Campaign. | |
| affiliates | int64 | 34 | Total number of affiliates who drove orders from Targeted Campaigns. |
| items_sold | int64 | 56 | Total number of 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. |