v2.video.get_video_detail_product_performance

GET /api/v2/video/get_video_detail_product_performance

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

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/video/get_video_detail_product_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.
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	int64	True		The start index of request. Starting from 1.
page_size	int64	True		The number of item returned by this request. Max is 20.
post_id	string	True		The unique identifier for post Shopee Video.
item_id	int64	False		Shopee's unique identifier for an item.
item_name	string	False		Name of the item.

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.
list	object[]		The list of item that match the condition.
shop_id	int64		Shopee's unique identifier for a shop.
item_id	int64	34002	Shopee's unique identifier for an item.
item_name	string	seller discount	Name of the item.
item_cover_image_url	string		Cover image url of the item.
item_description	string		Description of the item.
likes	int64	1	Like count the post Shopee Video.
comments	int64	1	Comment count the post Shopee Video.
placed_orders	int64	1	Amount of product orders from the video.
placed_sales	float	2.0	Amount of product sales from the video.
unique_buyers	int64	2	Buyers of the product in the video.
sold_items	int64	1	Amount of products sold from the video.
product_clicks	int64	1	Amount of product clicks from the video.
product_click_rate	float	1.0	Amount of product clicks from the video/Product view from video.
conversion_rate	float	1.0	Amount of products sold from the video/amount of views from the video.
sales_per_order	float	2.0	Amount of product sales from the video/amount of product orders from the video.
sales_per_buyer	float	2.0	Amount of product sales from the video/amount of buyers from the video.
total_count	int64	10	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.