https://api.nexscope.ai/kd/video/rankRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/kd/video/rank |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
region | string | optional | Region/market code, such as `US` |
dateRange | string | optional | Time range, such as `last7Day`, `last30Day` |
pageNumber | integer | optional | Page number, value 1-5 |
pageSize | integer | optional | Quantity per page, value 5-100 |
language | string | optional | Return language, for example `zh-CN`, `en-US` |
currency | string | optional | Currency unit, such as `USD` |
category_id | string | optional | Category ID filter |
shop_id | string | optional | Store ID filter |
creator_id | string | optional | Expert ID filtering |
product_id | string | optional | Product ID filter |
revenue_range | string | optional | GMV ranges such as `1-100`, `>1000`, `<100` |
followers_range | string | optional | Filter by number of fans |
ads_roas | number | optional | Advertising ROAS filtering |
sortField | object | optional | GMV sort criteria, such as `{"field":"revenue","type":"DESC"}` |
videoId | string | required | TikTok video ID, such as `7659161409279806734`, can be obtained from `video_id` in the list response |
Code example
{
"currency": "USD",
"dateRange": "last7Day",
"pageNumber": 1,
"pageSize": 10,
"region": "US",
"revenue_range": "1-100",
"sortField": {
"field": "revenue",
"type": "DESC"
}
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
Response field reference (39 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status code, `200` indicates success |
data | array | optional | List or detailed data |
costToken | integer | optional | The deduction token for this call is usually `14000` |
errmsg | string | optional | Status message, `ok` on success |
video_id | string | optional | Video ID, string format to avoid loss of precision for large integers |
video_title | string | optional | Video title/copywriting |
views | integer | optional | Play volume |
digg_count | integer | optional | Number of likes |
comment_count | integer | optional | Number of comments |
share_count | integer | optional | Number of shares |
revenue | number | optional | Total sales/GMV, returned by requested `currency` |
revenue_growth_rate | number | optional | Sales growth rate (%), can be positive or negative |
ad | integer | optional | Whether to use advertising/product video logo, 1=yes |
ad_view_ratio | number | optional | Advertisement playback proportion (%) |
ad_revenue_ratio | number | optional | Proportion of sales generated by advertising (%) |
ads_roas | number | optional | Advertising ROAS |
belonged_creator_id | string | optional | Belonging expert ID |
belonged_creator_handle | string | optional | User name of the expert |
creator_debut | string | optional | Date of entry of the expert (`YYYY-MM-DD`) |
video_id | string | optional | Video ID, string format to avoid loss of precision for large integers |
video_title | string | optional | Video title/copywriting |
video_region | string | optional | Video region, may be an empty string |
belonged_creator_id | string | optional | Attribution expert ID |
belonged_creator_handle | string | optional | Attribution expert username |
views | integer | optional | Play volume |
digg_count | integer | optional | Number of likes |
comment_count | integer | optional | Number of comments |
share_count | integer | optional | Number of shares |
revenue | number | optional | Total Sales/GMV |
sales_volumn | integer | optional | Sales volume, field spelled `volumn` |
video_gpm | number | optional | Video GPM, or GMV per thousand plays |
ad | integer | optional | Whether to run ads, 1=with ads, 0=without ads |
ads_views | integer | optional | Number of ad plays |
ads_roas | number | optional | Advertising ROAS |
ad_cpa | number | optional | Advertising CPA |
ad_view_ratio | number | optional | Advertisement playback proportion (%) |
ads_period | integer | optional | Advertising period (days) |
duration | number | optional | Video duration (seconds) |
product_number | integer | optional | Number of video related products |
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.