v2.ams.get_content_performance
GET /api/v2/ams/get_content_performance
Retrieve content performance of the shop
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ams/get_content_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. |
| page_no | int32 | True | 1 | Specifies the page number of data to return 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 maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum 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. 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 | ShopeeVideo | Channel. Applicable values: - ShopeeVideo - LiveStreaming |
| affiliate_id | int64 | False | 11146330000 | Search for the contents published by affiliates with the affiliate id entered. |
| item_id | int64 | False | 14016184405 | Search for the contents with the searched product included (precise search). |
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 | ||
| list | object[] | ||
| content_id | string | 2056471137109586 | Unique identifier of the content where the product is placed. |
| content_title | string | Have been buying from this brand since 2 years ago and still loving it | Title or name of the content (e.g., video, livestream) associated with the product. |
| post_time | int64 | 1753376400 | Livestream: The livestream start time. Video: The video post time. |
| affiliate_name | string | id0807.9 | Display name of the affiliate who posted the content, typically the Shopee name. |
| affiliate_username | string | interspaceindonesia | Login or Shopee account username associated with the affiliate. |
| products | int64 | 11 | Number of products associated with the content. |
| views | int32 | 114812 | The total viewed pv of the content of this shop within the selected time range |
| likes | int32 | 93 | The total number of likes for the content of this shop within the selected time range |
| comments | int32 | 45 | The total number of comments for the content of this shop within the selected time range |
| sales | string | 78445100 | The total sales of the content associated with the shop orders within the selected time range |
| orders | int64 | 78952 | The total number of orders associated with the shop for the content in the selected time range |
| items_sold | int64 | 27 | The total number of items sold associated with the shop for the content in the selected time range |
| channel | string | ShopeeVideo | Channel. Applicable values: - ShopeeVideo - LiveStreaming |
| total_count | int64 | 789 | This is to indicate the whole number of items. |
| 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. |