Get Shop Product Performance List

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 · 2026-09-06 12:35:26

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: TikTok Shop / profile.tiktok.docs_api
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§1 Path: /analytics/202605/shop_products/performance

§2 Method: [GET]

§3 Function Description

Returns a list of product performance overview metrics.

§4 Common Parameters

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Properties	Location	Type	Require	Sample	Properties description
shop_cipher	query	string	Y	GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3	Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response.
Get by API Get Authorization Shop
content-type	header	string	Y	application/json	Allowed type: application/json

§5 Request Query Parameters

Properties	Type	Require	Sample	Properties description
app_key	string	Y	38abcd	Every single app will have a unique key. Please use the specific key assigned to your app.
sign	string	Y	5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp	int	Y	1623812664	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
start_date_ge	string	Y	2024-04-01	Start date (ISO 8601 YYYY-MM-DD format) in shop registered timezone.
In the parameter name, "ge" refers to "greater than or equal to" (inclusive)
end_date_lt	string	Y	2024-04-08	End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone.
In the parameter name, "lt" refers to "less than" (exclusive)
page_size	int	N	10	Number of products per page.
Max value: 100
Default value: 10
page_token	string	N	cGFnZV9udW1iZXI9MQ==	Page token, indicating the current position. Used for requesting next page data.
Leave this field empty for first time queries.
sort_field	string	N	gmv	Field to sort on.
Default: gmv
Available values:

gmv
items_sold
orders | sort_order |string |N |DESC |Sort direction. Available values: ASC, DESC Default value: DESC
ASC: ascending
DESC: descending | currency |string |N |LOCAL |Currency. Available values: USD, LOCAL Default value: LOCAL
USD: US dollars
LOCAL: local currency where the shop is located | category_filter |[]string |N |123123,321412 |Category ID array used to filter the returned shop product performance list. | product_status_filter |string |N |LIVE |Product status filter.

Available values:

LIVE: live products
INACTIVE: inactive products
ALL: all product statuses; this is the default |

§6 Request Sample

Query

https://open-api.tiktokglobalshop.com/analytics/202605/shop_products/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&start_date_ge=2024-04-01&end_date_lt=2024-04-08&page_size=10&page_token=cGFnZV9udW1iZXI9MQ==&sort_field=gmv&sort_order=DESC&currency=LOCAL&category_filter=123123,321412&product_status_filter=LIVE

§7 Response Parameters

