v2.video.get_video_detail_performance

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

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

打开官方原文 ↗

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

查看技术与溯源信息

平台 / 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_performance

Get detailed performance data for 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_performance
Production URL	https://partner.shopeemobile.com/api/v2/video/get_video_detail_performance
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/video/get_video_detail_performance
Permission	Shopee Video Management

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
post_id	string	Yes	YwOo_gZqCACXbM0UAAAAAA==	A unique identifier for Shopee videos.

§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.video_info	object		Video post detail informations you are querying.
response.video_info.post_id	string	YwOo_gZqCACXbM0UAAAAAA==	A unique identifier for Shopee videos.
response.video_info.post_time	timestamp	1761188662147	The time when the video post to Shopee Video.
response.video_info.video_url	string	https://down-bs-id.vod.susercontent.com/c3/50007225/201/A3oxONdWALgpg8thEbEBACc.mp4	Video play url.
response.video_info.cover_image_url	string	https://down-sp-id.vod.susercontent.com/c3/50007225/201/A3oyOUXSAFAbg8thIfYBBgAn.jpg	Cover image url of the Shopee Video.
response.video_info.caption	string	#tt Tt1	Description of the Shopee Video.
response.video_info.duration	int64	6866	Video duration time in millisecond.
response.video_info.related_item_count	int64	1	Number of products linked with the Shopee Video.
response.video_performance	object		Overall performance data of the video you are querying.
response.video_performance.views	int64	1	Amount of views from the video.
response.video_performance.likes	int64	1	Total likes from the video.
response.video_performance.comments	int64	1	Total comments from the video.
response.video_performance.shares	int64	1	Total shares from the video.
response.video_performance.followers_growth	int64	1	Amount of new followers from the Video.
response.video_performance.placed_orders	int64	1	Amount of product orders from the video.
response.video_performance.placed_sales	float	1.0	Amount of product sales from the video.
response.video_performance.unique_buyers	int64	1	Buyers of the products in the video.
response.video_performance.conversion_rate	float	1.0	Amount of products sold from the video/amount of views from the video.
response.video_performance.sold_items	int64	1	Amount of products sold from the video.
response.video_performance.product_clicks	int64	1	The product click value of orders for item.
response.video_performance.product_click_rate	float	2.0	The product click rate value of orders for item.
response.video_performance.sales_per_order	float	1.0	Amount of product sales from the video/amount of product orders from the video.
response.video_performance.sales_per_buyer	float	1.0	Amount of product sales from the video/amount of buyers from the video.

§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_performance?access_token=access_token&partner_id=partner_id&post_id=YwOo_gZqCACXbM0UAAAAAA%3D%3D&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_performance?access_token=access_token&partner_id=partner_id&post_id=YwOo_gZqCACXbM0UAAAAAA%3D%3D&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_performance?access_token=access_token&partner_id=partner_id&post_id=YwOo_gZqCACXbM0UAAAAAA%3D%3D&sign=sign&timestamp=timestamp&user_id=user_id'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/video/get_video_detail_performance?access_token=access_token&partner_id=partner_id&post_id=YwOo_gZqCACXbM0UAAAAAA%3D%3D&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": "",
	"request_id": "2af852cd-7420-4714-b7cd-33317f6fe548",
	"response": {
		"video_info": {
			"post_id": "YwOo_gZqCACXbM0UAAAAAA==",
			"post_time": 1761188662147,
			"video_url": "https://down-bs-id.vod.susercontent.com/c3/50007225/201/A3oxONdWALgpg8thEbEBACc.mp4",
			"cover_image_url": "https://down-sp-id.vod.susercontent.com/c3/50007225/201/A3oyOUXSAFAbg8thIfYBBgAn.jpg",
			"caption": "#tt Tt1",
			"duration": 6866,
			"related_item_count": 1
		},
		"video_performance": {
			"views": 1,
			"likes": 1,
			"comments": 1,
			"shares": 1,
			"followers_growth": 1,
			"placed_orders": 1,
			"placed_sales": 1,
			"unique_buyers": 1,
			"conversion_rate": 1,
			"sold_items": 1,
			"product_clicks": 1,
			"product_click_rate": 2,
			"sales_per_order": 1,
			"sales_per_buyer": 1
		}
	}
}

§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	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
2025-11-17	New API

这条内容对你有帮助吗？