Metric diagnosis

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "metricCode": "OTDR",
  "dimension": "Fulfillment and logistics",
  "score": "4.1",
  "status": "GOOD",
  "statusText": "Good",
  "value": "94.7",
  "valueUnit": "PERCENT",
  "benchmarks": {
    "excellentThreshold": "95",
    "poorThreshold": "85"
  },
  "evaluateDurationDays": 30,
  "evaluationStartsAt": "2026-08-30T00:00:00.000Z",
  "evaluationEndsAt": "2026-09-29T00:00:00.000Z",
  "trend": [
    {
      "date": "2026-09-27",
      "value": "94.1"
    },
    {
      "date": "2026-09-28",
      "value": "94.7"
    }
  ],
  "calculation": {
    "numeratorLabel": "On-time delivered orders",
    "numeratorValue": "947",
    "denominatorLabel": "Delivered orders",
    "denominatorValue": "1000"
  },
  "distribution": [
    {
      "name": "Carrier delay",
      "count": 30,
      "percent": "56.6"
    }
  ],
  "analyses": []
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Metric diagnosis

Returns TikTok’s diagnosis of one Shop Performance Score metric: its value, score, status and benchmarks, a daily trend, the calculation behind it (numerator and denominator with labels), how its problem cases split in distribution, and TikTok’s diagnostic text in analyses (empty when TikTok has none).

metricCode is case-insensitive. Current codes are NRR (negative review rate), NBFR (non-buyer-fault return and refund rate), SFCR (seller-fault cancellation rate), OTDR (on-time delivery rate), AHT (after-sales handling time) and IM_DSAT (chat dissatisfaction rate). TikTok may add more. trend_duration_days sets the trend length, 1 to 365, default 30. US shops only. Read live from TikTok.

GET

tik_tok_shop

shop_health

metrics

{metricCode}

Metric diagnosis

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/shop_health/metrics/{metricCode}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "metricCode": "OTDR",
  "dimension": "Fulfillment and logistics",
  "score": "4.1",
  "status": "GOOD",
  "statusText": "Good",
  "value": "94.7",
  "valueUnit": "PERCENT",
  "benchmarks": {
    "excellentThreshold": "95",
    "poorThreshold": "85"
  },
  "evaluateDurationDays": 30,
  "evaluationStartsAt": "2026-08-30T00:00:00.000Z",
  "evaluationEndsAt": "2026-09-29T00:00:00.000Z",
  "trend": [
    {
      "date": "2026-09-27",
      "value": "94.1"
    },
    {
      "date": "2026-09-28",
      "value": "94.7"
    }
  ],
  "calculation": {
    "numeratorLabel": "On-time delivered orders",
    "numeratorValue": "947",
    "denominatorLabel": "Delivered orders",
    "denominatorValue": "1000"
  },
  "distribution": [
    {
      "name": "Carrier delay",
      "count": 30,
      "percent": "56.6"
    }
  ],
  "analyses": []
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

metricCode

string

required

SPS metric code, case-insensitive. TikTok's codes today: NRR (negative review rate), NBFR (non-buyer-fault return and refund rate), SFCR (seller-fault cancellation rate), OTDR (on-time delivery rate), AHT (after-sales handling time), IM_DSAT (chat dissatisfaction rate). TikTok says the list may grow, so other code-shaped values pass through.

Pattern: ^[A-Za-z][A-Za-z0-9_]{1,31}$

Example:

"NRR"

Query Parameters

locale

string

Passed to TikTok to localize names and texts. Absent = TikTok picks the default.

Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$

Example:

"en-US"

trend_duration_days

integer

Days of trend to return. Absent = TikTok's default, 30. TikTok documents no maximum; the 365 cap only keeps junk out.

Required range: 1 <= x <= 365

organization_id

integer

Use the TikTok Shop of this child brand (organization id) of your API key's organization

Response

The metric diagnosis

metricCode

string | null

dimension

string | null

score

string | null

0 to 5, TikTok's decimal string.

status

string | null

EXCELLENT | GOOD | POOR | CRITICAL | NIL. NIL means this metric has not enough data to be scored; it is not a zero score.

statusText

string | null

value

string | null

TikTok's decimal string, in valueUnit.

valueUnit

string | null

PERCENT or HOURS.

benchmarks

object | null

TikTok's own tier thresholds for this metric, in the same unit as value. Higher is better for OTDR, lower is better for the others.

Show child attributes

evaluateDurationDays

integer | null

evaluationStartsAt

string<date-time> | null

evaluationEndsAt

string<date-time> | null

trend

object[]

Show child attributes

calculation

object | null

Show child attributes

distribution

object[]

Show child attributes

analyses

object[]

Show child attributes

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Metric diagnosis

Authorizations

Path Parameters

Query Parameters

Response