Properties	Type	Sample	Properties description
code	int	0	The success or failure status code returned in API response.
message	string	Success	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	202203070749000101890810281E8C70B7	Request log
data	object		Specific return information
^products	[]object		List of product performance metrics.
^^id	string	1732333333333333629	Product ID.
^^total_performance	object		Product total sales performance.
^^^gmv	object		Gross merchandise value.
^^^^amount	string	395.03	GMV amount.
^^^^currency	string	GBP	GMV currency code.
^^^orders	int	12	Number of orders.
^^^sku_orders	int	12	Number of SKU orders.
^^^items_sold	int	12	Number of items sold.
^^^estimated_customers	int	10	Estimated number of customers.
^^^aov	object		Average order SKU value.
^^^^amount	string	32.92	AOV amount.
^^^^currency	string	GBP	AOV currency code.
^^^product_impressions	int	5420	Number of product impressions.
^^^product_clicks	int	438	Number of product clicks.
^^^ctr	string	0.0808	Click-through rate.
^^^add_cart_count	int	57	Number of times products were added to the cart.
^^^add_cart_rate	string	0.1301	Add to cart rate.
^^^click_order_rate	string	0.0274	Click to order rate.
^^^unique_product_impressions	int	4890	Unique product impressions.
^^^unique_clicks	int	401	Total number of unique product clicks across the product performance channels.
^^^unique_ctr	string	0.082	Unique click-through rate.
^^^add_cart_users	int	45	Number of users who added to cart.
^^^unique_atc_rate	string	0.1122	Unique add to cart rate.
^^^unique_click_order_rate	string	0.0299	Unique click to order rate.
^^^gmv_incl_tax	object		GMV including tax. This field only returns the local currency.
^^^^amount	string	426.63	GMV with tax amount.
^^^^currency	string	GBP	GMV with tax currency code.
^^^tax	object		Tax amount. This field only returns the local currency.
^^^^amount	string	31.6	Tax amount.
^^^^currency	string	GBP	Tax currency code.
^^^gross_merchandise_value	object		Gross merchandise value for the product, including amount and currency.
^^^^amount	string	395.03	Gross merchandise value amount.
^^^^currency	string	GBP	Gross merchandise value currency code.
^^^shipping_fees	object		Shipping fees. This field only returns the local currency.
^^^^amount	string	18.5	Shipping fees amount.
^^^^currency	string	GBP	Shipping fees currency code.
^^^refunds	object		Refund amount.
^^^^amount	string	24.99	Refund amount.
^^^^currency	string	GBP	Refund currency code.
^^^refunded_items	int	1	Number of items refunded.
^^^refund_customers	int	1	Number of customers who received refunds.
^^seller_live_performance	object		Performance metrics from seller's live streaming.
^^^attributed_gmv	object		Attributed gross merchandise value.
^^^^amount	string	142.8	Attributed GMV amount.
^^^^currency	string	GBP	Attributed GMV currency code.
^^^attributed_orders	int	4	Number of attributed orders.
^^^attributed_sku_orders	int	4	Number of attributed SKU orders.
^^^attributed_sold_items	int	5	Number of attributed items sold.
^^^estimated_customers	int	4	Estimated number of customers.
^^^aov	object		Average order value.
^^^^amount	string	35.7	AOV amount.
^^^^currency	string	GBP	AOV currency code.
^^^new_live_count	int	2	Number of new live streams.
^^^product_impressions	int	1680	Number of product impressions.
^^^product_clicks	int	156	Number of product clicks.
^^^ctr	string	0.0929	Click-through rate.
^^^add_cart_count	int	21	Number of times products were added to the cart.
^^^add_cart_rate	string	0.1346	Add to cart rate.
^^^click_order_rate	string	0.0256	Click to order rate.
^^^unique_product_impressions	int	1510	Number of unique product impressions from seller live streaming.
^^^unique_clicks	int	141	Number of unique product clicks from seller live streaming.
^^^unique_ctr	string	0.0934	Unique click-through rate.
^^^add_cart_users	int	17	Number of users who added to cart.
^^^unique_atc_rate	string	0.1206	Unique add to cart rate.
^^^unique_click_order_rate	string	0.0284	Unique click to order rate.
^^seller_video_performance	object		Performance metrics from seller's video content.
^^^attributed_gmv	object		Attributed gross merchandise value.
^^^^amount	string	96.45	Attributed GMV amount.
^^^^currency	string	GBP	Attributed GMV currency code.
^^^attributed_orders	int	3	Number of attributed orders.
^^^attributed_sku_orders	int	3	Number of attributed SKU orders.
^^^attributed_sold_items	int	3	Number of attributed items sold.
^^^estimated_customers	int	3	Estimated number of customers.
^^^aov	object		Average order value.
^^^^amount	string	32.15	AOV amount.
^^^^currency	string	GBP	AOV currency code.
^^^new_video_count	int	3	Number of new videos.
^^^product_impressions	int	2140	Number of product impressions.
^^^product_clicks	int	173	Number of product clicks.
^^^ctr	string	0.0808	Click-through rate.
^^^add_cart_count	int	19	Number of times products were added to the cart.
^^^add_cart_rate	string	0.1098	Add to cart rate.
^^^click_order_rate	string	0.0173	Click to order rate.
^^^unique_product_impressions	int	1985	Number of unique product impressions from seller video content.
^^^unique_clicks	int	160	Number of unique product clicks from seller video content.
^^^unique_ctr	string	0.0806	Unique click-through rate.
^^^add_cart_users	int	15	Number of users who added to cart.
^^^unique_atc_rate	string	0.0938	Unique add to cart rate.
^^^unique_click_order_rate	string	0.0188	Unique click to order rate.
^^seller_product_card_performance	object		Performance metrics from seller's product card exposure.
^^^attributed_gmv	object		Attributed gross merchandise value.
^^^^amount	string	118.6	Attributed GMV amount.
^^^^currency	string	GBP	Attributed GMV currency code.
^^^attributed_orders	int	4	Number of attributed orders.
^^^attributed_sku_orders	int	5	Number of attributed SKU orders.
^^^attributed_sold_items	int	4	Number of attributed items sold.
^^^estimated_customers	int	4	Estimated number of customers.
^^^aov	object		Average order value.
^^^^amount	string	29.65	AOV amount.
^^^^currency	string	GBP	AOV currency code.
^^^product_impressions	int	1600	Number of product impressions.
^^^product_clicks	int	109	Number of product clicks.
^^^ctr	string	0.0681	Click-through rate.
^^^add_cart_count	int	17	Number of times products were added to the cart.
^^^add_cart_rate	string	0.156	Add to cart rate.
^^^click_order_rate	string	0.0367	Click to order rate.
^^^unique_product_impressions	int	1395	Number of unique product impressions from seller product card exposure.
^^^unique_clicks	int	100	Number of unique product clicks from seller product card exposure.
^^^unique_ctr	string	0.0717	Unique click-through rate.
^^^add_cart_users	int	13	Number of users who added to cart.
^^^unique_atc_rate	string	0.13	Unique add to cart rate.
^^^unique_click_order_rate	string	0.04	Unique click to order rate.
^^affiliate_total_performance	object		Total performance metrics from affiliate channel.
^^^attributed_gmv	object		GMV attributed from affiliate.
^^^^amount	string	204.3	Attributed GMV amount.
^^^^currency	string	GBP	Attributed GMV currency code.
^^^attributed_orders	int	6	Number of orders attributed from affiliate.
^^^attributed_sku_orders	int	6	Number of SKU orders attributed from affiliate.
^^^attributed_sold_items	int	7	Number of items sold attributed from affiliate.
^^^estimated_customers	int	5	Estimated number of customers from affiliate.
^^^aov	object		Average order value from affiliate.
^^^^amount	string	34.05	AOV amount.
^^^^currency	string	GBP	AOV currency code.
^^^avg_daily_creator_posted_content	int	8	Average daily number of creator-posted content.
^^^product_impressions	int	3840	Product impressions from affiliate.
^^^product_clicks	int	265	Product clicks from affiliate.
^^^ctr	string	0.069	Click-through rate from affiliate.
^^^add_cart_count	int	31	Number of times products were added to cart from affiliate.
^^^add_cart_rate	string	0.117	Add to cart rate from affiliate.
^^^click_order_rate	string	0.0226	Click to order rate from affiliate.
^^^unique_product_impressions	int	3410	Unique product impressions from affiliate.
^^^unique_clicks	int	238	Unique clicks from affiliate.
^^^unique_ctr	string	0.0698	Unique click-through rate from affiliate.
^^^add_cart_users	int	24	Number of users who added to cart from affiliate.
^^^unique_atc_rate	string	0.1008	Unique add to cart rate from affiliate.
^^^unique_click_order_rate	string	0.0252	Unique click to order rate from affiliate.
^^affiliate_live_performance	object		Performance metrics from affiliate live streaming.
^^^live_attributed_gmv	object		GMV attributed from affiliate live.
^^^^amount	string	121.4	Attributed GMV amount.
^^^^currency	string	GBP	Attributed GMV currency code.
^^^new_live_count	int	3	Number of new live streams from affiliate.
^^^product_impressions	int	1320	Product impressions from affiliate live.
^^^product_clicks	int	102	Product clicks from affiliate live.
^^^ctr	string	0.0773	Click-through rate from affiliate live.
^^^add_cart_count	int	14	Number of times products were added to cart from affiliate live.
^^^add_cart_rate	string	0.1373	Add to cart rate from affiliate live.
^^^click_order_rate	string	0.0294	Click to order rate from affiliate live.
^^^unique_product_impressions	int	1208	Unique product impressions from affiliate live.
^^^unique_clicks	int	94	Unique clicks from affiliate live.
^^^unique_ctr	string	0.0778	Unique click-through rate from affiliate live.
^^^atc_users	int	12	Number of users who added to cart from affiliate live.
^^^unique_atc_rate	string	0.1277	Unique add to cart rate from affiliate live.
^^^unique_click_order_rate	string	0.0319	Unique click to order rate from affiliate live.
^^affiliate_video_performance	object		Performance metrics from affiliate video content.
^^^attributed_video_gmv	object		GMV attributed from affiliate video.
^^^^amount	string	82.9	Attributed GMV amount.
^^^^currency	string	GBP	Attributed GMV currency code.
^^^new_video_count	int	5	Number of new videos from affiliate.
^^^product_impressions	int	2520	Product impressions from affiliate video.
^^^product_clicks	int	163	Product clicks from affiliate video.
^^^ctr	string	0.0647	Click-through rate from affiliate video.
^^^add_cart_count	int	17	Number of times products were added to cart from affiliate video.
^^^add_cart_rate	string	0.1043	Add to cart rate from affiliate video.
^^^click_order_rate	string	0.0184	Click to order rate from affiliate video.
^^^unique_product_impressions	int	2202	Unique product impressions from affiliate video.
^^^unique_clicks	int	144	Unique clicks from affiliate video.
^^^unique_ctr	string	0.0654	Unique click-through rate from affiliate video.
^^^atc_users	int	12	Number of users who added to cart from affiliate video.
^^^unique_atc_rate	string	0.0833	Unique add to cart rate from affiliate video.
^^^unique_click_order_rate	string	0.0208	Unique click to order rate from affiliate video.
^^shop_tab_performance	object		Performance metrics from shop tab.
^^^shop_tab_product_impressions	int	2520	Number of product impressions from Shop Tab.
^^^shop_tab_product_clicks	int	245	Number of product clicks from Shop Tab.
^^^unique_shop_tab_product_clicks	int	210	Number of unique product clicks from Shop Tab.
^^^estimated_shop_tab_customers	int	18	Estimated number of customers from Shop Tab.
^^^shop_tab_ctr	string	0.1551	Click-through rate from Shop Tab.
^^^shop_tab_ctor_sku	string	0.0735	Click-to-order rate (SKU level) from Shop Tab.
^^^shop_tab_gmv	object		GMV generated from shop tab.
^^^^amount	string	128.4	GMV amount.
^^^^currency	string	GBP	Currency code.
^^^shop_tab_sold_items	int	4	Items sold via shop tab.
^next_page_token	string	cGFnZV9udW1iZXI9MQ==	Page token for the next page request.
^total_count	int	10	Total number of products.
^latest_available_date	string	2024-04-07	Latest date in local timezone where data is ready (ISO 8601 format).

