TikTok / Social Commerce

Tiktok Shop Analytics

Search TikTok e-commerce store leaderboards via Kalodata and query detailed information for specific stores. Supports viewing high-ranking, high-sales TikTok Shop stores by region, currency, language, and date range, and using shopId to retrieve revenue, sales volume, on-sale product count, self-operated/affiliate/shopping mall channel revenue, and creator collaboration count. Trigger when users mention TikTok store ranking, TikTok shop leaderboard, TikTok top shops, TikTok store ranking, TikTok Shop store ranking, kalodata store search, kalodata store ranking, TikTok store detail, TikTok shop profile, store revenue, store sales, TikTok shop ranking, TikTok shop leaderboard, TikTok top shops, TikTok store ranking, TikTok shop detail, TikTok store detail, kalodata shop search/detail. Even if the user does not explicitly mention "kalodata", trigger this skill whenever their need involves viewing TikTok store leaderboards or detailed data for a specific TikTok store.

post/api/skill-api/v1/skills/tiktok-shop-analytics/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-shop-analytics/run
  • Auth: HTTP bearer

Headers

X-Nexscope-Http-Status'legacy' | 'semantic'

Use semantic for HTTP error statuses on run and task-result requests. Without this header v1 retains legacy status behavior. The JSON envelope is unchanged; code 0 means success or acceptance, not asynchronous completion.

Request body

regionstring

Region/market code, e.g., US. Max length 1000

dateRangestring

Time range, e.g., last7Day (last 7 days), last30Day (last 30 days). Max length 1000

pageNumberinteger

Page number, value range 1-5 (out of range returns errcode 501)

pageSizeinteger

Items per page, value range 5-100

languagestring

Return language, e.g., zh-CN, en-US. Max length 1000

currencystring

Currency unit, e.g., USD. Max length 1000

sortFieldobject

Sort criteria; pass an empty object {} for default rank order when not sorting

shopIdstring

TikTok shop unique ID (string, to avoid large integer precision loss), e.g., 7495514739648989419. Obtainable from the shop_id field in the shop rank response

revenue_rangestring

Revenue / GMV range filter

shop_typestring

Shop type filter: BRAND or RETAILER

category_idstring

Optional category ID dimension

Example request

{
  "sortField": {},
  "dateRange": "last30Day",
  "pageSize": 10,
  "shopId": "7496162162184128712",
  "pageNumber": 1,
  "region": "US"
}

Response

Successful response.

codeinteger required

0 means accepted or successful; nonzero is a platform error.

msgstring nullable required
tsstring required

Epoch milliseconds.

timestring required

Server local time: yyyy-MM-dd HH:mm:ss.

coststring required

Elapsed milliseconds, never credits; -1 outside web requests.

traceIdstring nullable required

Example response

{
  "data": {
    "data": [],
    "costToken": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.