POSThttps://api.nexscope.ai/api/skill-api/v1/skills/tiktok-video-analytics/run

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-video-analytics/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`region`	`string`	optional	Region/market code, e.g., US Example: US
`dateRange`	`string`	optional	Time range, e.g., last7Day, last30Day Example: last30Day
`pageNumber`	`integer`	optional	Page number, value range 1-5 Example: 1
`pageSize`	`integer`	optional	Items per page, value range 5-100 Example: 10
`language`	`string`

Code example

{
  "pageNumber": 1,
  "region": "US",
  "videoId": "6768504823336815877",
  "sortField": {},
  "dateRange": "last30Day",
  "pageSize": 10
}

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "data": {
    "data": [
      {
        "video_id": "example-id",
        "views": 1,
        "digg_count": 1,
        "comment_count": 1,
        "share_count": 1,
        "revenue": 1,
        "revenue_growth_rate": 1,
        "ad": 1,
        "ad_view_ratio": 1,
        "ad_revenue_ratio": 1,
        "ads_roas": 1,
        "belonged_creator_id": "example-id",
        "sales_volumn": 1,
        "video_gpm": 1,
        "ads_views": 1,
        "ad_cpa": 1,
        "ads_period": 1,
        "duration": 1,
        "product_number": 1
      }
    ],
    "costToken": 1
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

Response fields

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`

Responses

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

Data source, freshness, and limitations

Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.

Name

Type

Required

Description

data

object

required

Data value used by this API operation.

data.data

array

optional

Rank or detail data

Example: []

data.data[]

object

required

Item in data data.

data.data[].video_id

string

optional

Video ID, string format to avoid large integer precision loss

Example: example-id

data.data[].video_title

string

optional

Video title / caption

Example: null

data.data[].views

integer

optional

View count

Example: 1

data.data[].digg_count

integer

optional

Like count

Example: 1

data.data[].comment_count

integer

optional

Comment count

Example: 1

data.data[].share_count

integer

optional

Share count

Example: 1

data.data[].revenue

number

optional

Total revenue / GMV, returned in the requested currency

Example: 1

data.data[].revenue_growth_rate

number

optional

Revenue growth rate (%), can be positive or negative

Example: 1

data.data[].ad

integer

optional

Whether ad/promotional video flag (1=yes)

Example: 1

data.data[].ad_view_ratio

number

optional

Ad view share (%)

Example: 1

data.data[].ad_revenue_ratio

number

optional

Ad revenue share (%)

Example: 1

data.data[].ads_roas

number

optional

Ad ROAS

Example: 1

data.data[].belonged_creator_id

string

optional

Belonged creator ID

Example: example-id

data.data[].belonged_creator_handle

string

optional

Belonged creator username

Example: null

data.data[].creator_debut

string

optional

Creator debut date (YYYY-MM-DD)

Example: null

data.data[].video_region

string

optional

Video region, may be empty string

Example: null

data.data[].sales_volumn

integer

optional

Sales volume, field spelled as volumn

Example: 1

data.data[].video_gpm

number

optional

Video GPM (GMV per thousand views)

Example: 1

data.data[].ads_views

integer

optional

Ad view count

Example: 1

data.data[].ad_cpa

number

optional

Ad CPA

Example: 1

data.data[].ads_period

integer

optional

Ad running period (days)

Example: 1

data.data[].duration

number

optional

Video duration (seconds)

Example: 1

data.data[].product_number

integer

optional

Associated product count in the video

Example: 1

data.costToken

integer

optional

Tokens consumed for this call, typically 14000

Example: 1

data.type

string

optional

Provider-specific render or payload type.

Example: null

data.title

string

optional

Provider-specific response title.

Example: null

data.sourceType

string

optional

Provider-specific source platform type.

Example: null

data.sourceTool

string

optional

Provider-specific source tool name.

Example: null

data.costTime

integer

optional

Execution time reported by the upstream provider.

Example: null

data.page

integer

optional

Current page returned by the upstream provider.

Example: null

data.pageSize

integer

optional

Page size returned by the upstream provider.

Example: null

data.pageItemCount

integer

optional

Item count on the current page returned by the upstream provider.

Example: null

data.totalPage

integer

optional

Total page count returned by the upstream provider.

Example: null

data.dataSnapshotMonth

string

optional

Data snapshot month returned by the upstream provider.

Example: null

Name

Type

Required

Description

data

null

required

Data value used by this API operation.

TikTok Video Analytics

What this API does

TikTok Video Analytics

What this API does

Authentication

Run an API

Example request

Check the response

HTTP status codes

Run this API

Endpoint

Request parameters

Code example

Response example

Response fields

Responses

Data source, freshness, and limitations

MCP

Call a tool

Legacy MCP v1

Online test

Try it

Related APIs

Any of option 1

Any of option 2