TikTok / Social Commerce

Tiktok Video Search

Search and analyze TikTok video data, filter videos by region, creator, product, category, views, duration, publish time, selling/ad/AI video flags, and return views, likes, comments, shares, favorites, video sales and GMV metrics across 16 TikTok Shop sites. Trigger when users mention TikTok video search, TikTok video list, TikTok promotional videos, TikTok video data, TikTok video views, TikTok video sales, TikTok video analytics, Nexscope video, TikTok video search, TikTok video list, TikTok video analytics, TikTok promotional videos, TikTok video views, TikTok video engagement. Even if the user does not explicitly mention "Nexscope" or "TikTok", trigger this skill whenever their need involves searching or analyzing TikTok video performance metrics by criteria.

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

Request

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

Region code. Options: US (United States), ID (Indonesia), TH (Thailand), PH (Philippines), MY (Malaysia), VN (Vietnam), GB (United Kingdom), MX (Mexico), SG (Singapore), SA (Saudi Arabia), BR (Brazil), ES (Spain), JP (Japan), DE (Germany), IT (Italy), FR (France)

userIdstring

Creator ID filter. Max length 1000

productIdstring

Associated product ID. Max length 1000

productCategoryIdstring

Associated product category ID. Max length 1000

minTotalViewsCntinteger

Video view count filter (minimum)

maxTotalViewsCntinteger

Video view count filter (maximum)

minDurationinteger

Video duration range filter (seconds) - minimum

maxDurationinteger

Video duration range filter (seconds) - maximum

minCreateTimeinteger

Publish time range filter (seconds-level timestamp) - minimum

maxCreateTimeinteger

Publish time range filter (seconds-level timestamp) - maximum

salesFlaginteger

Whether a promotional video: 0=non-promotional video, 1=promotional video

isAdinteger

Whether an ad video: 0=non-ad video, 1=ad video

createdByAistring

Whether AI video, string "true"=AI video, "false"=non-AI video (regex ^(true

videoSortFieldinteger

Sort field: 1=total_digg_cnt (likes), 2=create_time (publish time), 3=total_views_cnt (views)

sortTypeinteger

Sort direction: 0=ascending, 1=descending

pageNuminteger

Page number, starting from 1

pageSizeinteger

Items per page. Must be a multiple of 10, max 100; the third-party API limit is 10 per page, internally the gateway fetches 10 per page in multiple rounds and merges

keywordstring
pageNumberinteger

Example request

{
  "region": "US",
  "pageSize": 10,
  "keyword": "phone case",
  "pageNumber": 1
}

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": {
    "total": 1,
    "data": [],
    "costToken": 1
  }
}

Changes

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