快工助手跨境电商知识与商机助手
快工云仓服务介绍

Shop Performance Score (SPS) APIs v202606 for US Shops: Five New APIs Added

TikTok Shop 官方资料 · TikTok Shop Partner Center 开发者文档 · 适合开发者

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存，可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
TikTok Shop / profile.tiktok.docs_api
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§1 Summary

Five new read-only Shop Performance Score (SPS) APIs are now available in v202606 for US-region shops. They allow apps to retrieve a shop's SPS overview and metric details, diagnose individual metrics, and drill down into the products, logistics providers, aftersales types, orders, or chats associated with performance issues. Apps can retrieve the SPS overview and metrics, then request diagnosis and affected-object details for a selected metric. The APIs return SPS data only and do not modify products, orders, logistics settings, or customer service settings.

#

§2 What is changing

The following APIs are added in v202606. The currently documented SPS metric codes are NRR, NBFR, SFCR, OTDR, AHT, and IM_DSAT.

APIMethodEndpointDescription
Get SPS OverviewGET/analytics/202606/shop_performances/overviewReturns the SPS score, tier, dimensions, benefits, and top issues.
Get SPS MetricsGET/analytics/202606/shop_performances/metricsReturns SPS metric details and benchmark thresholds.
Get SPS Metric DiagnosisGET/analytics/202606/shop_performances/metrics/{metric_code}/diagnosisReturns benchmarks, trends, calculation details, distribution details, and diagnostic insights for one metric.
Get SPS Metric Top ItemsGET/analytics/202606/shop_performances/metrics/{metric_code}/top_itemsReturns the top products, logistics providers, or aftersales types for the selected metric.
Get SPS Metric Problem DetailsGET/analytics/202606/shop_performances/metrics/{metric_code}/problem_detailsReturns the problem orders or chats associated with the selected metric.
#

§3 Common request requirements

Common request requirements

All five APIs:

  • Require the data.shop_analytics.public.read scope and a seller access token.
  • Require shop_cipher in the query and content-type: application/json in the header.
  • Accept the optional locale query parameter to localize response text.
  • Support US-region shops only.

Get SPS Metric Diagnosis also accepts the optional trend_duration_days query parameter. Its default value is 30.

#

§4 What action is required

If your app displays or diagnoses SPS data for US shops, review the following updates. Recommended actions:

  • Review the five v202606 API references and confirm that your app has the data.shop_analytics.public.read scope.
  • Add shop_cipher to each request and pass locale when localized response text is required.
  • Call Overview first. If SPS is available, call Metrics, then request Diagnosis for a selected metric. Use Top Items for NRR, NBFR, OTDR, and AHT; use Problem Details to retrieve affected orders or chats for any of the six metrics.
  • Use the API-returned status, benefits.is_unlocked, benchmarks, top_reason_text, and update_time as the source of truth. Do not hard-code tier thresholds or predict benefit eligibility from the displayed score.
  • Treat page_token as an opaque value when paginating problem details, and do not request more than 50 records per page.
  • Handle NIL, empty or partial results, authorization errors, and unknown future metric_code values gracefully.
  • Test the full workflow with an authorized US shop in API Testing Tool before rolling it out to production traffic.

If you need implementation guidance, field-to-page mappings, or recommended merchant actions for each SPS metric, review the related use case documents below. Related documents： SPS API Merchant Performance Diagnosis: ISV Integration Use Cases (English) SPS API 商家绩效诊断：ISV 集成 User Case（中文）

#