TikTok / Social Commerce

TikTok Video Rank

Returns normalized public ecommerce research data with a fixed read-only provider path.

post/api/skill-api/v1/skills/tiktok-video-rank/run

Request

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

createdByAi'true' | 'false'
datestring date required
pageNuminteger
pageSizeinteger
productCategoryIdstring
rankType1 | 2 | 3 required
region'US' | 'ID' | 'TH' | 'PH' | 'MY' | 'VN' | 'GB' | 'MX' | 'SG' | 'SA' | 'BR' | 'ES' | 'JP' | 'DE' | 'IT' | 'FR' required
videoRankField1 | 2 required

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

Changes

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