POST
https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-video-rank/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-video-rank/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
date | string | required | Ranking date in YYYY-MM-DD format Example: 2026-08-26 |
rankType | integer | required | Ranking type: 1, 2, or 3 Example: 1 |
region | string | required | TikTok market region code Example: US |
videoRankField | integer | required | Video ranking field: 1 or 2 Example: 1 |
productCategoryId | string | optional | Optional product category ID |
createdByAi | string | optional | Filter AI-created videos using the string true or false |
pageNum | integer | optional | Page number, starting at 1 Example: 1 |
pageSize | integer | optional | Page size from 10 to 100 in multiples of 10 Example: 10 |
Request example
{
"date": "2026-08-26",
"pageSize": 10,
"rankType": 1,
"videoRankField": 1,
"region": "US",
"pageNum": 1
}Response body
No required request fields are defined for this API.
Response example
Direct response payload. No extra wrapper is added.
{
"videos": [
{
"region": "US",
"totalViewsCnt": 1,
"videoId": "example-video-id"
}
],
"total": 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.