Shop performance score

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

import requests

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

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

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

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

{
  "score": "4.4",
  "tier": "Good",
  "peerPercentile": "82",
  "dimensions": [
    {
      "name": "Product satisfaction",
      "score": "4.4",
      "status": "GOOD",
      "status_text": "Good",
      "weight": "30"
    }
  ],
  "benefits": [
    {
      "benefit_name": "Flash Deal",
      "is_unlocked": true,
      "unlock_score": "2.5"
    }
  ],
  "topIssues": [],
  "topIssuesSummary": null
}

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

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

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

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

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

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

Shop performance score

Returns TikTok’s Shop Performance Score (SPS) overview: the overall score, tier, peerPercentile, per-dimension scores and statuses in dimensions, the seller benefits and which ones the shop has earned, and the topIssues to fix with TikTok’s topIssuesSummary (null when absent).

TikTok serves SPS for US shops only. Pass locale (for example en-US) to localize names and text; TikTok picks a default otherwise. Use Performance score metrics to drill into individual metrics.

GET

tik_tok_shop

shop_health

Shop performance score

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

import requests

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

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

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

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

{
  "score": "4.4",
  "tier": "Good",
  "peerPercentile": "82",
  "dimensions": [
    {
      "name": "Product satisfaction",
      "score": "4.4",
      "status": "GOOD",
      "status_text": "Good",
      "weight": "30"
    }
  ],
  "benefits": [
    {
      "benefit_name": "Flash Deal",
      "is_unlocked": true,
      "unlock_score": "2.5"
    }
  ],
  "topIssues": [],
  "topIssuesSummary": null
}

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

SPS overview: { score, tier, peerPercentile, dimensions, benefits, topIssues, topIssuesSummary }

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Shop performance score

Authorizations

Query Parameters

Response