POST
https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-product-analytics/runRun 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/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
region | string | optional | TikTok Shop market region code, e.g., US. If not specified, defaults to the server default (usually US) Example: US |
dateRange | string | optional | Relative date range, e.g., last7Day, last30Day Example: last30Day |
currency | string | optional | Currency code, e.g., USD |
language | string | optional | Return language, e.g., zh-CN, en-US |
sortField | object | optional | Sort specification object; omitted to use default ranking Example: {} |
category_ids | array | optional | Category ID list filter Example: [] |
shop_id | string | optional | Shop ID filter |
creator_id | string | optional | Creator ID filter |
video_id | string | optional | Return products associated with the specified video |
livestream_id | string | optional | Return products associated with the specified livestream |
revenue_range | string | optional | Revenue / GMV range filter |
is_affiliate | string | optional | Affiliate filter: PUBLIC_PLAN or NON_AFFILIATE |
commission_rate | number | optional | Affiliate commission rate, e.g. 0.15 |
is_tts_product | integer | optional | Fully managed product filter: 1 or 0 |
unit_price_range | string | optional | Product unit-price range filter |
pageNumber | integer | optional | Page number, range 1-5 Example: 1 |
pageSize | integer | optional | Items per page, range 5-100 Example: 10 |
productId | string | optional | TikTok product ID, e.g., 1729508370969629931 (string format, to avoid large integer precision loss), obtainable from the product_id in the product rank response Example: 1732505564636812173 |
Request example
{
"dateRange": "last30Day",
"sortField": {},
"region": "US",
"pageNumber": 1,
"productId": "1732505564636812173",
"pageSize": 10
}Response body
| 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 | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.data | array | optional | Rank or detail data Example: [] |
data.costToken | integer | optional | Tokens consumed for this call, typically 14000 Example: 1 |
data.data[].product_id | string | optional | Product ID (string format, to avoid large integer precision loss); used as productId to query details Example: example-id |
data.data[].product_name | string | optional | Product title Example: null |
data.data[].unit_price | number | optional | Unit price (currency depends on region, e.g., US means USD) Example: 1 |
data.data[].sales_volumn | integer | optional | Sales volume (units). Note: the field name is spelled sales_volumn (as-is, not volume). Use this exact name when extracting with jq/ConvertFrom-Json Example: 1 |
data.data[].revenue | number | optional | Total revenue (GMV), = video_revenue + live_revenue + showcase_revenue Example: 1 |
data.data[].video_revenue | number | optional | Video channel revenue Example: 1 |
data.data[].live_revenue | number | optional | Livestream channel revenue Example: 1 |
data.data[].showcase_revenue | number | optional | Showcase/display channel revenue Example: 1 |
data.data[].revenue_growth_rate | number | optional | Revenue growth rate (percentage, e.g., 27.94 means 27.94%) Example: 1 |
data.data[].commission_rate | number | optional | Commission rate (percentage, e.g., 25.0 means 25%; not basis points) Example: 1 |
data.data[].launch_date | string | optional | Launch date (YYYY-MM-DD) Example: 2026-01-01 |
data.data[].product_region | string | optional | Product region/market (e.g., us) Example: null |
data.data[].product_shop_id | string | optional | Belonged shop ID Example: example-id |
data.data[].pri_cate_id | string | optional | Primary category ID Example: example-id |
data.data[].sec_cate_id | string | optional | Secondary category ID Example: example-id |
data.data[].ter_cate_id | string | optional | Tertiary category ID Example: example-id |
data.data[].min_price | number | optional | Minimum price (in the requested currency) Example: 1 |
data.data[].max_price | number | optional | Maximum price (in the requested currency) Example: 1 |
data.data[].product_review_count | integer | optional | Product review count Example: 1 |
data.data[].delivery_type | string | optional | Delivery method (e.g., local) Example: null |
data.data[].video_number | integer | optional | Associated video count Example: 1 |
data.data[].live_number | integer | optional | Associated livestream count Example: 1 |
data.data[].shopping_mall_revenue | number | optional | Mall revenue (in the requested currency) Example: 1 |
data.data[].creator_number | integer | optional | Associated creator count 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 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"data": {
"data": [
{
"product_id": "example-id",
"unit_price": 1,
"sales_volumn": 1,
"revenue": 1,
"video_revenue": 1,
"live_revenue": 1,
"showcase_revenue": 1,
"revenue_growth_rate": 1,
"commission_rate": 1,
"launch_date": "2026-01-01",
"product_shop_id": "example-id",
"pri_cate_id": "example-id",
"sec_cate_id": "example-id",
"ter_cate_id": "example-id",
"min_price": 1,
"max_price": 1,
"product_review_count": 1,
"video_number": 1,
"live_number": 1,
"shopping_mall_revenue": 1,
"creator_number": 1
}
],
"costToken": 1
},
"code": 0,
"msg": null,
"ts": "0",
"time": "2026-01-01 00:00:00",
"cost": "-1",
"traceId": null
}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.