https://api.nexscope.ai/kd/livestream/rankEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/kd/livestream/rank |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
region | string | opcional | Código de región/mercado, como `US`; longitud máxima 1000 |
dateRange | string | opcional | Plazos, como `last7Day` (últimos 7 días), `last30Day` (últimos 30 días); duración máxima 1000 |
pageNumber | integer | opcional | Número de página, valor 1-5; de retornos fuera de rango `errcode 501` |
pageSize | integer | opcional | Cantidad por página, valor 5-100 |
language | string | opcional | Devolver el idioma, por ejemplo `zh-CN`, `en-US` |
currency | string | opcional | Unidad monetaria, como `USD` |
category_id | string | opcional | Filtro de ID de categoría |
shop_id | string | opcional | Filtro de ID de almacenamiento |
creator_id | string | opcional | Filtrado de ID experto |
product_id | string | opcional | Filtro de ID de producto |
followers_range | string | opcional | Filtrar por número de ventiladores |
sortField | object | opcional | Condiciones de clasificación, la estructura está definida por la puerta de entrada; cuando no se clasifica, pasar un objeto vacío `{}` |
livestreamId | string | obligatorio | Transmisión en vivo ID único, como `7661409374878878494`, normalmente `livestream_id` de la lista; longitud máxima 1000 |
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
No hay un ejemplo de respuesta publicado para esta API. Consulta los campos de respuesta siguientes.
Campos de respuesta
Referencia de campos de respuesta (27 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
errcode | integer | opcional | Business status code, `200` indicates success |
data | array | opcional | Live broadcast list or live broadcast details |
costToken | integer | opcional | The deduction token for this call is fixed to `14000` |
errmsg | string | opcional | Status message, `ok` on success |
livestream_start_time | integer | opcional | Live broadcast start time (epoch milliseconds) |
livestream_end_time | integer | opcional | Live broadcast end time (epoch milliseconds) |
livestream_duration | integer | opcional | Live broadcast duration (seconds) |
livestream_title | string | opcional | Live title |
livestream_id | string | opcional | The unique ID of the live broadcast (a string to avoid the loss of large integer precision), which can be used as the `livestreamId` of the details interface |
creator_id | string | opcional | The unique ID of the expert (string, to avoid loss of large integer precision) |
creator_handle | string | opcional | Expert account handle |
revenue | string | opcional | Total sales/GMV, returned by requested `currency`; returned as a string, such as `"185590.52"` |
unit_price | string | opcional | The unit price of the piece is returned according to the requested `currency`; the return is a string, such as `"265.89"` |
views | integer | opcional | Number of views |
record_type | string | opcional | Record type, such as `SHORT` |
livestream_id | string | opcional | Live broadcast unique ID, consistent with the requested `livestreamId` |
livestream_title | string | opcional | Live title, such as `24 HOUR STREAM` |
creator_id | string | opcional | The unique ID of the expert (string, to avoid loss of large integer precision) |
creator_handle | string | opcional | Expert username/handle, such as `pokepiglt` |
livestream_start_time | integer | opcional | Live broadcast start time, epoch milliseconds |
livestream_end_time | integer | opcional | Live broadcast end time, epoch milliseconds |
livestream_duration | integer | opcional | Live broadcast duration, unit seconds |
record_type | string | opcional | Record type, such as `SHORT` |
viewers | integer | opcional | Number of viewers; use `viewers` for details and `views` for lists |
revenue | number | opcional | Live sales/GMV, returned by requested `currency`; details are of type numeric |
gpm | number | opcional | GMV per mille, GMV per thousand impressions; details exclusive |
product_number | integer | opcional | Number of goods delivered live |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como una clave API ausente o no válida (code 11209, incluida una copia incompleta o dañada) o una sesión web caducada (code 12001), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.