v2.video.get_video_performance_list

GET /api/v2/video/get_video_performance_list

Get specific performance data for individual post Shopee Video. There is at least a one-day delay.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/video/get_video_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 video 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.
caption	string	False		Description of the Shopee Video.
order_by	string	True	Likes	Use this field to specify which field to use to sort the returned list. Available values: Views Likes Comments AvgViewsDuration
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

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	1	The total count of video that match the condition.
has_more	boolean	false	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 video that match the condition.
video_upload_id	string	id-11110201-6ko2m-mczrffx878mba3	ID of uploaded video.
post_id	string	YwOo_gZqCACXbM0UAAAAAA==	The unique identifier for post Shopee Video. Only have value when the video status is 300 (POSTED).
post_time	timestamp	1761188662147	The time when the video post to Shopee Video. Only have value when the video status is 300 (POSTED).
video_url	string	https://down-bs-id.vod.susercontent.com/c3/50007225/201/A3oxONdWALgpg8thEbEBACc.mp4	Video play url.
status	int64	300	Video current status. Applicable values: 300: POSTED 400: DELETED
cover_image_url	string	https://down-sp-id.vod.susercontent.com/c3/50007225/201/A3oyOUXSAFAbg8thIfYBBgAn.jpg	Cover image url of the Shopee Video.
caption	string	#tt Tt1	Description of the Shopee Video.
duration	string	6866	Video duration time in millisecond.
views	int64	1	View count of post Shopee Video. Only have value when the video status is 300 (POSTED).
likes	int64	1	Like count the post Shopee Video. Only have value when the video status is 300 (POSTED).
comments	int64	1	Comment count the post Shopee Video. Only have value when the video status is 300 (POSTED).
shares	int64	1	Share count the post Shopee Video. Only have value when the video status is 300 (POSTED).
avg_views_duration	int64	1	Total watch duration per video.
completion_rate	float	1.0	Video completion rate.
placed_orders	int64	1	The number of placed orders for the video.
confirmed_orders	int64	1	The number of confirmed orders for the video.
placed_sales	float	1.2	The placed value of orders for the video.
confirmed_sales	float	1.0	The confirmed value of orders for the video.
placed_item_sold	int64	1	Number of item sold from placed orders in the video.
confirmed_item_sold	int64	1	Number of item sold from confirmed orders in the video.
fetched_date_range	string	2025-10-30	Data Date Range.