stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202509/shop/performance
#§2 Method: [GET]
#§3 Function Description
Returns performance metrics at shop/seller level.
§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-04-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-04-08 | End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. |
| In the parameter name, "lt" refers to "less than" (exclusive) | ||||
| granularity | string | N | ALL | Granularity of the data. |
| Available values: ALL, 1D | ||||
| Default value: ALL |
- ALL: aggregate
- 1D: daily | currency |string |N |LOCAL |Currency. Available values: USD, LOCAL Default value: LOCAL
- USD: US dollars
- LOCAL: local currency where the shop is located |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202509/shop/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=LOCAL
§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 the shop. | |
| ^^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-08 | End date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive. |
| ^^^sales | object | Sales performance within the interval. | |
| ^^^^gmv | object | Gross merchandise value: Total amount paid for orders during the selected period, including canceled and refunded orders. | |
| ^^^^^overall | object | Overall gmv. | |
| ^^^^^^amount | string | 335.02 | GMV amount in the corresponding currency. |
| ^^^^^^currency | string | GBP | 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). |
| ^^^^^breakdowns | []object | GMV breakdowns. | |
| ^^^^^^gmv | object | Gross merchandise value: Total amount paid for orders during the selected period, including canceled and refunded orders. | |
| ^^^^^^^amount | string | 111 | 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). |
| ^^^^^^type | string | LIVE | GMV breakdown type. |
| Possible values: |
- VIDEO: Video content.
- LIVE: Live stream content.
- PRODUCT_CARD: Product card. | ^^^^gross_revenue |object | |Gross revenue includes customer payments and platform product subsidies, minus any applicable taxes. Formula: Gross revenue = (Customer payment + Platform product subsidies) − Taxes | ^^^^^overall |object | |Overall gross revenue. | ^^^^^^amount |string |239.04 |GMV amount in the corresponding currency. | ^^^^^^currency |string |GBP |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). | ^^^^^breakdowns |[]object | |Revenue breakdowns. | ^^^^^^percentage |string |0.4324 |The percentage of revenue generated from the corresponding breakdown type. | ^^^^^^type |string |NON_GMV_MAX |Gross revenue breakdown type by market. For SEA, MX, and BR markets, possible values are NON_GMV_MAX and GMV_MAX. For UK and EU markets, possible values are ADS and ORGANIC. This breakdown is not applicable for US and JP markets. | ^^^^items_sold |int |32422 |The total number of individual items sold. Example: If a customer buys 3 units of SKU A and 2 units of SKU B, the items sold would be 5. | ^^^^sku_orders_count |int |23214 |A total count of distinct SKUs sold. | ^^^^orders_count |int |21234 |The number of paid orders during the selected period. | ^^^^avg_customers_count |int |14322 |Daily average number of unique users who paid for orders during the selected period. | ^^^^refunds |object | |The amount of order refunds generated. | ^^^^^amount |string |2323 |Refunds 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). | ^^^traffic |object | |Traffic data for the interval, including average page views, average visitors, and average conversion rate. | ^^^^avg_page_views |int |56234 |Daily average number of page views for all of your product detail pages during the selected period. | ^^^^avg_visitors |int |3433 |Daily average number of unique users who visited your product detail pages during the selected period | ^^^^avg_conversation_rate |string |0.3342 |The daily average percentage of unique users who paid for orders after viewing product detail pages during the selected period. | ^latest_available_date |string |2024-04-07 |Latest date in local timezone where data is ready (ISO 8601 format). |
§8 Response Sample
{"code":0,"data":{"performance":{"intervals":[{"start_date":"2024-04-01","end_date":"2024-04-08","sales":{"gmv":{"overall":{"amount":"335.02","currency":"GBP"},"breakdowns":[{"gmv":{"amount":"111","currency":"USD"},"type":"LIVE"}]},"gross_revenue":{"overall":{"amount":"239.04","currency":"GBP"},"breakdowns":[{"percentage":"0.4324","type":"NON_GMV_MAX"}]},"items_sold":32422,"sku_orders_count":23214,"orders_count":21234,"avg_customers_count":14322,"refunds":{"amount":"2323","currency":"USD"}},"traffic":{"avg_page_views":56234,"avg_visitors":3433,"avg_conversation_rate":"0.3342"}}]},"latest_available_date":"2024-04-07"},"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. |