Get Video Performances｜快工助手

资料正文

§1 Path: /analytics/202403/videos/performances

§2 Method: [GET]

§3 Function Description

Use this US-creator-only API to retrieve TikTok e-commerce video metrics, including anchor_display_rate, click_through_rate, orders, items_sold, and GMV, for the requested videos.

§4 Common Parameters

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Properties	Location	Type	Require	Sample	Properties description
content-type	header	string	Y	application/json	Allowed type: application/json

§5 Request Query Parameters

Properties	Type	Require	Sample	Properties description
app_key	string	Y	38abcd	Every single app will have a unique key. Please use the specific key assigned to your app.
sign	string	Y	5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp	int	Y	1623812664	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
video_ids	string	Y	7341286689295469829,7271486684427046149	Collection of video IDs for retrieving the e-commerce metrics. Callers must ensure that all video IDs share the same author ID. Limit collection size 100. Use "," to separate array elements when send in the query.
start_time_ge	int	Y	1704091445	Start date for the metrics, set with a one-day delay from today due to latency in the data pipeline. The start_time parameter must be within the last 180 days from the current date. Only date value is processed, hour/mininute/second values will be ignored.
For example, if the start_time value is: 1703507696 ("26-12-2023 04:34:56"), backend service will only consider the part "26-12-2023" when doing the query because by default, in offline data analytics, there is no hour/min/sec data level.
end_time_le	int	Y	1711356201	End date for the metrics, set with a one-day delay from today due to latency in the data pipeline. Only date value is processed, hour/mininute/second values will be ignored.

§6 Request Sample

Query

https://open-api.tiktokglobalshop.com/analytics/202403/videos/performances?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&video_ids=7341286689295469829,7271486684427046149&start_time_ge=1704091445&end_time_le=1711356201

§7 Response Parameters

Properties	Type	Sample	Properties description
code	int	0	The success or failure status code returned in API response.
message	string	Success	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	202203070749000101890810281E8C70B7	Request log
data	object		Specific return information
^videos	[]object		Contains a list of video objects. The inner list of objects will be organized in ascending order based on the video_id field.
^^id	string	7271486684427046149	Each video ID in the request parameter corresponds to array of daily metrics.
^^performances	[]object		The list of objects within will be arranged in ascending order based on the start_time field.
^^^time_range	object		Time range object
^^^^start_time	int	1704067200	Date of the metrics.
^^^^end_time	int	1704067200	Date of the metrics.
^^^metrics	object		Metrics object.
^^^^anchor_display_rate	string	0.64	Display rate for anchors, specified with two decimal numbers.
^^^^click_through_rate	string	0.08	Click through rate, specified with two decimal numbers.
^^^^order_count	int	3	Number of orders in this date.
^^^^item_sold_count	int	3	Number of sold items in this date.
^^^^gmv	object		GMV object
^^^^^amount	string	27.85	GMV value for this date, specified with two decimal numbers.
^^^^^currency	string	USD	Currency of GMV value, three-letter code, ISO 4217

§8 Response Sample

{"code":0,"data":{"videos":[{"id":"7271486684427046149","performances":[{"time_range":{"start_time":1704067200,"end_time":1704067200},"metrics":{"anchor_display_rate":"0.64","click_through_rate":"0.08","order_count":3,"item_sold_count":3,"gmv":{"amount":"27.85","currency":"USD"}}}]}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

§9 Error Code

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code

Code	Message