stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202605/shop_videos/performance
#§2 Method: [GET]
#§3 Function Description
Returns a list of videos and associated metrics for a shop.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| 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. |
| start_date_ge | string | Y | 2024-09-01 | Start date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. |
| In the parameter name, "ge" refers to "greater than or equal to" (inclusive) | ||||
| end_date_lt | string | Y | 2024-09-08 | End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. |
| In the parameter name, "lt" refers to "less than" (exclusive) | ||||
| page_size | int | N | 10 | Number of videos per page. |
| Max value: 100 | ||||
| Default value: 10 | ||||
| sort_field | string | N | gmv | Field used to sort the shop video performance list. |
| Default value: gmv | ||||
| Available values: |
- gmv: sort by overall Gross Merchandise Value (GMV).
- gpm: sort by average GMV generated from 1,000 views.
- avg_customers: sort by daily average customers.
- sku_orders: sort by paid SKU orders.
- items_sold: sort by units sold.
- views: sort by video views.
- click_through_rate: sort by the ratio of product clicks to video views. | sort_order |string |N |DESC |Sort direction. Available values: ASC, DESC Default value: DESC
- ASC: ascending
- DESC: descending | currency |string |N |USD |Currency. Available values: USD, LOCAL Default value: LOCAL
- USD: US dollars
- LOCAL: local currency where the shop is located | page_token |string |N |cGFnZV9udW1iZXI9MQ== |Page token, indicating the current position. Used for requesting next page data. Leave this field empty for first time queries. | account_type |string |N |ALL |Types of the accounts under which videos were created. Available values: ALL, OFFICIAL_ACCOUNTS, MARKETING_ACCOUNTS, AFFILIATE_ACCOUNTS Default value: ALL
- ALL: all account types
- OFFICIAL_ACCOUNTS: official accounts
- MARKETING_ACCOUNTS: marketing accounts
- AFFILIATE_ACCOUNTS: affiliate accounts |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202605/shop_videos/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&start_date_ge=2024-09-01&end_date_lt=2024-09-08&page_size=10&sort_field=gmv&sort_order=DESC¤cy=USD&page_token=cGFnZV9udW1iZXI9MQ==&account_type=ALL
§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 | List of video performance metrics. | |
| ^^id | string | 172xxxxxxxxxxxxx089 | The unique identifier of the video in the performance list. |
| ^^title | string | How to Style Summer Outfits | The title of the video. |
| ^^username | string | creator_shop_01 | The username associated with the video. |
| ^^creator | object | Creator information for the video, including open ID, username, nickname, and author type. | |
| ^^^open_id | string | uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg | Creator's open id, use this open id to identify a creator. |
| ^^^user_name | string | creator_shop_01 | Creator user name. |
| ^^^nick_name | string | abc_bec | Creator handle. |
| ^^^author_type | string | OFFICIAL | The creator's user type. This is an enumerated type with values: |
| OFFICIAL, CHANNEL, AFFILIATE | |||
| ^^video_post_time | string | 2025-01-01 00:00:00 | Date and time video was posted (ISO 8601 format) |
| ^^duration | int | 34 | Video duration in seconds |
| ^^hash_tags | []string | ["#racuntiktok","fyp"] | The hash tags of the video |
| ^^gmv | object | Overall Gross Merchandise Value (GMV) for the video. | |
| ^^^amount | string | 125.50 | GMV amount in the corresponding currency. |
| ^^^currency | string | USD | GMV currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP). |
| ^^gpm | object | The average GMV generated from 1,000 views of the video. | |
| ^^^amount | string | 32.40 | GMV amount in the corresponding currency. |
| ^^^currency | string | USD | GMV currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP). |
| ^^avg_customers | int | 35 | Daily average customers |
| ^^sku_orders | int | 12 | The total number of paid SKU orders placed directly from the current video. |
| ^^items_sold | int | 18 | Number of units sold from the current video. |
| ^^views | int | 1200 | Number of video views during the selected time range. |
| ^^click_through_rate | string | 0.0528 | Ratio of the number of product clicks compared to number of video views in raw decimal format. To calculate the percentage, multiple it by 100%. |
| Example: 0.0528 <=> 5.28% | |||
| ^^products | []object | List of products promoted in the video. | |
| ^^^id | string | 105xxxxxxxxxxxxx247 | The unique identifier of a product promoted in the video. |
| ^^^name | string | Wireless Earbuds | The name of a product promoted in the video. |
| ^latest_available_date | string | 2024-09-07 | Latest date in local timezone where data is ready (ISO 8601 format). |
| ^next_page_token | string | cGFnZV9udW1iZXI9MQ== | Page token for the next page request. |
| ^total_count | int | 10 | Total number of videos. |
§8 Response Sample
{"code":0,"data":{"videos":[{"id":"172xxxxxxxxxxxxx089","title":"How to Style Summer Outfits","username":"creator_shop_01","creator":{"open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg","user_name":"creator_shop_01","nick_name":"abc_bec","author_type":"OFFICIAL"},"video_post_time":"2025-01-01 00:00:00","duration":34,"hash_tags":["#racuntiktok","fyp"],"gmv":{"amount":"125.50","currency":"USD"},"gpm":{"amount":"32.40","currency":"USD"},"avg_customers":35,"sku_orders":12,"items_sold":18,"views":1200,"click_through_rate":"0.0528","products":[{"id":"105xxxxxxxxxxxxx247","name":"Wireless Earbuds"}]}],"latest_available_date":"2024-09-07","next_page_token":"cGFnZV9udW1iZXI9MQ==","total_count":10},"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 |
|---|---|
| 28001022 | invalid request params; detail: start time or end time is invalid. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |