stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202509/shop_skus/{sku_id}/performance
#§2 Method: [GET]
#§3 Function Description
Returns performance metrics for the specified SKU.
§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 Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| sku_id | string | Y | 1732xxxxxxxxxxxxx629 | The ID of the SKU whose performance metrics are requested. |
§6 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-04-01 | Start time (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive. |
| end_date_lt | string | Y | 2024-04-08 | End time (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive. |
| granularity | string | N | ALL | Granularity of the data. |
| Available values: ALL, 1D | ||||
| Default value: ALL |
- ALL: aggregate
- 1D: daily | currency |string |N |USD |Currency:
- USD: US dollars
- LOCAL (default): Local currency where the shop is located |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202509/shop_skus/1732xxxxxxxxxxxxx629/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&start_date_ge=2024-04-01&end_date_lt=2024-04-08&granularity=ALL¤cy=USD
§8 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 | |
| ^latest_available_date | string | 2024-04-07 | Latest date in local timezone where data is ready (ISO 8601 format). |
| ^performance | object | Overall performance data for the product. | |
| ^^product_id | int | 123456789 | The ID of the product that the SKU belongs to. |
| ^^sku_id | string | 123456789 | The ID of the SKU for this performance object. |
| ^^intervals | []object | Interval data for the requested time range. The time range of each interval is determined by the granularity. | |
| ^^^start_date | string | 2024-04-01 | Start date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive. |
| ^^^end_date | string | 2024-04-07 | End date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive. |
| ^^^gmv | object | Overall Gross Merchandise Value (GMV) for the SKU. | |
| ^^^^amount | string | 135.42 | 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). |
| ^^^gmv_breakdown | []object | GMV breakdowns for the SKU. | |
| ^^^^amount | string | 82.15 | GMV amount for the corresponding type and 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). |
| ^^^^type | string | LIVE | GMV breakdown type. |
| Possible values: |
- LIVE: Live stream content.
- VIDEO: Video content.
- PRODUCT_CARD: Product card. | ^^^items_sold |int |10 |Number of units sold for the SKU. | ^^^items_sold_breakdown |[]object | |Unit sold breakdowns. | ^^^^amount |int |10 |Number of units sold for the corresponding type. | ^^^^type |string |LIVE |Items-sold breakdown type. Possible values:
- LIVE: Live stream content.
- VIDEO: Video content.
- PRODUCT_CARD: Product card. | ^^^sku_orders |int |10 |Total (sum of all) orders for the SKU. |
§9 Response Sample
{"code":0,"data":{"latest_available_date":"2024-04-07","performance":{"product_id":123456789,"sku_id":"123456789","intervals":[{"start_date":"2024-04-01","end_date":"2024-04-07","gmv":{"amount":"135.42","currency":"USD"},"gmv_breakdown":[{"amount":"82.15","currency":"USD","type":"LIVE"}],"items_sold":10,"items_sold_breakdown":[{"amount":10,"type":"LIVE"}],"sku_orders":10}]}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 28001007 | can't find any related data; detail: Product not found. Please make sure the product_id you send belongs to a valid product under the current shop. |
| 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. |