https://api.nexscope.ai/et/listVideoRankRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/et/listVideoRank |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
date | string | required | List query date, format `YYYY-MM-DD` |
rankType | integer | required | List type: `1` = daily list, `2` = weekly list, `3` = monthly list |
region | string | required | Area code. Optional values: US (United States), ID (Indonesia), TH (Thailand), PH (Philippines), MY (Malaysia), VN (Vietnam), GB (UK), MX (Mexico), SG (Singapore), SA (Saudi Arabia), BR (Brazil), ES (Spain), JP (Japan), DE (Germany), IT (Italy), FR (France) |
videoRankField | integer | required | Video ranking metrics: `1` = Ranking by views, `2` = Ranking by video sales |
productCategoryId | string | optional | Product first-level category ID, used to filter product categories in the product video list |
createdByAi | string | optional | Whether AI video, optional string `true` / `false` |
pageNum | integer | optional | Pagination page number, starting from 1 Example: 1 |
pageSize | integer | optional | Number of items per page. It must be a multiple of 10, with a maximum of 100; the upper limit of a single page in the official interface is 10, and internally it is 10 after multiple pulls per page and then merged Example: 50 |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (31 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status code, 200 indicates success (see error code below for details) |
errmsg | string | optional | Business status description |
total | integer | optional | Number of records |
data | array | optional | List of videos, sorted by `videoRankField` (see video field below for details) |
columns | array | optional | Rendered columns (front-end rendering metadata, the length may be greater than `data`, please refer to `data` for data retrieval) |
type | string | optional | Rendering style |
costToken | integer | optional | Consume token |
videoId | string | optional | Video ID |
officialUrl | string | optional | TikTok official video address |
userId | string | optional | Expert ID |
uniqueId | string | optional | TikTok account ID |
nickName | string | optional | Expert nickname |
avatar | string | optional | Master avatar |
category | string | optional | Expert classification |
videoDesc | string | optional | Video description |
createDate | string | optional | Video release date |
coverUrl | string | optional | Video cover URL |
region | string | optional | area code |
duration | integer | optional | Video duration (seconds) |
createdByAiText | string | optional | AI video or not (yes/no) |
salesFlagText | string | optional | Whether to bring goods video (yes/no) |
productCategoryList | string | optional | Cargo product classification |
videoProducts | string | optional | Video products |
totalCommentsCnt | integer | optional | Number of comments per cycle |
totalDiggCnt | integer | optional | Number of likes per cycle |
totalFavoritesCnt | integer | optional | Number of cycle collections |
totalSharesCnt | integer | optional | Number of cycles shared |
totalViewsCnt | integer | optional | Cycle play volume |
totalVideoSaleCnt | integer | optional | Periodic video sales (estimated) |
totalVideoSaleGmvAmt | number | optional | Cycle video sales GMV (estimate) |
sourceType | string | optional | Product source |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
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.