https://api.nexscope.ai/kd/video/detailRun 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/detail |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
videoId | string | required | TikTok video ID such as `7659161409279806734`, usually `video_id` from the list |
region | string | optional | Region/market code, such as `US` |
dateRange | string | optional | Time range, such as `last7Day`, `last30Day` |
language | string | optional | Return language, for example `zh-CN`, `en-US` |
currency | string | optional | Currency unit, such as `USD` |
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 (24 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status code, `200` indicates success |
data | array | optional | Video details data, usually a 1-element array when successful |
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 |
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 | 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.