v2.ads.get_gms_campaign_performance
POST /api/v2/ads/get_gms_campaign_performance
Get GMS Campaign performance
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/get_gms_campaign_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 |
|---|---|---|---|---|
| campaign_id | int64 | False | 13251251 | The GMS Campaign ID. Provide if available. |
| start_date | string | True | 11-11-2025 | Start date of Campaign e.g. "11-11-2025". Maximum duration of 3 months between start_date & end_date. Earliest start_date is 6 months before today. |
| end_date | string | True | 11-11-2025 | End date of Campaign e.g. "11-11-2025". Maximum duration of 3 months between start_date & end_date. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| warning | string | Indicate warning details if hit warning. Empty if no warning happened. | |
| request_id | string | The identifier for an API request for error tracking. | |
| response | object | ||
| campaign_id | int64 | 12412421 | GMS Campaign ID |
| report | object | ||
| broad_cir | float | 100.12 | The direct advertising cost of sales, or direct ACOS, measures how much your ad costs relative to the revenue generated from sales of the advertised product. It is the amount spent on the ad divided by the amount of sales revenue for the advertised product that is attributed to the ad. Direct ACOS = expense ÷ direct GMV × 100%. |
| broad_gmv | float | 100.12 | The amount of sales revenue generated from shoppers purchasing products within 7 days of them clicking on your ad. |
| broad_order | int64 | 123 | The number of times shoppers purchased any product from your shop within 7 days of them clicking on your ad. |
| broad_order_amount | int64 | 123 | The total quantity of products purchased by shoppers within 7 days of them clicking on your ad. |
| broad_roi | float | 123.12 | Return on ad spend (ROAS) measures how much revenue is generated by your ad relative to the cost of the ad. It is the amount of sales revenue attributed to your ad divided by the amount spent on the ad. ROAS = GMV ÷ expense. (Note: We recommend monitoring ROAS trends on a weekly basis.) |
| clicks | int64 | 123 | The number of times shoppers click on your ad. (Note: Shopee filters out repeated clicks from the same shopper that occur within a short time frame.) |
| expense | float | 123.12 | The amount spent on your ad. |
| cpc | float | 123.12 | The cost per conversion is how much each conversion costs, on average. It is the amount spent on your ad divided by the number of conversions attributed to the ad. Cost per conversion = expense ÷ conversions. |
| cpdc | float | 123.12 | The cost per direct conversion is how much each direct conversion costs, on average. It is the amount spent on your ad divided by the number of direct conversions attributed to the ad. Cost per direct conversion = expense ÷ direct conversions. |
| cr | float | 123.12 | The conversion rate measures how often shoppers end up purchasing something from your shop after clicking on your ad. It is the number of conversions attributed to your ad divided by the number of clicks on the ad. Conversion rate = conversions ÷ clicks × 100%. |
| direct_cr | float | 123.12 | The direct conversion rate measures how often shoppers end up purchasing the advertised product after clicking on the ad. Direct conversion rate is the number of direct conversions divided by the number of clicks. Direct conversion rate = direct conversions ÷ clicks × 100%. |
| direct_cir | float | 123.12 | The direct advertising cost of sales, or direct ACOS, measures how much your ad costs relative to the revenue generated from sales of the advertised product. It is the amount spent on the ad divided by the amount of sales revenue for the advertised product that is attributed to the ad. Direct ACOS = expense ÷ direct GMV × 100%. |
| direct_order | int64 | 123 | The number of times shoppers purchased the advertised product within 7 days of them clicking on the ad. |
| direct_order_amount | int64 | 123 | The total quantity of the advertised product purchased by shoppers within 7 days of them clicking on the ad. |
| direct_roi | float | 123.12 | The direct return on ad spend, or direct ROAS, measures how much revenue is generated from sales of the advertised product, relative to the cost of the ad. It is the amount of sales revenue for the advertised product attributed to the ad, divided by the amount spent on the ad. Direct ROAS = direct GMV ÷ expense. |
| impression | float | 123.12 | The number of times shoppers see your ad. |