stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202509/shop_products/{product_id}/performance
#§2 Method: [GET]
#§3 Function Description
Returns detailed performance metrics for the specified product.
§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 |
|---|---|---|---|---|
| product_id | string | Y | 1732xxxxxxxxxxxxx629 | The ID of the product 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 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 |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202509/shop_products/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=LOCAL
§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 | |
| ^performance | object | Overall performance data for the product. | |
| ^^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. | |
| ^^^^^amount | string | 233 | 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). |
| ^^^^orders | int | 23 | Total (sum of all) orders for the product. |
| ^^^^items_sold | int | 23 | Number of items sold for the product. |
| ^^^^breakdowns | []object | Sales breakdowns. | |
| ^^^^^content_type | string | LIVE | Sales breakdown content type. |
| Possible values: |
- VIDEO: Video content.
- LIVE: Live stream content.
- PRODUCT_CARD: Product card. | ^^^^^sales |object | |Sales of the corresponding content type. | ^^^^^^gmv |object | |Gross merchandise value. | ^^^^^^^amount |string |43 |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). | ^^^^^^items_sold |int |454 |Number of items sold in the corresponding content type. | ^^^^^^avg_customers |int |34 |Daily average count of customers. | ^^^traffic |object | |Traffic performance. | ^^^^breakdowns |[]object | |Traffic breakdowns. | ^^^^^traffic |object | |Traffic performance of the corresponding content type. | ^^^^^^impressions |int |34 |Each time a link to your listing appears in the shop tab, it's counted as one impression. Users can tap links to visit your listings page directly. | ^^^^^^page_views |int |43 |Total number of product details page views during the selected period, including multiple views from unique users. | ^^^^^^avg_unique_page_views |int |34 |Daily average unique views visitors to your product details pages. | ^^^^^^ctr |string |0.034 |The percentage of viewers who clicked on product links after seeing them in the Shop tab. Number of clicks divided by the number of views. | ^^^^^^avg_conversion_rate |string |0.033 |Average percentage of unique page views that result in sales. | ^^^^^content_type |string |LIVE |Traffic breakdown content type. Possible values:
- VIDEO: Video content.
- LIVE: Live stream content.
- PRODUCT_CARD: Product card. | ^^^cancel_and_refunds |object | |cancel and refunds data | ^^^^returned |int |2 |Returned refers to units that were returned and refunded. | ^^^^canceled |int |23 |Canceled refers to units included in orders that were either "Unpaid" or "Awaiting Shipment." | ^^^^refunded |int |3 |Refunded refers to units that were refunded but not returned. | ^^^^replacements |int |3 |Replacements refers to units that were returned and replaced. | ^^ratings |[]object | |ratings within the choosen start_date_ge and end_date_ge | ^^^stars |string |1_STAR |Rating star bucket. Possible values:
- 1_STAR: One-star rating.
- 2_STAR: Two-star rating.
- 3_STAR: Three-star rating.
- 4_STAR: Four-star rating.
- 5_STAR: Five-star rating. | ^^^count |int |23 |Number of reviews in the corresponding rating. | ^^^percentage |string |0.23 |Percentage of the corresponding rating. | ^^top_contents |[]object | |brief report of product related content within the choosen start_date_ge and end_date_ge. sorted by gmv, only return the top 100. | ^^^type |string |LIVE |Top content type. Possible values:
- LIVE: Live stream content.
- VIDEO: Video content. | ^^^contents |[]object | |Content details | ^^^^content_id |string |2304002883 |LIVE session ID or video ID | ^^^^items_sold |int |23 |Number of items sold in the corresponding content. | ^^^^gmv |object | |Gross merchandise value. | ^^^^^amount |string |323 |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). | ^^top_creators |[]object | |brief report of product related creator within the choosen start_date_ge and end_date_ge. sorted by gmv, only return the top 100. | ^^^creator_open_id |string |uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg |Creator/s open id, use this open id to identify the unique creator. | ^^^creator_name |string |nick.name |Creator name shown on the profile page. | ^^^creator_profile |string |https://www.example.com/images/creator-profile.webp |The URL to the creator's profile picture. | ^^^gmv |object | |The GMV created by this creator. | ^^^^amount |string |2365 |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). | ^^^items_sold |int |32 |Number of items sold by this creator. | ^latest_available_date |string |2024-04-07 |Latest date in local timezone where data is ready (ISO 8601 format). |
§9 Response Sample
{"code":0,"data":{"performance":{"intervals":[{"start_date":"2024-04-01","end_date":"2024-04-08","sales":{"gmv":{"amount":"233","currency":"USD"},"orders":23,"items_sold":23,"breakdowns":[{"content_type":"LIVE","sales":{"gmv":{"amount":"43","currency":"USD"},"items_sold":454,"avg_customers":34}}]},"traffic":{"breakdowns":[{"traffic":{"impressions":34,"page_views":43,"avg_unique_page_views":34,"ctr":"0.034","avg_conversion_rate":"0.033"},"content_type":"LIVE"}]},"cancel_and_refunds":{"returned":2,"canceled":23,"refunded":3,"replacements":3}}],"ratings":[{"stars":"1_STAR","count":23,"percentage":"0.23"}],"top_contents":[{"type":"LIVE","contents":[{"content_id":"2304002883","items_sold":23,"gmv":{"amount":"323","currency":"GBP"}}]}],"top_creators":[{"creator_open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg","creator_name":"nick.name","creator_profile":"https://www.example.com/images/creator-profile.webp","gmv":{"amount":"2365","currency":"GBP"},"items_sold":32}]},"latest_available_date":"2024-04-07"},"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. |