POST
https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-shop-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-shop-analytics/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
region | string | optional | Region/market code, e.g., US. Max length 1000 Example: US |
dateRange | string | optional | Time range, e.g., last7Day (last 7 days), last30Day (last 30 days). Max length 1000 Example: last30Day |
pageNumber | integer | optional | Page number, value range 1-5 (out of range returns errcode 501) Example: 1 |
pageSize | integer | optional | Items per page, value range 5-100 Example: 10 |
language | string | optional | Return language, e.g., zh-CN, en-US. Max length 1000 |
currency | string | optional | Currency unit, e.g., USD. Max length 1000 |
sortField | object | optional | Sort criteria; pass an empty object {} for default rank order when not sorting Example: {} |
category_ids | array | optional | Category ID list filter; results use the selected category dimension Example: [] |
revenue_range | string | optional | Revenue / GMV range filter |
shop_type | string | optional | Shop type filter: BRAND or RETAILER |
category_id | string | optional | Optional category ID dimension |
shopId | string | optional | TikTok shop unique ID (string, to avoid large integer precision loss), e.g., 7495514739648989419. Obtainable from the shop_id field in the shop rank response Example: 7496162162184128712 |
Request example
{
"dateRange": "last30Day",
"sortField": {},
"region": "US",
"pageNumber": 1,
"shopId": "7496162162184128712",
"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 | Shop rank list (rank) or 1-element detail array (detail) Example: [] |
data.costToken | integer | optional | Tokens consumed for this call, fixed at 14000 Example: 1 |
data.data[].rank | integer | optional | Rank position (1 is highest) Example: 1 |
data.data[].shop_name | string | optional | Shop name Example: null |
data.data[].shop_id | string | optional | Shop unique ID (string, to avoid large integer precision loss) Example: example-id |
data.data[].shop_type | string | optional | Shop type (e.g., BRAND) Example: null |
data.data[].revenue | number | optional | Total revenue / GMV (in the requested currency) Example: 1 |
data.data[].sales_volumn | integer | optional | Sales volume (note the field is spelled volumn) Example: 1 |
data.data[].on_sell_product_count | integer | optional | Products currently on sale Example: 1 |
data.data[].unit_price | number | optional | Unit price (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[].self_promotion_revenue | number | optional | Self-operated/self-promoted revenue Example: 1 |
data.data[].affiliate_revenue | number | optional | Affiliate distribution revenue Example: 1 |
data.data[].shopping_mall_revenue | number | optional | Mall revenue Example: 1 |
data.data[].seller_type | string | optional | Shop/seller type (e.g., BRAND) -- detail uses seller_type, not shop_type Example: null |
data.data[].region | string | optional | Region/market (e.g., US) Example: US |
data.data[].product_number | integer | optional | Products currently on sale Example: 1 |
data.data[].self_account_revenue | number | optional | Self-operated/self-broadcast revenue -- detail uses self_account_revenue, not self_promotion_revenue Example: 1 |
data.data[].shoppingmall_revenue | number | optional | Mall revenue (note: no underscore between shopping and mall) Example: 1 |
data.data[].creator_number | integer | optional | Creator collaborations Example: 1 |
data.data[].video_number | integer | optional | Associated video count Example: 1 |
data.data[].live_number | integer | optional | Associated livestream 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": [
{
"rank": 1,
"shop_id": "example-id",
"revenue": 1,
"sales_volumn": 1,
"on_sell_product_count": 1,
"unit_price": 1,
"revenue_growth_rate": 1,
"self_promotion_revenue": 1,
"affiliate_revenue": 1,
"shopping_mall_revenue": 1,
"region": "US",
"product_number": 1,
"self_account_revenue": 1,
"shoppingmall_revenue": 1,
"creator_number": 1,
"video_number": 1,
"live_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.