TikTok / Social Commerce

Tiktok Product Analytics

Query TikTok e-commerce product leaderboards via Kalodata and query detailed data for specific products. Supports viewing high-ranking/hot-selling products by region, currency, language, and date range, and using productId to retrieve price range, sales, revenue, commission rate, listing/delisting time, and owning shop. Trigger when users mention TikTok product ranking, TikTok bestseller chart, TikTok top products, kalodata product rank, TikTok product detail, TikTok product profile, product price, product sales, TikTok product ranking, TikTok bestseller chart, TikTok top products, kalodata product rank, TikTok product detail, kalodata product detail, product analytics. Even if the user does not explicitly mention "kalodata", trigger this skill whenever their need involves viewing TikTok product leaderboards or detailed data for a specific TikTok product.

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

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-product-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

TikTok Shop market region code, e.g., US. If not specified, defaults to the server default (usually US)

dateRangestring

Relative date range, e.g., last7Day, last30Day

currencystring

Currency code, e.g., USD

languagestring

Return language, e.g., zh-CN, en-US

sortFieldobject

Sort specification object; omitted to use default ranking

pageNumberinteger

Page number, range 1-5

pageSizeinteger

Items per page, range 5-100

productIdstring

TikTok product ID, e.g., 1729508370969629931 (string format, to avoid large integer precision loss), obtainable from the product_id in the product rank response

shop_idstring

Shop ID filter

creator_idstring

Creator ID filter

video_idstring

Return products associated with the specified video

livestream_idstring

Return products associated with the specified livestream

revenue_rangestring

Revenue / GMV range filter

is_affiliatestring

Affiliate filter: PUBLIC_PLAN or NON_AFFILIATE

commission_ratenumber

Affiliate commission rate, e.g. 0.15

is_tts_productinteger

Fully managed product filter: 1 or 0

unit_price_rangestring

Product unit-price range filter

Example request

{
  "sortField": {},
  "dateRange": "last30Day",
  "pageSize": 10,
  "productId": "1732505564636812173",
  "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.