stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202509/shop_videos/overview_performance
#§2 Method: [GET]
#§3 Function Description
Returns overall performance metrics for all videos under 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) | ||||
| today | bool | N | true | If "today" is set to true, start_date_ge and end_date_lt will be overwritten. |
| The response will contain real-time metrics of today (local time) | ||||
| granularity | string | N | ALL | Granularity of the data. |
| Available values: ALL, 1D | ||||
| Default value: ALL |
- ALL: aggregate
- 1D: daily | currency |string |N |USD |Currency. Available values: USD, LOCAL Default value: LOCAL
- USD: US dollars
- LOCAL: local currency where the shop is located | account_type |string |N |ALL |Types of the accounts under which videos were created. Available values:
- ALL: All account types.
- OFFICIAL_ACCOUNTS: Official accounts.
- MARKETING_ACCOUNTS: Marketing accounts.
- AFFILIATE_ACCOUNTS: Affiliate accounts. Default value: ALL |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202509/shop_videos/overview_performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&start_date_ge=2024-09-01&end_date_lt=2024-09-08&today=true&granularity=ALL¤cy=USD&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 | |
| ^performance | object | Overall performance data for videos. | |
| ^^intervals | []object | Interval data for the requested time range. The time range of each interval is determined by the granularity. | |
| ^^^start_date | string | 2024-09-01 | Start date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive. |
| ^^^end_date | string | 2024-09-08 | End date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive. |
| ^^^gmv | object | Overall Gross Merchandise Value (GMV) for videos. | |
| ^^^^amount | string | 246.80 | 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). |
| ^^^click_through_rate | string | 12.5% | 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% | |||
| ^^^sku_orders | int | 0 | The total number of paid SKU orders placed directly from all shoppable videos. |
| ^^^product_clicks | int | 23 | The number of product clicks from the video. |
| ^^^avg_customers | int | 23 | Daily average number of customers. |
| ^^^product_impressions | int | 23 | The number of impressions of all video products. |
| ^latest_available_date | string | 2024-09-08 | Latest date in local timezone where data is ready (ISO 8601 format). |
§8 Response Sample
{"code":0,"data":{"performance":{"intervals":[{"start_date":"2024-09-01","end_date":"2024-09-08","gmv":{"amount":"246.80","currency":"USD"},"click_through_rate":"12.5%","sku_orders":0,"product_clicks":23,"avg_customers":23,"product_impressions":23}]},"latest_available_date":"2024-09-08"},"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 |
|---|