Skip to content

Get SPS Overview

GET
/analytics/202606/shop_performances/overview

Returns the SPS overview for the authorized shop, including the score, tier, dimensions, benefits, and top issues. Shop Performance Score (SPS) reflects a shop’s performance across key operational and service metrics on TikTok Shop. By integrating the read-only SPS APIs, ISVs can retrieve a shop’s score, tier, benefits, and metric benchmarks, diagnose performance gaps, and drill down to the products, logistics providers, aftersales types, orders, or chats associated with specific issues. This enables ISVs to embed actionable performance insights into their solutions, helping merchants identify problem areas faster and take targeted actions to improve shop performance. Available only for US-region shops. Use case guide: Click here

shop_cipher
required
string

Identifies the shop. Obtain it from the Get Authorized Shops API.

locale
string

BCP 47 locale code used to localize response text. If omitted, the default locale is resolved from the request context.

Success

Media typeapplication/json
object
code

Status code; 0 means success.

integer format: int64
message

Success or failure message.

string
request_id

Request log ID.

string
data
object
benefits

Fixed complete set of benefits associated with the shop SPS score.

Array<object>
object
benefit_name

Benefit display name localized by the requested locale.

string
is_unlocked

Whether the shop has unlocked this benefit.

boolean
unlock_score

Score required to unlock the benefit, from 0 to 5.

string
dimensions

Score details by SPS dimension.

Array<object>
object
name

Dimension name.

string
score

Dimension score, from 0 to 5.

string
status

Dimension status enum. Possible values include EXCELLENT, GOOD, POOR, CRITICAL and NIL.

string
status_text

Dimension status text. Values like Excellent, Good, Normal, Attention.

string
weight

Dimension weight as a percent from 0 to 100.

string
evaluate_duration_days

The number of days included in the score evaluation period.

integer format: int64
end_evaluation_time

The evaluation period end time. Unix timestamp in seconds.

integer format: int64
start_evaluation_time

The evaluation period start time. Unix timestamp in seconds.

integer format: int64
peer_percentile

The shop’s percentile among peers, from 0 to 100.

string
primary_category

The shop’s primary category.

object
category_id

The primary category ID.

string
category_name

The primary category name.

string
sps_score

The shop SPS score, from 0 to 5 with one decimal place.

string
sps_tier

The SPS tier. Possible values include EXCELLENT, GOOD, POOR, CRITICAL and NIL.

string
sps_tier_text

The SPS tier. Values like Excellent, Good, Normal, Attention.

string
top_issues

Top SPS issues that contributed to the current score.

object
issues

Ranked issue list.

Array<object>
object
description

Localized issue description.

string
evaluate_duration_days

Number of days included in this issue’s evaluation period.

integer format: int64
end_evaluation_time

Issue evaluation period end time. Unix timestamp in seconds.

integer format: int64
start_evaluation_time

Issue evaluation period start time. Unix timestamp in seconds.

integer format: int64
metric_code

Related metric code. Possible values include NRR, NBFR, SFCR, OTDR, AHT, and IM_DSAT.

string
metric_name

Localized metric display name.

string
percentile

Metric percentile among peer shops, from 0 to 100.

string
rank

Issue rank, where 1 is the top issue.

integer format: int64
summary

Localized summary of the top issues.

string
update_time

The latest score refresh time. Unix timestamp in seconds.

integer format: int64
Example
{
"code": 0,
"data": {
"benefits": [
{
"benefit_name": "LIVE giveaway",
"is_unlocked": true,
"unlock_score": "4.5"
}
],
"dimensions": [
{
"name": "Product satisfaction",
"score": "4.8",
"status": "EXCELLENT",
"status_text": "Excellent",
"weight": "70"
}
],
"evaluate_duration_days": 90,
"end_evaluation_time": 1782518400,
"start_evaluation_time": 1774828800,
"peer_percentile": "86.5",
"primary_category": {
"category_id": "601450",
"category_name": "Home Supplies"
},
"sps_score": "4.6",
"sps_tier": "GOOD",
"sps_tier_text": "Excellent",
"top_issues": {
"issues": [
{
"description": "Your on-time delivery performance is lower than peer shops.",
"evaluate_duration_days": 31,
"end_evaluation_time": 1761264000,
"start_evaluation_time": 1758672000,
"metric_code": "OTDR",
"metric_name": "On-time delivery rate",
"percentile": "72.4",
"rank": 1
}
],
"summary": "Improve late dispatch and negative reviews to increase your SPS score."
},
"update_time": 1761264000
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}