POSThttps://api.nexscope.ai/api/skill-api/v1/skills/tiktok-creator-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-creator-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	Rank requests only: page number 1-5; detail requests are unaffected. Finite numeric strings and optional null remain accepted for compatibility. Example: 1
`pageSize`	`integer`	optional	Rank requests only: items per page 5-100; detail requests are unaffected. Finite numeric strings and optional null remain accepted for compatibility. Example: 10

Code example

{
  "pageNumber": 1,
  "region": "US",
  "creatorId": "68616495085350913",
  "sortField": {},
  "dateRange": "last30Day",
  "pageSize": 10
}

Response example

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

{
  "data": {
    "data": [
      {
        "creator_id": "example-id",
        "sales_volumn": 1,
        "revenue": 1,
        "video_revenue": 1,
        "live_revenue": 1,
        "revenue_growth_rate": 1,
        "creator_belonged_shop_id": "example-id",
        "new_followers": 1,
        "unit_price": 1,
        "video_number": 1,
        "video_views": 1,
        "video_gpm": 1,
        "live_number": 1,
        "live_views": 1,
        "live_gpm": 1,
        "product_number": 1,
        "shop_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[].creator_nickname

string

optional

Creator nickname

Example: null

data.data[].creator_handle

string

optional

TikTok profile name, e.g., @based

Example: null

data.data[].creator_id

string

optional

Creator unique ID, string format to avoid large integer precision loss

Example: example-id

data.data[].creator_followers

string

optional

Follower count, returned as string

Example: null

data.data[].content_views

string

optional

Total content views, returned as string

Example: null

data.data[].sales_volumn

integer

optional

Sales volume, field spelled as volumn

Example: 1

data.data[].revenue

number

optional

Total revenue / GMV, returned in the requested currency

Example: 1

data.data[].video_revenue

number

optional

Short video sales revenue

Example: 1

data.data[].live_revenue

number

optional

Livestream sales revenue

Example: 1

data.data[].revenue_growth_rate

number

optional

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

Example: 1

data.data[].creator_region

string

optional

Creator region

Example: null

data.data[].creator_status

string

optional

Creator status

Example: null

data.data[].creator_bio

string

optional

Creator bio

Example: null

data.data[].creator_belonged_shop_id

string

optional

Belonged shop ID

Example: example-id

data.data[].new_followers

integer

optional

New followers within the dateRange window

Example: 1

data.data[].unit_price

number

optional

Unit price

Example: 1

data.data[].video_number

integer

optional

Video count within the window

Example: 1

data.data[].video_views

integer

optional

Total video views

Example: 1

data.data[].video_gpm

number

optional

Video GPM

Example: 1

data.data[].live_number

integer

optional

Livestream count within the window

Example: 1

data.data[].live_views

integer

optional

Total livestream views

Example: 1

data.data[].live_gpm

number

optional

Livestream GPM

Example: 1

data.data[].product_number

integer

optional

Associated product count

Example: 1

data.data[].shop_number

integer

optional

Associated shop count

Example: 1

data.data[].creator_contact_email

string

optional

Contact email

Example: null

data.data[].creator_contact_ins

string

optional

Instagram contact

Example: null

data.data[].creator_contact_whatsapp

string

optional

WhatsApp contact

Example: null

data.data[].creator_contact_facebook

string

optional

Facebook contact

Example: null

data.data[].creator_contact_tiktok

string

optional

TikTok contact

Example: null

data.data[].creator_contact_zalo

string

optional

Zalo contact

Example: null

data.data[].creator_contact_line

string

optional

Line contact

Example: null

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 Creator Analytics

What this API does

TikTok Creator 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