Metric top items

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

import requests

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

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

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

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": "NRR",
  "itemType": "products",
  "totalCount": 1,
  "items": [
    {
      "productId": "1729384756102938475",
      "productName": "Ceramic mug",
      "imageUrl": "https://p16-oec-va.ibyteimg.com/example.jpg",
      "deliveredOrderCount": 420,
      "negativeOrderCount": 9,
      "topReviewReasons": [
        "Not as described"
      ]
    }
  ]
}

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

Lists the items behind one Shop Performance Score metric. itemType says what the rows are: products for NRR and NBFR, logistics_providers for OTDR, and aftersales_types for AHT. A metric TikTok adds later comes back as unknown. Rows use camelCase keys from TikTok’s fields, for example productId, productName, deliveredOrderCount, negativeOrderCount and topReviewReasons for products.

The list isn’t paged. TikTok has no top items for SFCR or IM_DSAT, so those codes are rejected; use Metric problem details for them. US shops only. Read live from TikTok.

GET

tik_tok_shop

shop_health

metrics

{metricCode}

top_items

Metric top items

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

import requests

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

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

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

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": "NRR",
  "itemType": "products",
  "totalCount": 1,
  "items": [
    {
      "productId": "1729384756102938475",
      "productName": "Ceramic mug",
      "imageUrl": "https://p16-oec-va.ibyteimg.com/example.jpg",
      "deliveredOrderCount": 420,
      "negativeOrderCount": 9,
      "topReviewReasons": [
        "Not as described"
      ]
    }
  ]
}

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

organization_id

integer

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

Response

The top items

metricCode

string

required

itemType

enum<string>

required

Available options:

products,

logistics_providers,

aftersales_types,

unknown

items

object[]

required

totalCount

integer | null

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Meta ads

Metric top items

Authorizations

Path Parameters

Query Parameters

Response