v2.video.get_overview_performance

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.video.get_overview_performance

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

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
period_type	string	Yes	Month	Period Type. Applicable values: Day Week Month; Last7d; Last15d; Last30d; Note: The end date must align with the Period Type.
end_date	string	Yes	2025-09-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.

§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
response.key_metric	object
response.key_metric.placed_sales	float	1.0	The placed value of orders from all videos in the period selected.
response.key_metric.confirmed_sales	float	1.0	The confirmed value of orders from all videos in the period selected.
response.key_metric.placed_orders	int64	2	The number of placed orders from all videos in the period selected.
response.key_metric.confirmed_orders	int64	2	The number of confirmed orders from all videos in the period selected.
response.key_metric.placed_item_sold	int64	3	Number of item sold from placed orders in the video.
response.key_metric.confirmed_item_sold	int64	3	Number of item sold from confirmed orders in the video.
response.key_metric.total_viewers	int64	4	Number of viewers of the video.
response.key_metric.effective_views	int64	4	Number of views for the video that lasted for more than 3 seconds.
response.key_metric.avg_view_duration	int64	5	Total watch duration per video.
response.conversion	object
response.conversion.placed_buyers	int64	2	Number of unique buyers who placed order from the video.
response.conversion.confirmed_buyers	int64	2	Number of unique buyers who confirmed order from the video.
response.conversion.total_atc	int64	2	Number of "Add To Cart" button clicked for all products in the orange bag during video viewing.
response.conversion.ctr	float	3.0	Number of products clicks divided by Number of video views.
response.conversion.placed_co_rate	float	1.0	Number of placed product orders from the video divided by Number of product clicks from the video.
response.conversion.confirmed_co_rate	float	1.0	Number of confirmed product orders from the video divided by Number of product clicks from the video.
response.conversion.placed_abs	float	1.0	Total placed sales divided by Total placed orders.
response.conversion.confirmed_abs	float	2.0	Total confirmed sales divided by Total confirmed orders.
response.conversion.placed_gpm	float	3.0	The placed Sales generated for every 1,000 views.
response.conversion.confirmed_gpm	float	4.0	The confirmed Sales generated for every 1,000 views.
response.conversion.video_with_products	int64	2	Videos with at least one product in the orange bag.
response.conversion.placed_revenue_generating_videos	int64	1	Videos that generates placed revenues.
response.conversion.confirmed_revenue_generating_videos	int64	1	Videos that generates confirmed revenues.
response.engagement	object
response.engagement.total_views	int64	1	Number of views from all videos
response.engagement.total_likes	int64	1	Number of likes from all videos
response.engagement.total_shares	int64	1	Number of shares from all videos
response.engagement.total_comments	int64	1	Number of comments from all videos
response.engagement.video_new_followers	int64	1	Number of new followers from all videos
response.fetched_date_range	string	2025-02-28	Data offline computation time.

§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_overview_performance?access_token=access_token&end_date=2025-09-30&partner_id=partner_id&period_type=Month&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_overview_performance?access_token=access_token&end_date=2025-09-30&partner_id=partner_id&period_type=Month&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_overview_performance?access_token=access_token&end_date=2025-09-30&partner_id=partner_id&period_type=Month&sign=sign&timestamp=timestamp&user_id=user_id'

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/video/get_overview_performance?access_token=access_token&end_date=2025-09-30&partner_id=partner_id&period_type=Month&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": {
		"key_metric": {
			"placed_sales": 1,
			"confirmed_sales": 1,
			"placed_orders": 2,
			"confirmed_orders": 2,
			"placed_item_sold": 3,
			"confirmed_item_sold": 3,
			"total_viewers": 4,
			"effective_views": 4,
			"avg_view_duration": 5
		},
		"conversion": {
			"placed_buyers": 2,
			"confirmed_buyers": 2,
			"total_atc": 2,
			"ctr": 3,
			"placed_co_rate": 1,
			"confirmed_co_rate": 1,
			"placed_abs": 1,
			"confirmed_abs": 2,
			"placed_gpm": 3,
			"confirmed_gpm": 4,
			"video_with_products": 2,
			"placed_revenue_generating_videos": 1,
			"confirmed_revenue_generating_videos": 1
		},
		"engagement": {
			"total_views": 1,
			"total_likes": 1,
			"total_shares": 1,
			"total_comments": 1,
			"video_new_followers": 1
		},
		"fetched_date_range": "2025-02-28"
	}
}

§13 Error example

Error example

§14 JSON

JSON

{
	"error": "error_param",
	"message": "periodType is Illegal",
	"response": null,
	"request_id": "063386d0-d757-4445-9f6a-bafa55c9d3a7"
}

§15 Errors

Errors

Error	Description	Solution
error_param	endDate is Illegal
error_param	periodType 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-09-10	New API

这条内容对你有帮助吗？