Metric problem details

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

import requests

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

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}/problems', 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}/problems",
  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}/problems"

	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}/problems")

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",
  "itemType": "orders",
  "totalCount": 12,
  "items": [
    {
      "orderId": "576461413038785752",
      "skuId": "1729384756102938476",
      "productName": "Ceramic mug",
      "expectDeliverTime": "2026-09-20T00:00:00.000Z",
      "actualDeliverTime": "2026-09-23T18:30:00.000Z"
    }
  ],
  "nextPageToken": "2"
}

{
  "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 problem details

Lists the orders or chats that count against one Shop Performance Score metric, one page at a time. itemType is orders for NRR, NBFR, SFCR and OTDR, aftersales_orders for AHT, and chats for IM_DSAT (TikTok masks customerName). Rows use camelCase keys from TikTok’s fields. Ids are strings and *Time fields are ISO 8601.

page_size is up to 50 (TikTok’s default is 10). Pass nextPageToken back as page_token; it is null on the last page. totalCount gives the total. US shops only. Read live from TikTok.

GET

tik_tok_shop

shop_health

metrics

{metricCode}

problems

Metric problem details

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

import requests

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

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}/problems', 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}/problems",
  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}/problems"

	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}/problems")

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",
  "itemType": "orders",
  "totalCount": 12,
  "items": [
    {
      "orderId": "576461413038785752",
      "skuId": "1729384756102938476",
      "productName": "Ceramic mug",
      "expectDeliverTime": "2026-09-20T00:00:00.000Z",
      "actualDeliverTime": "2026-09-23T18:30:00.000Z"
    }
  ],
  "nextPageToken": "2"
}

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

page_size

integer

Rows per page, up to 50. Absent = TikTok's default, 10.

Required range: 1 <= x <= 50

page_token

string

Opaque; the previous page's nextPageToken. Absent = first page.

Required string length: 1 - 512

organization_id

integer

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

Response

One page of problem rows

metricCode

string

required

itemType

enum<string>

required

Available options:

orders,

aftersales_orders,

chats,

unknown

items

object[]

required

totalCount

integer | null

nextPageToken

string | null

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Metric problem details

Authorizations

Path Parameters

Query Parameters

Response