v2.principal.get_principal_video_performance

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

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

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

查看技术与溯源信息

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

资料正文

§1 v2.principal.get_principal_video_performance

Queries video performance data for the specified principal within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and region-level detailed metrics.

§2 Overview

Overview

Field	Value
Module	BrandPortal
API type	Principal
HTTP method	POST
Path	/api/v2/principal/get_principal_video_performance
Production URL	https://partner.shopeemobile.com/api/v2/principal/get_principal_video_performance
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/principal/get_principal_video_performance
Permission	Brand Portal Service

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
start_date	string	Yes	2026-01-01	Start date of the requested period in YYYY-MM-DD format. Limitations: - Must use the YYYY-MM-DD format.; - Must be a valid calendar date.; - Must not be later than end_date.; - Validation is based on the requested timezone.; - The earliest selectable date is calculated as: current day in timezone - 1 day - 2 years.; - The exact boundary rules depend on granularity: -- For customize, start_date must not be earlier than the earliest selectable date.; -- For day, start_date must equal end_date.; -- For week, start_date must be a Sunday.; -- For month, start_date must be the first day of the month.; -- For quarter, start_date must be the first day of the quarter.; -- For year, start_date must be the first day of the year.
end_date	string	Yes	2026-01-31	End date of the requested period in YYYY-MM-DD format. Limitations: - Must use the YYYY-MM-DD format. - Must be a valid calendar date. - Must not be earlier than start_date. - Validation is based on the requested timezone. - For customize, end_date must not be later than the day before the current day in the requested timezone. The inclusive date range from start_date to end_date must not exceed 366 days. - For day, end_date must equal start_date. - For week, end_date must be within the selected week range: from start_date (Sunday) to the end of that Sunday-to-Saturday week, or to the latest selectable day if the week extends beyond today. Formally: startDate ≤ endDate ≤ min(startDate + 6 days, today - 1 day). - For month, end_date must be within the selected month: from the 1st day of the month to the last calendar day of that month, or to the latest selectable day for the current month. Formally: startDate ≤ endDate ≤ min(month end, today - 1 day). - For quarter, end_date must be within the selected quarter: from the 1st day of the quarter to the last calendar day of that quarter, or to the latest selectable day for the current quarter. Formally: startDate ≤ endDate ≤ min(quarter end, today - 1 day). - For year, end_date must be within the selected year: from January 1st to December 31st of that year, or to the latest selectable day for the current year. Formally: startDate ≤ endDate ≤ min(Dec 31, today - 1 day).
timezone	string	Yes	GMT+8	Timezone used for date boundary calculation, selectable date validation, and timestamp conversion. Limitations: - Enum values: ["GMT+7", "GMT+8", "GMT-3"]; - The API internally normalizes the open API timezone value for video metric queries.; - All date validation rules are evaluated in the requested timezone.
granularity	string	Yes	month	Aggregation granularity that determines the validation rules for the requested date range and the reporting period.; Limitations: - Supported values are customize, day, week, month, quarter, and year.; - customize is validated as a free date range.; - day represents a single calendar day.; - week requires a Sunday-based calendar week.; - month requires a calendar month range.; - quarter requires a calendar quarter range.; - year requires a calendar year range.; - Any other value is rejected as invalid_parameter.
region_list	object[]	No		Optional list of principal regions to be queried.; Limitations: - When omitted or empty, the API queries all regions belonging to the specified principal_id except the aggregate regional bucket.; - Must contain at most 100 region objects.; - Every region must belong to the specified principal_id.; - Duplicate region values are merged when they use the same currency.; - The same region cannot appear with different currencies.; - Currency defaults to USD when omitted.
region_list.region	string	Yes	MY	Region code to be queried. Limitations: - Required for every region object in region_list.; - Must be a valid region code supported by the API.; - Must belong to the specified principal_id.
region_list.currency	string	No	USD	Currency used for amount-based metrics for the region. Limitations: - Optional for every region object in region_list.; - Supported values are LOCAL and USD.; - Invalid currency values are rejected as invalid_parameter.; - Defaults to USD when omitted.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
request_id	string	0b9847f8-9091-44ea-9eb1-59f3ce3bdf83	The identifier for an API request, used for troubleshooting and log tracing.
error	string		Indicate error type if any error happened. Empty string if no error.
message	string		Indicate error details if any error happened. Empty string if no error.
response	object		Business response payload. See Business Response Parameters below.
response.summary	object[]		Aggregated summary metrics for the requested date range, representing the overall video performance of the selected principal. Summary values are returned in USD when data exists.; Note: - total_video_duration is returned only in summary.; - unique_viewers and total_unique_buyers are unavailable for customize, month, quarter, year, and non-full-week weekly ranges.
response.summary.currency	string	USD	Currency code used for all amount-based metrics in the summary. Summary values are returned in USD.
response.summary.orders	int64	5	Number of placed orders (paid and unpaid) during your Video, including cancelled orders.
response.summary.likes	int64	2	Number of Like clicks from all videos.
response.summary.comments	int64	0	Number of comments generated from all videos.
response.summary.share	int64	3	Number of shares created from all videos.
response.summary.sales	float	853.395968	Value of placed orders (paid and unpaid) from all videos in the period, reflecting the sales amount received by sellers after deducting seller rebates. Note: This value includes sales from cancelled and return/refund orders.
response.summary.units_sold	int64	5	Number of items sold from placed orders during your Video.
response.summary.effective_views	int64	651	Number of views from the video that lasted for more than 3 seconds.
response.summary.unique_viewers	int64	771	Number of video viewers in the selected period. Note: This data is unavailable when you select by month, by quarter, by year, customize date, or a non-full weekly range.
response.summary.total_video_duration	float	0.0	Total duration of your videos in minutes. This field is returned only in summary.
response.summary.atc_units	int64	31	Number of Add To Cart button clicks for all products in the orange bag during your Video.
response.summary.average_video_duration	float	0.0	Average duration of your videos in minutes.
response.summary.average_views_duration	float	2.1	Average viewing duration per video in minutes.
response.summary.total_unique_buyers	int64	4	Number of unique buyers who placed order from your Video. Note: This data is unavailable when you select by month, by quarter, by year, customize date, or a non-full weekly range.
response.summary.conversion_rate	float	0.0020601565718994645	Video orders / effective video views.
response.details	object[]		List of region-level detail records that returns video performance metrics for each selected region within the requested date range.; Note: - details do not include total_video_duration.; - unique_viewers and total_unique_buyers are unavailable for customize, month, quarter, year, and non-full-week weekly ranges.
response.details.region	string	SG	Region code of this detail item.
response.details.currency	string	LOCAL	Currency code used for all amount-based metrics of this region item.
response.details.orders	int64	5	Number of placed orders (paid and unpaid) during your Video, including cancelled orders.
response.details.likes	int64	2	Number of Like clicks from all videos.
response.details.comments	int64	0	Number of comments generated from all videos.
response.details.share	int64	3	Number of shares created from all videos.
response.details.sales	float	1090.0	Value of placed orders (paid and unpaid) from all videos in the period, reflecting the sales amount received by sellers after deducting seller rebates. Note: This value includes sales from cancelled and return/refund orders.
response.details.units_sold	int64	5	Number of items sold from placed orders during your Video.
response.details.effective_views	int64	651	Number of views from the video that lasted for more than 3 seconds.
response.details.unique_viewers	int64	771	Number of video viewers in the selected period. Note: This data is unavailable when you select by month, by quarter, by year, customize date, or a non-full weekly range.
response.details.atc_units	int64	31	Number of Add To Cart button clicks for all products in the orange bag during your Video.
response.details.average_video_duration	float	0.0	Average duration of your videos in minutes.
response.details.average_views_duration	float	2.63	Average viewing duration per video in minutes.
response.details.total_unique_buyers	int64	4	Number of unique buyers who placed order from your Video. Note: This data is unavailable when you select by month, by quarter, by year, customize date, or a non-full weekly range.
response.details.conversion_rate	float	0.0020601565718994645	Video orders / effective video views.

