v2.ams.get_affiliate_performance
GET /api/v2/ams/get_affiliate_performance
Retrieve affiliate performance of the shop.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/ams/get_affiliate_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. |
| page_no | int32 | True | 1 | Chỉ định số trang dữ liệu cần trả về in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call. |
| page_size | int32 | True | 20 | Each result set is returned as a page of entries. Use the "page_size" filters to control the tối đa number of entries to retrieve per page (i.e., per call). This integer value is used to specify the tối đa number of entries to return in a single "page" of data. The limit of page_size if between 1 and 20. |
| order_type | string | True | ConfirmedOrder | Order Type. Các giá trị áp dụng: 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. Các giá trị áp dụng: - AllChannel - SocialMedia - ShopeeVideo - LiveStreaming |
| affiliate_id | int64 | False | 16142330000 | ID đơn vị liên kết for query. |
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 | ||
| list | object[] | ||
| affiliate_id | int64 | 11146330000 | Mã định danh duy nhất assigned to the affiliate. Used as a reference key in the system. |
| affiliate_name | string | id0807.9 | Display name of the affiliate, typically the Shopee display name. |
| affiliate_username | string | interspaceindonesia | Login or Shopee account username associated with the affiliate. |
| sales | string | 47190 | Total value of the product sold through the affiliate's promotion. |
| items_sold | int64 | 365 | Tổng số the product sold through the affiliate's promotion. |
| orders | int64 | 269 | Tổng số orders generated through the affiliate's promotion. |
| clicks | int64 | 3372 | Tổng số clicks on your product links through affiliate marketing during the selected period. |
| est_commission | string | 947253 | Estimated payout through the affiliate's promotion. |
| roi | string | 46.8 | Return on Investment, equal to GMV divided by Estimated Commission. It can be used to evaluate the efficiency of the affiliate's promotion. If it does not exist, the return value is --. |
| total_buyers | int64 | 589 | Tổng số buyers who have purchased the product through the affiliate's promotion. |
| new_buyers | int64 | 260 | Tổng số new buyers who have purchased the product through the affiliate's promotion. |
| total_count | int64 | 589 | Tổng số affiliates that match the tình trạng. |
| has_more | boolean | true | This is to indicate whether the list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of datas. |
| 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\_affiliate\_performance?access\_token=access\_token&affiliate\_id=16142330000&channel=AllChannel&end\_date=20250831&order\_type=ConfirmedOrder&page\_no=1&page\_size=20&partner\_id=partner\_id&period\_type=Last30d&shop\_id=shop\_id&sign=sign&start\_date=20250801×tamp=timestamp") .asString();<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/get\_affiliate\_performance?access\_token=access\_token&affiliate\_id=16142330000&channel=AllChannel&end\_date=20250831&order\_type=ConfirmedOrder&page\_no=1&page\_size=20&partner\_id=partner\_id&period\_type=Last30d&shop\_id=shop\_id&sign=sign&start\_date=20250801×tamp=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\_affiliate\_performance?access\_token=access\_token&affiliate\_id=16142330000&channel=AllChannel&end\_date=20250831&order\_type=ConfirmedOrder&page\_no=1&page\_size=20&partner\_id=partner\_id&period\_type=Last30d&shop\_id=shop\_id&sign=sign&start\_date=20250801×tamp=timestamp' import requests url = "https://partner.shopeemobile.com/api/v2/ams/get\_affiliate\_performance?access\_token=access\_token&affiliate\_id=16142330000&channel=AllChannel&end\_date=20250831&order\_type=ConfirmedOrder&page\_no=1&page\_size=20&partner\_id=partner\_id&period\_type=Last30d&shop\_id=shop\_id&sign=sign&start\_date=20250801×tamp=timestamp" payload={} headers = { } response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False) print(response.text)
], "total_count": 589, "has_more": true, "fetched_date_range": "20250801-20250831" } }