POST
https://claw-callback.nexscope.ai/api/skill-api/v1/skills/tiktok-product-analytics/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://claw-callback.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: {} |
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
{
"productId": "1732505564636812173",
"pageNumber": 1,
"region": "US",
"sortField": {},
"dateRange": "last30Day",
"pageSize": 10
}Response body
Returns the documented upstream API response directly without an additional wrapper.
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status code, 200 indicates success Example: 1 |
data | array | optional | Rank or detail data Example: [] |
costToken | integer | optional | Tokens consumed for this call, typically 14000 Example: 1 |
errmsg | string | optional | Status message, ok on success |
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[].product_name | string | optional | Product title |
data[].unit_price | number | optional | Unit price (currency depends on region, e.g., US means USD) Example: 1 |
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[].revenue | number | optional | Total revenue (GMV), = video_revenue + live_revenue + showcase_revenue Example: 1 |
data[].video_revenue | number | optional | Video channel revenue Example: 1 |
data[].live_revenue | number | optional | Livestream channel revenue Example: 1 |
data[].showcase_revenue | number | optional | Showcase/display channel revenue Example: 1 |
data[].revenue_growth_rate | number | optional | Revenue growth rate (percentage, e.g., 27.94 means 27.94%) Example: 1 |
data[].commission_rate | number | optional | Commission rate (percentage, e.g., 25.0 means 25%; not basis points) Example: 1 |
data[].launch_date | string | optional | Launch date (YYYY-MM-DD) Example: 2026-01-01 |
data[].product_region | string | optional | Product region/market (e.g., us) |
data[].product_shop_id | string | optional | Belonged shop ID Example: example-id |
data[].pri_cate_id | string | optional | Primary category ID Example: example-id |
data[].sec_cate_id | string | optional | Secondary category ID Example: example-id |
data[].ter_cate_id | string | optional | Tertiary category ID Example: example-id |
data[].min_price | number | optional | Minimum price (in the requested currency) Example: 1 |
data[].max_price | number | optional | Maximum price (in the requested currency) Example: 1 |
data[].product_review_count | integer | optional | Product review count Example: 1 |
data[].delivery_type | string | optional | Delivery method (e.g., local) |
data[].video_number | integer | optional | Associated video count Example: 1 |
data[].live_number | integer | optional | Associated livestream count Example: 1 |
data[].shopping_mall_revenue | number | optional | Mall revenue (in the requested currency) Example: 1 |
data[].creator_number | integer | optional | Associated creator count Example: 1 |
code | string | optional | Provider-specific status code. |
msg | string | optional | Provider-specific status message. |
message | string | optional | Provider-specific message. |
type | string | optional | Provider-specific render or payload type. |
title | string | optional | Provider-specific response title. |
sourceType | string | optional | Provider-specific source platform type. |
sourceTool | string | optional | Provider-specific source tool name. |
costTime | integer | optional | Execution time reported by the upstream provider. |
page | integer | optional | Current page returned by the upstream provider. |
pageSize | integer | optional | Page size returned by the upstream provider. |
pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. |
totalPage | integer | optional | Total page count returned by the upstream provider. |
dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. |
Response example
Direct response payload. No extra wrapper is added.
{
"errcode": 1,
"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
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 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.