Get SPS Metrics

GET

/analytics/202606/shop_performances/metrics

Returns SPS metric details and benchmark thresholds for the authorized shop. 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

Authorizations

• accessToken

Parameters

Query Parameters

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.

Responses

200

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

metrics

Fixed complete SPS metric set for the authorized shop.

Array<object>

object

benchmarks

Benchmark thresholds for the metric, expressed in the unit specified by value_unit.

object

excellent_threshold

Excellent tier threshold.

string

poor_threshold

Poor tier threshold.

string

dimension

SPS dimension that the metric belongs to.

string

evaluate_duration_days

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

integer format: int64

end_evaluation_time

Metric evaluation period end time. Unix timestamp in seconds.

integer format: int64

start_evaluation_time

Metric evaluation period start time. Unix timestamp in seconds.

integer format: int64

metric_code

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

string

metric_name

Localized metric display name.

string

score

Metric score, from 0 to 5.

string

status

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

string

status_text

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

string

value

Metric value. Hours are represented as values; percentages are represented as values from 0 to 100.

string

value_unit

Unit of the metric value. Possible values include PERCENT and HOURS.

string

top_reason_text

Indicates that this metric is a key contributor to SPS.

string

Example

{
  "code": 0,
  "data": {
    "metrics": [
      {
        "benchmarks": {
          "excellent_threshold": "0.02",
          "poor_threshold": "0.08"
        },
        "dimension": "Product satisfaction",
        "evaluate_duration_days": 30,
        "end_evaluation_time": 1761264000,
        "start_evaluation_time": 1758672000,
        "metric_code": "NRR",
        "metric_name": "60-day negative review rate",
        "score": "4.7",
        "status": "EXCELLENT",
        "status_text": "Excellent",
        "value": "0.97",
        "value_unit": "PERCENT",
        "top_reason_text": "Top opportunity"
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}