Connection health

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/connection_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/connection_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/connection_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/connection_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/connection_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

{
  "shopId": "7494000000000000123",
  "checkedAt": "2026-09-28T16:00:00.000Z",
  "status": "degraded",
  "isCollecting": true,
  "reasons": [
    {
      "code": "refresh_token_expiring",
      "severity": "degraded",
      "message": "The refresh token expires at 2026-10-02T12:00:00.000Z. Refreshing does not extend it; the seller has to reconnect before then."
    }
  ],
  "region": "US",
  "official": {
    "tokenPresent": true,
    "accessTokenExpiresAt": "2026-10-05T12:00:00.000Z",
    "refreshTokenExpiresAt": "2026-10-02T12:00:00.000Z",
    "refreshTokenExpired": false
  },
  "web": {
    "cookiePresent": true,
    "sessionExpired": false,
    "lastQuotaReadAt": "2026-09-28T15:45:10.000Z",
    "lastQuotaReadAgeSeconds": 890
  },
  "deadShopGated": false,
  "sync": {
    "samples": {
      "lastRun": {
        "status": "ok",
        "startedAt": "2026-09-28T15:00:00.000Z",
        "finishedAt": "2026-09-28T15:04:12.000Z"
      },
      "lastSuccessAt": "2026-09-28T15:04:12.000Z",
      "lastFailureAt": null,
      "lastError": null,
      "quarantined": false
    },
    "orders": {
      "lastRun": {
        "status": "ok",
        "startedAt": "2026-09-28T14:30:00.000Z",
        "finishedAt": "2026-09-28T14:36:40.000Z"
      },
      "lastSuccessAt": "2026-09-28T14:36:40.000Z",
      "lastFailureAt": "2026-09-20T02:30:10.000Z",
      "lastError": "orders sweep timed out",
      "quarantined": false
    }
  },
  "rateLimit": {
    "source": "redis",
    "waitingTiers": []
  }
}

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

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

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

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

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

Connection health

Reports whether the shop is connected to Growi and its data is syncing. status is ok, degraded or broken, and reasons lists why, each with a code, severity and a plain-language message that is safe to show. isCollecting is true when a TikTok data sync finished successfully in the last 24 hours (null when unknown).

The shop is broken when it has no working TikTok connection. It is degraded when, for example, it is connected without TikTok’s official API, the seller’s TikTok authorization has expired or expires within 7 days (the seller has to reconnect), the Seller Center login has expired, or a data sync keeps failing. sync shows the last run, last success and last failure for each data type over the past 30 days. This call doesn’t contact TikTok; it reflects what Growi last saw.

GET

tik_tok_shop

connection_health

Connection health

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/connection_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/connection_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/connection_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/connection_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/connection_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

{
  "shopId": "7494000000000000123",
  "checkedAt": "2026-09-28T16:00:00.000Z",
  "status": "degraded",
  "isCollecting": true,
  "reasons": [
    {
      "code": "refresh_token_expiring",
      "severity": "degraded",
      "message": "The refresh token expires at 2026-10-02T12:00:00.000Z. Refreshing does not extend it; the seller has to reconnect before then."
    }
  ],
  "region": "US",
  "official": {
    "tokenPresent": true,
    "accessTokenExpiresAt": "2026-10-05T12:00:00.000Z",
    "refreshTokenExpiresAt": "2026-10-02T12:00:00.000Z",
    "refreshTokenExpired": false
  },
  "web": {
    "cookiePresent": true,
    "sessionExpired": false,
    "lastQuotaReadAt": "2026-09-28T15:45:10.000Z",
    "lastQuotaReadAgeSeconds": 890
  },
  "deadShopGated": false,
  "sync": {
    "samples": {
      "lastRun": {
        "status": "ok",
        "startedAt": "2026-09-28T15:00:00.000Z",
        "finishedAt": "2026-09-28T15:04:12.000Z"
      },
      "lastSuccessAt": "2026-09-28T15:04:12.000Z",
      "lastFailureAt": null,
      "lastError": null,
      "quarantined": false
    },
    "orders": {
      "lastRun": {
        "status": "ok",
        "startedAt": "2026-09-28T14:30:00.000Z",
        "finishedAt": "2026-09-28T14:36:40.000Z"
      },
      "lastSuccessAt": "2026-09-28T14:36:40.000Z",
      "lastFailureAt": "2026-09-20T02:30:10.000Z",
      "lastError": "orders sweep timed out",
      "quarantined": false
    }
  },
  "rateLimit": {
    "source": "redis",
    "waitingTiers": []
  }
}

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

organization_id

integer

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

Response

The shop's connection health

shopId

string

required

checkedAt

string<date-time>

required

status

enum<string>

required

Worked out from reasons: any broken reason makes it broken, any other reason makes it degraded.

Available options:

ok,

degraded,

broken

isCollecting

boolean | null

required

True when a sync with TikTok finished in the last 24 hours. null when that can't be read.

reasons

object[]

required

Show child attributes

region

string | null

required

official

object | null

required

null when the directory could not be read.

Show child attributes

web

object

required

Show child attributes

deadShopGated

boolean | null

required

True when both of the shop's TikTok tokens expired over an hour ago and there's no Seller Center session, so syncing is paused until the seller reconnects. Rechecked every 5 minutes.

sync

object | null

required

Keyed by sync kind (samples, showcase, content, attribution, segments, videos, orders, gmv_scrape, gmv_creator_products, gmv_parity). Success and failure look back 30 days.

Show child attributes

rateLimit

object | null

required

Show child attributes

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Connection health

Authorizations

Query Parameters

Response