POSThttps://api.nexscope.ai/api/skill-api/v1/skills/tiktok-product-analytics-api/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-product-analytics-api/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`productId`	`string`	required	TikTok product ID. Example: 1732505564636812173
`region`	`string`	optional	TikTok Shop market region. Example: US
`currency`	`string`	optional	Currency code. Example: USD
`language`	`string`	optional	Response language. Example: en-US

Code example

{
  "region": "US",
  "productId": "1732505564636812173"
}

Response example

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

{
  "data": {
    "data": [
      {
        "product_id": "1732505564636812173",
        "product_name": "Example product",
        "unit_price": 12.99,
        "sales_volumn": 100,
        "revenue": 1000,
        "video_revenue": 600,
        "live_revenue": 300,
        "showcase_revenue": 100,
        "revenue_growth_rate": 12.5,
        "commission_rate": 20,
        "launch_date": "2026-01-01",
        "product_region": "US",
        "product_shop_id": "shop-id",
        "min_price": 9.99,
        "max_price": 19.99,
        "product_review_count": 200,
        "video_number": 25,
        "live_number": 5,
        "creator_number": 10
      }
    ]
  },
  "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

Product-detail data.

Example: []

data.data[]

object

required

Item in data data.

data.data[].product_id

string

optional

TikTok product ID.

Example: 1732505564636812173

data.data[].product_name

string

optional

Product name.

Example: Example product

data.data[].unit_price

number

optional

Current unit price.

Example: 12.99

data.data[].sales_volumn

integer

optional

Estimated sales volume (provider spelling).

Example: 100

data.data[].revenue

number

optional

Total revenue / GMV.

Example: 1000

data.data[].video_revenue

number

optional

Video-channel revenue.

Example: 600

data.data[].live_revenue

number

optional

Livestream revenue.

Example: 300

data.data[].showcase_revenue

number

optional

Showcase revenue.

Example: 100

data.data[].revenue_growth_rate

number

optional

Revenue growth percentage.

Example: 12.5

data.data[].commission_rate

number

optional

Commission percentage.

Example: 20

data.data[].launch_date

string

optional

Product launch date.

Example: 2026-01-01

data.data[].product_region

string

optional

Product market region.

Example: US

data.data[].product_shop_id

string

optional

Owning shop ID.

Example: shop-id

data.data[].min_price

number

optional

Minimum product price.

Example: 9.99

data.data[].max_price

number

optional

Maximum product price.

Example: 19.99

data.data[].product_review_count

integer

optional

Review count.

Example: 200

data.data[].video_number

integer

optional

Associated video count.

Example: 25

data.data[].live_number

integer

optional

Associated livestream count.

Example: 5

data.data[].creator_number

integer

optional

Associated creator count.

Example: 10

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.costToken

integer

optional

Token cost reported by the upstream provider.

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 Product Analytics Detail

What this API does

TikTok Product Analytics Detail

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