§8 Response Sample

{"code":0,"data":{"products":[{"id":"1732333333333333629","total_performance":{"gmv":{"amount":"395.03","currency":"GBP"},"orders":12,"sku_orders":12,"items_sold":12,"estimated_customers":10,"aov":{"amount":"32.92","currency":"GBP"},"product_impressions":5420,"product_clicks":438,"ctr":"0.0808","add_cart_count":57,"add_cart_rate":"0.1301","click_order_rate":"0.0274","unique_product_impressions":4890,"unique_clicks":401,"unique_ctr":"0.082","add_cart_users":45,"unique_atc_rate":"0.1122","unique_click_order_rate":"0.0299","gmv_incl_tax":{"amount":"426.63","currency":"GBP"},"tax":{"amount":"31.6","currency":"GBP"},"gross_merchandise_value":{"amount":"395.03","currency":"GBP"},"shipping_fees":{"amount":"18.5","currency":"GBP"},"refunds":{"amount":"24.99","currency":"GBP"},"refunded_items":1,"refund_customers":1},"seller_live_performance":{"attributed_gmv":{"amount":"142.8","currency":"GBP"},"attributed_orders":4,"attributed_sku_orders":4,"attributed_sold_items":5,"estimated_customers":4,"aov":{"amount":"35.7","currency":"GBP"},"new_live_count":2,"product_impressions":1680,"product_clicks":156,"ctr":"0.0929","add_cart_count":21,"add_cart_rate":"0.1346","click_order_rate":"0.0256","unique_product_impressions":1510,"unique_clicks":141,"unique_ctr":"0.0934","add_cart_users":17,"unique_atc_rate":"0.1206","unique_click_order_rate":"0.0284"},"seller_video_performance":{"attributed_gmv":{"amount":"96.45","currency":"GBP"},"attributed_orders":3,"attributed_sku_orders":3,"attributed_sold_items":3,"estimated_customers":3,"aov":{"amount":"32.15","currency":"GBP"},"new_video_count":3,"product_impressions":2140,"product_clicks":173,"ctr":"0.0808","add_cart_count":19,"add_cart_rate":"0.1098","click_order_rate":"0.0173","unique_product_impressions":1985,"unique_clicks":160,"unique_ctr":"0.0806","add_cart_users":15,"unique_atc_rate":"0.0938","unique_click_order_rate":"0.0188"},"seller_product_card_performance":{"attributed_gmv":{"amount":"118.6","currency":"GBP"},"attributed_orders":4,"attributed_sku_orders":5,"attributed_sold_items":4,"estimated_customers":4,"aov":{"amount":"29.65","currency":"GBP"},"product_impressions":1600,"product_clicks":109,"ctr":"0.0681","add_cart_count":17,"add_cart_rate":"0.156","click_order_rate":"0.0367","unique_product_impressions":1395,"unique_clicks":100,"unique_ctr":"0.0717","add_cart_users":13,"unique_atc_rate":"0.13","unique_click_order_rate":"0.04"},"affiliate_total_performance":{"attributed_gmv":{"amount":"204.3","currency":"GBP"},"attributed_orders":6,"attributed_sku_orders":6,"attributed_sold_items":7,"estimated_customers":5,"aov":{"amount":"34.05","currency":"GBP"},"avg_daily_creator_posted_content":8,"product_impressions":3840,"product_clicks":265,"ctr":"0.069","add_cart_count":31,"add_cart_rate":"0.117","click_order_rate":"0.0226","unique_product_impressions":3410,"unique_clicks":238,"unique_ctr":"0.0698","add_cart_users":24,"unique_atc_rate":"0.1008","unique_click_order_rate":"0.0252"},"affiliate_live_performance":{"live_attributed_gmv":{"amount":"121.4","currency":"GBP"},"new_live_count":3,"product_impressions":1320,"product_clicks":102,"ctr":"0.0773","add_cart_count":14,"add_cart_rate":"0.1373","click_order_rate":"0.0294","unique_product_impressions":1208,"unique_clicks":94,"unique_ctr":"0.0778","atc_users":12,"unique_atc_rate":"0.1277","unique_click_order_rate":"0.0319"},"affiliate_video_performance":{"attributed_video_gmv":{"amount":"82.9","currency":"GBP"},"new_video_count":5,"product_impressions":2520,"product_clicks":163,"ctr":"0.0647","add_cart_count":17,"add_cart_rate":"0.1043","click_order_rate":"0.0184","unique_product_impressions":2202,"unique_clicks":144,"unique_ctr":"0.0654","atc_users":12,"unique_atc_rate":"0.0833","unique_click_order_rate":"0.0208"},"shop_tab_performance":{"shop_tab_product_impressions":2520,"shop_tab_product_clicks":245,"unique_shop_tab_product_clicks":210,"estimated_shop_tab_customers":18,"shop_tab_ctr":"0.1551","shop_tab_ctor_sku":"0.0735","shop_tab_gmv":{"amount":"128.4","currency":"GBP"},"shop_tab_sold_items":4}}],"next_page_token":"cGFnZV9udW1iZXI9MQ==","total_count":10,"latest_available_date":"2024-04-07"},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

§9 Error Code

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code

Code	Message
28001022	invalid request params; detail: start time or end time is invalid.

这条内容对你有帮助吗？