来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Overview
This release introduces three new versioned Analytics APIs that deliver enriched Seller Compass data, achieving full metric parity between the OpenAPI and the Seller Center Data Compass UI.
Developers can now programmatically access comprehensive product performance metrics (including traffic funnel, conversion, and channel-level attribution), video performance metrics (with creator attribution and engagement data), and bestselling product image information — eliminating the need for manual CSV exports from Seller Center. These APIs enable ISVs and TSPs to build automated product monitoring dashboards, video content ROI analysis tools, and competitive intelligence features powered by real-time Seller Compass data.
§2 What's New
#§3 Affected APIs
Affected APIs
| Name | Path | Type | Version | Description |
|---|---|---|---|---|
| Get Shop Product Performance List | [GET] /analytics/202605/shop_products/performance | RESTful API | 202605 | Returns a list of product performance overview metrics, enriched with full traffic funnel, conversion, and channel-level attribution data. |
| Get Shop Video Performance List | [GET] /analytics/202605/shop_videos/performance | RESTful API | 202605 | Returns a list of videos and associated metrics for a shop, enriched with creator attribution, video engagement data, and content metadata. |
| Get Bestselling Products | [GET] /analytics/202511/products/bestselling | RESTful API | 202511 | Get the top 100 performing products of the target date range, now enriched with product image information. |
§4 Detailed Changes
#§5 1. Get Shop Product Performance List (v202605)
1. Get Shop Product Performance List (v202605)
API Documentation:Get Shop Product Performance List This is a new API version that significantly enriches the product performance data compared to the previous version (v202509). The previous version only returned GMV, orders, and units sold. The new v202605 version returns a comprehensive set of performance metrics across all traffic channels.
§6 New Response Fields
New Response Fields
| Field Path | Type | Description |
|---|---|---|
| products[].total_performance.product_impressions | int64 | Number of product impressions (PV). |
| products[].total_performance.product_clicks | int64 | Number of product clicks. |
| products[].total_performance.ctr | string | Click-through rate (decimal format, e.g., 0.0808 = 8.08%). |
| products[].total_performance.add_cart_count | int64 | Number of times products were added to the cart. |
| products[].total_performance.add_cart_rate | string | Add to cart rate. |
| products[].total_performance.click_order_rate | string | Click to order rate. |
| products[].total_performance.unique_product_impressions | int64 | Unique product impressions. |
| products[].total_performance.unique_clicks | int64 | Unique clicks. |
| products[].total_performance.unique_ctr | string | Unique click-through rate. |
| products[].total_performance.add_cart_users | int64 | Number of users who added to cart. |
| products[].total_performance.unique_atc_rate | string | Unique add to cart rate. |
| products[].total_performance.unique_click_order_rate | string | Unique click to order rate. |
| products[].total_performance.estimated_customers | int64 | Estimated number of customers. |
| products[].total_performance.aov | object | Average order SKU value (amount + currency). |
| products[].total_performance.gmv_incl_tax | object | GMV including tax. Only returns local currency. |
| products[].total_performance.tax | object | Tax amount. Only returns local currency. |
| products[].total_performance.gross_merchandise_value | object | Gross merchandise value. |
| products[].total_performance.shipping_fees | object | Shipping fees. Only returns local currency. |
| products[].total_performance.refunds | object | Refund amount. |
| products[].total_performance.refunded_items | int64 | Number of items refunded. |
| products[].total_performance.refund_customers | int64 | Number of customers who received refunds. |
| products[].seller_live_performance | object | Performance metrics from seller's live streaming channel. |
| products[].seller_video_performance | object | Performance metrics from seller's video content channel. |
| products[].seller_product_card_performance | object | Performance metrics from seller's product card exposure. |
| products[].affiliate_total_performance | object | Total performance metrics from affiliate channel. |
| products[].affiliate_total_performance.avg_daily_creator_posted_content | int64 | Average daily number of creator-posted content. |
| products[].affiliate_live_performance | object | Performance metrics from affiliate live streaming. |
| products[].affiliate_video_performance | object | Performance metrics from affiliate video content. |
| products[].shop_tab_performance | object | Performance metrics from shop tab. |
| products[].shop_tab_performance.shop_tab_product_impressions | int64 | Number of product impressions from Shop Tab. |
| products[].shop_tab_performance.shop_tab_product_clicks | int64 | Number of product clicks from Shop Tab. |
| products[].shop_tab_performance.unique_shop_tab_product_clicks | int64 | Number of unique product clicks from Shop Tab. |
| products[].shop_tab_performance.estimated_shop_tab_customers | int64 | Estimated number of customers from Shop Tab. |
| products[].shop_tab_performance.shop_tab_ctr | string | Click-through rate from Shop Tab. |
| products[].shop_tab_performance.shop_tab_ctor_sku | string | Click-to-order rate (SKU level) from Shop Tab. |
| products[].shop_tab_performance.shop_tab_gmv | object | GMV generated from shop tab. |
| products[].shop_tab_performance.shop_tab_sold_items | int64 | Items sold via shop tab. |
§7 New Request Parameters
New Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| category_filter | []string | false | Category ID array for filtering products by category. |
| product_status_filter | string | false | Filter by product status. Available values: LIVE, INACTIVE, ALL (default). |
§8 Use Cases
Use Cases
Use Case 1 — Full Conversion Funnel Analysis
A TSP managing 50+ sellers wants to identify products with high impressions but low conversion rates. By calling this API and analyzing the product_impressions → product_clicks → ctr → add_cart_rate → click_order_rate funnel for each product, the TSP can automatically flag underperforming SKUs and generate optimization recommendations (e.g., "Product X has 5,420 impressions but only 8.08% CTR — consider updating the main image or title").
Use Case 2 — Channel Attribution and ROI Comparison
An ISV builds a channel performance dashboard by comparing seller_live_performance, seller_video_performance, seller_product_card_performance, and affiliate_total_performance for each product. This enables sellers to understand which traffic channel (live, video, product card, or affiliate) drives the most efficient GMV per impression, and reallocate their marketing budget accordingly.
Use Case 3 — Affiliate Creator Effectiveness Tracking
Using the affiliate_total_performance.avg_daily_creator_posted_content field combined with affiliate_video_performance.attributed_video_gmv and affiliate_live_performance.live_attributed_gmv, a TSP can calculate per-creator content productivity and ROI, helping sellers decide which affiliate partnerships to scale and which to discontinue.
Use Case 4 — Shop Tab Performance Monitoring
By tracking shop_tab_performance.shop_tab_product_impressions, shop_tab_ctr, and shop_tab_gmv over time, sellers can measure the impact of shop page optimization efforts (such as product sorting, featured collections) on organic Shop Tab traffic and conversion.
§9 2. Get Shop Video Performance List (v202605)
2. Get Shop Video Performance List (v202605)
API Documentation:Get Shop Video Performance List This is a new API version that enriches video performance data with creator attribution, video engagement metrics, and content metadata. The previous version (v202509) did not include creator information.
§10 New Response Fields
New Response Fields
| Field Path | Type | Description |
|---|---|---|
| videos[].creator | object | Creator info object. |
| videos[].creator.open_id | string | Creator's open ID. Use this open ID to identify a creator. |
| videos[].creator.user_name | string | Creator user name. |
| videos[].creator.nick_name | string | Creator handle. |
| videos[].creator.author_type | string | The creator's user type. Enumerated values: OFFICIAL, CHANNEL, AFFILIATE. |
§11 New Request Parameters
New Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| account_type | string | false | Filter by account type. Available values: ALL (default), OFFICIAL_ACCOUNTS, MARKETING_ACCOUNTS, AFFILIATE_ACCOUNTS. |
§12 Use Cases
Use Cases
Use Case 1 — Creator vs. Self-Produced Video ROI Analysis
A TSP uses the creator.author_type field to segment all videos into "OFFICIAL" (self-produced) vs. "AFFILIATE" (creator-generated). By comparing GMV, gpm, and views across these segments, the agency quantifies the ROI difference between in-house content production and creator partnerships. For example: "Affiliate videos generated $2.3 GPM vs. $0.8 GPM from official videos — recommend scaling creator collaborations."
Use Case 2 — Video Content Strategy Optimization
Using duration, views, click_through_rate, and hash_tags, an ISV identifies correlations between video characteristics and performance. For instance: "Videos between 15–30 seconds with hashtag #TikTokMadeMeBuyIt achieve 3x higher CTR than videos over 60 seconds" — enabling data-driven content creation guidelines for sellers.
Use Case 3 — Creator Performance Leaderboard
By aggregating data using creator.open_id across multiple videos, a TSP builds an internal creator leaderboard ranked by total attributed GMV, average GPM, and content frequency. The creator.nick_name and creator.user_name fields allow human-readable identification. This powers decisions on which creators to renew contracts with and at what commission rate.
Use Case 4 — Affiliate Account Filtering for Dedicated Reporting
Using the new account_type request parameter, a TSP can request only AFFILIATE_ACCOUNTS videos in a single API call, generating a dedicated affiliate performance report without needing to filter results client-side. This reduces data processing overhead and simplifies integration logic.
§13 3. Get Bestselling Products (v202511 — Field Enrichment)
3. Get Bestselling Products (v202511 — Field Enrichment)
API Documentation:Get Bestselling Products This update adds product image information to the existing Get Bestselling Products API (v202511), enabling developers to display product visuals alongside ranking data in their applications.
§14 New Response Fields
New Response Fields
| Field Path | Type | Description |
|---|---|---|
| products[].product_image | object | Product image object. |
| products[].product_image.height | int64 | The image height (unit: px). |
| products[].product_image.width | int64 | The image width (unit: px). |
| products[].product_image.thumb_urls | []string | The URLs to view the image thumbnails. |
| products[].product_image.uri | string | The URI of the image. |
| products[].product_image.urls | []string | The URLs to view the full-size images. |
§15 Use Cases
Use Cases
Use Case 1 — Visual Bestseller Dashboard
A TSP builds a visual competitive intelligence dashboard that displays the top 100 bestselling products with their images, names, GMV ranges, and ratings. Using product_image.thumb_urls for thumbnail rendering in list views and product_image.urls for full-size detail views, the dashboard provides an experience comparable to the Seller Center UI — enabling sellers to quickly identify trending products and potential competitors visually.
Use Case 2 — Automated Product Sourcing Recommendations
An ISV cross-references bestselling product images (via product_image.urls) with their seller's existing catalog to identify visual look-alikes and gaps. When a trending product is detected that no managed seller currently offers, the system generates a sourcing alert with the product image, name, GMV range, and category, helping sellers capitalize on emerging trends faster than manual browsing would allow.
§16 Important Notes
- Authorization required: All three APIs require a valid seller OAuth access token (
x-tts-access-token). The data returned is scoped to the authorized seller's shop. - API Scope: Get Shop Product Performance List and Get Shop Video Performance List require the
TikTok Shop Analyticsscope. Get Bestselling Products requires theTikTok Shop Bestsellersscope. - Data latency: Data is available on a T-1 basis (previous day's data becomes available the following day).
- Query range: The maximum query range is 180–365 days depending on the API. Date parameters use ISO 8601 YYYY-MM-DD format in the shop's registered timezone.
- Pagination: Product and Video Performance APIs support pagination via
page_tokenwith a maximumpage_sizeof 100. - Currency options: All APIs support
USD(US dollars) orLOCAL(local currency where the shop is located) via thecurrencyquery parameter. Default isLOCAL. - GMV desensitization (Bestsellers only): GMV values in the Bestselling Products API are returned as ranges with a random offset applied for privacy protection. Exact GMV figures are not available.
- Channel-level metrics structure (Product Performance): The
seller_live_performance,seller_video_performance,seller_product_card_performance,affiliate_total_performance,affiliate_live_performance, andaffiliate_video_performanceobjects all share a consistent structure. - Version migration: These are new API versions (202605 for Product and Video Performance). The previous versions (202509) remain available but do not include the enriched fields. Developers are encouraged to migrate to the new versions for full metric coverage.
- Rate limiting: Standard API rate limits apply. Refer to the API documentation for specific rate limit details.
