v2.video.get_prodcut_performance_list

GET /api/v2/video/get_prodcut_performance_list

Get specific performance data for products linked with Shopee Video. There is at least a one-day delay.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/video/get_prodcut_performance_list

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.
user_id	int	1	Shopee's unique identifier for a user.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm.

Request Parameters

Name	Type	Required	Sample	Description
page_no	int32	True	1	The start index of request. Starting from 1.
page_size	int32	True	10	The number of item returned by this request. Max is 20.
period_type	string	True	Last7d	Period Type. Applicable values: Day Week Month Last7d Last15d Last30d Note: The end date must align with the Period Type.
end_date	string	True	2025-10-30	The end_date format should be "YYYY-MM-DD". - For Day, Last7d, Last15d, and Last30d, the end_date must before current day. - For Week, the end_date must be Sunday and must be less than or equal to the current week. - For Month, the end_date must be the end of the month and must be less than or equal to the current month.
order_by	string	True	PlacedOrders	Use this field to specify which field to use to sort the returned list. Available values: PlacedOrders PlacedSales PlacedUniqueBuyers ConfirmedOrders ConfirmedSales ConfirmedUniqueBuyers
sort	string	True	desc	Use this field to specify whether the returned list is sorted in ascending or descending order_by. Available values: asc desc
item_id	int64	False	1	Shopee's unique identifier for an item.
item_name	string	False	test item name	Search by product name.

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.
request_id	string	2af852cd-7420-4714-b7cd-33317f6fe548	The identifier for an API request for error tracking.
response	object		Detail informations you are querying.
total_count	int32		The total count of product that match the condition.
has_more	boolean		This is to indicate whether the video 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 data.
list	object[]		The list of product that match the condition.
shop_id	int64	1	Shopee's unique identifier for a shop.
item_id	int64	1	Shopee's unique identifier for an item.
item_name	string	test item name	Name of the item.
item_cover_image_url	string		Cover image url of the item.
item_description	string	desc	Description of the item.
placed_orders	int64	1	The number of placed orders for the item.
confirmed_orders	int64	1	The number of confirmed orders for the item.
placed_sales	float	1.0	The placed value of orders for the item.
confirmed_sales	float	1.0	The confirmed value of orders for the item.
placed_unique_buyers	int64	1	Number of unique buyers who placed order for the item.
confirmed_unique_buyers	int64	1	Number of unique buyers who confirmed order for the item.
fetched_date_range	string	2025-10-30	Data Date Range.