v2.video.get_video_detail_product_performance

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

来自 Shopee 官方资料快照 · 2026-09-06 12:15:45

打开官方原文 ↗

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

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 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.

§2 Overview

Overview

Field	Value
Module	Video
API type	User
HTTP method	GET
Path	/api/v2/video/get_video_detail_product_performance
Production URL	https://partner.shopeemobile.com/api/v2/video/get_video_detail_product_performance
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/video/get_video_detail_product_performance
Permission	Shopee Video Management

§3 Request parameters

Request parameters

Name	Type	Required	Description
page_no	int64	Yes	The start index of request. Starting from 1.
page_size	int64	Yes	The number of item returned by this request. Max is 20.
post_id	string	Yes	The unique identifier for post Shopee Video.
item_id	int64	No	Shopee's unique identifier for an item.
item_name	string	No	Name of the item.

§4 Response parameters

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

§5 Common parameters

Common 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.

§6 Request samples

Request samples

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/video/get_video_detail_product_performance?access_token=access_token&item_id=0&item_name=-&page_no=0&page_size=0&partner_id=partner_id&post_id=-&sign=sign&timestamp=timestamp&user_id=user_id")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/video/get_video_detail_product_performance?access_token=access_token&item_id=0&item_name=-&page_no=0&page_size=0&partner_id=partner_id&post_id=-&sign=sign&timestamp=timestamp&user_id=user_id',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/video/get_video_detail_product_performance?access_token=access_token&item_id=0&item_name=-&page_no=0&page_size=0&partner_id=partner_id&post_id=-&sign=sign&timestamp=timestamp&user_id=user_id'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/video/get_video_detail_product_performance?access_token=access_token&item_id=0&item_name=-&page_no=0&page_size=0&partner_id=partner_id&post_id=-&sign=sign&timestamp=timestamp&user_id=user_id"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"error": "",
	"message": "",
	"response": {
		"total_count": 1,
		"list": [
			{
				"shop_id": "111",
				"item_id": "222",
				"item_cover_image_url": "https://cf.shopee.co.id/file/id-11134207-7rasc-m3buy7g7hhp039",
				"item_name": "Woman clothes",
				"item_description": "test",
				"likes": 1,
				"comments": 2,
				"placed_orders": 0,
				"placed_sales": 0,
				"unique_buyers": 0,
				"conversion_rate": 0,
				"product_clicks": 0,
				"product_click_rate": 0,
				"sold_items": 0,
				"sales_per_order": 0,
				"sales_per_buyer": 0
			}
		],
		"has_more": false
	},
	"request_id": "e443e246-d834-454e-8541-6687dbaa2c27"
}

§13 Error example

Error example

§14 JSON

JSON

{
	"error": "error_param",
	"message": "post_id is illegal.",
	"request_id": "3f4e5995-b70a-4380-9a8d-1f4f5d2bdc91"
}

§15 Errors

Errors

Error	Description	Solution
error_param	page_no must over 1
error_param	page_size can not over 20
error_param	can not find post_id.
error_param	post_id is illegal

§16 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
user_no_linked	Partner and user has no linked.
user_banned	This user account has been banned. Permissions for user authorization and API calls have been suspended until the user account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
error_param	There is no user_id in query.
error_param	user_id is invalid, should be an integer between 0 and 4294967295.

§17 Update log

Update log

Date	Change
-	New API

这条内容对你有帮助吗？