https://api.nexscope.ai/kd/creator/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/creator/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_ids | integer[] | optional | Category ID list filter |
shop_id | string | optional | Store ID filter |
revenue_range | string | optional | Transaction amount/GMV range filter |
creator_type | string | optional | Expert type filtering |
followers_range | string | optional | Filter by fan count range |
engagement_rate | string | optional | Interaction rate filter |
sortField | object | optional | Sorting conditions; when not sorting, pass the empty object `{}`. The available sorting fields are subject to those actually accepted by the gateway. |
creatorId | string | required | The unique ID of the expert, such as `7153432386608251946`, can be obtained from the `creator_id` of the list response |
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 (43 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status code, `200` indicates success |
data | array | optional | List or detailed data; real responses do not contain `total` |
costToken | integer | optional | The deduction token for this call is usually `14000` |
errmsg | string | optional | Status message, `ok` on success |
creator_nickname | string | optional | Expert nickname |
creator_handle | string | optional | TikTok page name, such as `@based` |
creator_id | string | optional | Expert’s unique ID, string format to avoid loss of precision for large integers |
creator_followers | string | optional | Number of fans, returned as a string |
content_views | string | optional | The total number of views of the content, returned as a string |
sales_volumn | integer | optional | Sales volume, field spelled `volumn` |
revenue | number | optional | Total sales/GMV, returned by requested `currency` |
video_revenue | number | optional | Short video sales |
live_revenue | number | optional | Live streaming sales |
revenue_growth_rate | number | optional | Sales growth rate (%), can be positive or negative |
creator_id | string | optional | Master's unique ID |
creator_nickname | string | optional | Expert nickname |
creator_handle | string | optional | Expert handle |
creator_region | string | optional | Expert area |
creator_status | string | optional | Master status |
creator_bio | string | optional | Profile of the expert |
creator_belonged_shop_id | string | optional | Store ID |
creator_followers | string | optional | Total number of fans, returned as a string |
new_followers | integer | optional | Add new fans in `dateRange` window |
revenue | number | optional | Total Sales/GMV |
video_revenue | number | optional | video sales |
live_revenue | number | optional | Live sales |
sales_volumn | integer | optional | Sales volume, field spelled `volumn` |
unit_price | number | optional | unit price |
video_number | integer | optional | Number of videos in the window |
video_views | integer | optional | Total video views |
video_gpm | number | optional | Video GPM |
live_number | integer | optional | Number of live broadcasts within the window |
live_views | integer | optional | Total live views |
live_gpm | number | optional | Live GPM |
product_number | integer | optional | Number of related products |
shop_number | integer | optional | Number of associated stores |
creator_contact_email | string | optional | Contact email |
creator_contact_ins | string | optional | Instagram Contact |
creator_contact_whatsapp | string | optional | WhatsApp Contact |
creator_contact_facebook | string | optional | Facebook Contact |
creator_contact_tiktok | string | optional | TikTok contact information |
creator_contact_zalo | string | optional | Contact Us |
creator_contact_line | string | optional | Line contact information |
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.