§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.
principal_id	int	1	Shopee's unique identifier for a principal.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, principal_id and partner_key via HMAC-SHA256 hashing algorithm.

§6 Request samples

Request samples

§7 Payload

Payload

{
	"start_date": "2026-01-01",
	"end_date": "2026-01-31",
	"timezone": "GMT+8",
	"granularity": "month",
	"region_list": [
		{
			"region": "MY",
			"currency": "USD"
		},
                {
			"region": "SG",
			"currency": "USD"
		}
	]
}

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/principal/get_principal_video_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"end_date\": \"2026-01-31\",
   \"granularity\": \"month\",
   \"region_list\": [
      {
         \"currency\": \"USD\",
         \"region\": \"MY\"
      }
   ],
   \"start_date\": \"2026-01-01\",
   \"timezone\": \"GMT+8\"
}")
.asString();

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/principal/get_principal_video_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "end_date": "2026-01-31",
    "granularity": "month",
    "region_list": [
        {
            "currency": "USD",
            "region": "MY"
        }
    ],
    "start_date": "2026-01-01",
    "timezone": "GMT+8"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§10 cURL

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/principal/get_principal_video_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "end_date": "2026-01-31",
   "granularity": "month",
   "region_list": [
      {
         "currency": "USD",
         "region": "MY"
      }
   ],
   "start_date": "2026-01-01",
   "timezone": "GMT+8"
}'

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/principal/get_principal_video_performance?access_token=access_token&partner_id=partner_id&principal_id=principal_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "end_date": "2026-01-31",
  "granularity": "month",
  "region_list": [
    {
      "currency": "USD",
      "region": "MY"
    }
  ],
  "start_date": "2026-01-01",
  "timezone": "GMT+8"
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§12 Response sample

