Performance score metrics

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

import requests

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

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', 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",
  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"

	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")

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

{
  "metrics": [
    {
      "metricCode": "NRR",
      "metricName": "60-day negative review rate",
      "dimension": "Product satisfaction",
      "score": "4.7",
      "status": "EXCELLENT",
      "statusText": "Excellent",
      "value": "0.97",
      "valueUnit": "PERCENT",
      "topReasonText": null,
      "benchmarks": {
        "excellentThreshold": "0.02",
        "poorThreshold": "0.08"
      },
      "evaluateDurationDays": 60,
      "evaluationStartsAt": "2026-07-31T00:00:00.000Z",
      "evaluationEndsAt": "2026-09-29T00:00:00.000Z"
    }
  ]
}

{
  "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>"
}

Performance score metrics

Lists every Shop Performance Score metric for the shop. Each has metricCode, metricName, dimension, value and valueUnit (PERCENT or HOURS), score (0 to 5), status, TikTok’s benchmarks (excellentThreshold and poorThreshold) and the evaluation window (evaluateDurationDays, evaluationStartsAt, evaluationEndsAt). topReasonText is set when TikTok marks the metric as a key contributor to the score.

status is EXCELLENT, GOOD, POOR, CRITICAL or NIL. NIL means there isn’t enough data to score the metric, not a zero score. TikTok advises using status rather than comparing value to the thresholds yourself, since whether higher or lower is better depends on the metric. US shops only. locale localizes names and text. Read live from TikTok.

GET

tik_tok_shop

shop_health

metrics

Performance score metrics

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

import requests

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

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', 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",
  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"

	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")

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

{
  "metrics": [
    {
      "metricCode": "NRR",
      "metricName": "60-day negative review rate",
      "dimension": "Product satisfaction",
      "score": "4.7",
      "status": "EXCELLENT",
      "statusText": "Excellent",
      "value": "0.97",
      "valueUnit": "PERCENT",
      "topReasonText": null,
      "benchmarks": {
        "excellentThreshold": "0.02",
        "poorThreshold": "0.08"
      },
      "evaluateDurationDays": 60,
      "evaluationStartsAt": "2026-07-31T00:00:00.000Z",
      "evaluationEndsAt": "2026-09-29T00:00:00.000Z"
    }
  ]
}

{
  "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.

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"

organization_id

integer

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

Response

The metric list

metrics

object[]

required

Show child attributes

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Performance score metrics

Authorizations

Query Parameters

Response