POST
https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-livestream-analytics/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/tiktok-livestream-analytics/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
region | string | optional | Region/market code, e.g., US. Max length 1000 Example: US |
dateRange | string | optional | Time range, e.g., last7Day (last 7 days), last30Day (last 30 days). Max length 1000 Example: last30Day |
pageNumber | integer | optional | Page number, value range 1-5 (out of range returns errcode 501) Example: 1 |
pageSize | integer | optional | Items per page, value range 5-100 Example: 10 |
language | string | optional | Return language, e.g., zh-CN, en-US. Max length 1000 |
currency | string | optional | Currency unit, e.g., USD. Max length 1000 |
sortField | object | optional | Sort criteria, structure defined by the gateway; pass an empty object {} for default rank order when not sorting Example: {} |
category_id | string | optional | Category ID filter |
shop_id | string | optional | Shop ID filter |
creator_id | string | optional | Creator ID filter |
product_id | string | optional | Product ID filter |
followers_range | string | optional | Creator follower range filter |
livestreamId | string | optional | Target livestream unique ID (camelCase), e.g., 7661409374878878494. Typically obtained from the livestream_id in the livestream rank endpoint. Max length 1000 |
Request example
{
"sortField": {},
"pageNumber": 1,
"dateRange": "last30Day",
"pageSize": 10,
"region": "US"
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | any | required | Data value used by this API operation. |
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
msg | string | null | required | Msg value used by this API operation. |
ts | string | required | Epoch milliseconds. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.data | array | optional | Livestream rank list or livestream detail data Example: [] |
data.costToken | integer | optional | Tokens consumed for this call, fixed at 14000 Example: 1 |
data.data[].livestream_start_time | integer | optional | Livestream start time (epoch milliseconds) Example: 1 |
data.data[].livestream_end_time | integer | optional | Livestream end time (epoch milliseconds) Example: 1 |
data.data[].livestream_duration | integer | optional | Livestream duration (seconds) Example: 1 |
data.data[].livestream_title | string | optional | Livestream title Example: null |
data.data[].livestream_id | string | optional | Livestream unique ID (string, to avoid large integer precision loss); can be used as livestreamId in the detail endpoint Example: example-id |
data.data[].creator_id | string | optional | Creator unique ID (string, to avoid large integer precision loss) Example: example-id |
data.data[].creator_handle | string | optional | Creator account handle Example: null |
data.data[].revenue | string | optional | Total revenue / GMV (in the requested currency; returned as string, e.g., "185590.52") Example: null |
data.data[].unit_price | string | optional | Unit price (in the requested currency; returned as string, e.g., "265.89") Example: null |
data.data[].views | integer | optional | View count Example: 1 |
data.data[].record_type | string | optional | Record type (e.g., SHORT) Example: null |
data.data[].viewers | integer | optional | Viewer count (note: DETAIL uses viewers, RANK uses views) Example: 1 |
data.data[].gpm | number | optional | GMV per mille, number type -- unique to DETAIL, not present in the RANK endpoint Example: 1 |
data.data[].product_number | integer | optional | Product count in the livestream Example: 1 |
data.type | string | optional | Provider-specific render or payload type. Example: null |
data.title | string | optional | Provider-specific response title. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"data": {
"data": [
{
"livestream_start_time": 1,
"livestream_end_time": 1,
"livestream_duration": 1,
"livestream_id": "example-id",
"creator_id": "example-id",
"views": 1,
"viewers": 1,
"gpm": 1,
"product_number": 1
}
],
"costToken": 1
},
"code": 0,
"msg": null,
"ts": "0",
"time": "2026-01-01 00:00:00",
"cost": "-1",
"traceId": null
}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.