Response sample

§13 JSON

JSON

{
	"request_id": "0b9847f8-9091-44ea-9eb1-59f3ce3bdf83",
	"error": "",
	"message": "",
	"response": {
		"summary": [
			{
				"currency": "USD",
				"orders": 5,
				"likes": 2,
				"comments": 0,
				"share": 3,
				"sales": 853.395968,
				"units_sold": 5,
				"effective_views": 651,
				"unique_viewers": 771,
				"total_video_duration": 0.1,
				"atc_units": 31,
				"average_video_duration": 0.1,
				"average_views_duration": 2.1,
				"total_unique_buyers": 4,
				"conversion_rate": 0.0020601565718994645
			}
		],
		"details": [
			{
				"region": "SG",
				"currency": "LOCAL",
				"orders": 5,
				"likes": 2,
				"comments": 0,
				"share": 3,
				"sales": 1090,
				"units_sold": 5,
				"effective_views": 651,
				"unique_viewers": 771,
				"atc_units": 31,
				"average_video_duration": 0.1,
				"average_views_duration": 2.63,
				"total_unique_buyers": 4,
				"conversion_rate": 0.0020601565718994645
			}
		]
	}
}

§14 Error example

Error example

§15 JSON

JSON

{
    "request_id": "8e0c35d5-d1b6-4b46-9ddd-b4188a920b55",
    "error": "error_param",
    "message": "timezone is invalid. allowed values: GMT+7, GMT+8, GMT-3.",
    "response": null
}

§16 Errors

Errors

Error	Description	Solution
error_param	timezone is required
error_param	timezone is invalid. allowed values: GMT+7, GMT+8, GMT-3.
error_param	granularity is required
error_param	request body is invalid
error_param	currency is invalid
error_param	region_list contains invalid region.
error_param	region is required
error_param	end_date is not ready, please retry later
error_param	for day granularity, start_date must equal end_date.
error_param	day range is outside the allowed selectable range.
error_param	for week granularity, end_date must be within the selected week range
error_param	for week granularity, start_date must be a Sunday.
error_param	week start_date is earlier than the earliest allowed week.
error_param	start_date cannot be later than end_date.
error_param	month range is outside the allowed selectable range.
error_param	for month granularity, start_date must be the first day of month.
error_param	for month granularity, end_date must be within the selected month range.
error_param	for quarter granularity, end_date must be within the selected quarter range.
error_param	year range is outside the allowed selectable range.
error_param	for quarter granularity, start_date must be the first day of quarter.
error_param	for quarter granularity, end_date must be within the selected quarter range.
error_param	start_date is earlier than the earliest allowed date
error_param	for year granularity, end_date must be within the selected year range.
error_param	end_date must not be later than the latest selectable day.
error_permission	auth failed
error_param	start_date is required
error_param	start_date is required; start_date must use YYYY-MM-DD
error_param	end_date is required
error_param	end_date must use YYYY-MM-DD

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

§18 Update log

Update log

Date	Change
2026-07-09	New API

这条内容对你有帮助吗？