v2.ams.get_shop_performance
GET /api/v2/ams/get_shop_performance
Retrieve overall key metrics for all channels or specific channels.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ams/get_shop_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. |
| order_type | string | True | ConfirmedOrder | Order Type. Applicable values: PlacedOrder ConfirmedOrder: Note: - Placed orders are orders (COD and non-COD) that buyers have successfully placed, including paid and unpaid orders. - Confirmed orders are either non-COD orders that have been paid for or COD orders that have been confirmed for shipping (usually 30 mins after placing the order). |
| channel | string | True | AllChannel | Channel. Applicable values: - AllChannel - SocialMedia - ShopeeVideo - LiveStreaming |
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 | ||
| sales | string | 15000 | Total value of orders generated through affiliate marketing during the selected period. |
| gross_item_sold | int64 | 9684221 | Total number of items sold through affiliate marketing during the selected period. |
| orders | int64 | 68 | Total number of orders generated through affiliate marketing during the selected period. |
| clicks | int64 | 1564852 | Total clicks on your product links through affiliate marketing during the selected period. |
| est_commission | string | 2000 | Estimated total payout from your affiliate marketing orders. |
| roi | string | 18.8 | Return on Investment, equal to Sales divided by Est. Commission. It can be used to evaluate the efficiency of your investment in affiliate marketing. If it does not exist, the return value is --. |
| total_buyers | int64 | 894 | Total number of buyers who order from your shop through affiliate marketing. |
| new_buyers | int64 | 260 | Total number of new buyers who order from your shop through affiliate marketing. |
| fetched_date_range | string | 20250801-20250831 | Effective query date range. Invalid input ranges will be automatically shifted. |