/api/skill-api/v1/account/usageEjecutar esta API
Endpoint
| Método | GET |
| Ruta | /api/skill-api/v1/account/usage |
| Autenticación | Bearer API key |
| Cuerpo de la solicitud | Ninguno. Los parámetros opcionales son campos de consulta. |
Page through recorded business calls across your account API keys.
Un administrador de cuenta revisa registrado API llamadas por clave, endpoint y fecha. Los registros de uso devueltos ayudan al administrador a identificar qué llamadas pertenecen al período que se revisa.
Un analista de finanzas revisa los cargos registrados por negocios API El analista comprueba cada estado de llamada devuelta y el campo de crédito cargado en lugar de inferir cargos desde el tiempo de procesamiento.
Un desarrollador llama al punto final de uso de la cuenta desde un panel interno usando un usuario API clave. El panel muestra la información de la cuenta devuelta sin necesidad de una exportación manual.
Devuelve las llamadas a la API registradas para las claves de la cuenta de Nexscope. Los resultados corresponden al período solicitado. Consulta las tablas para conocer el significado de cada campo. Los cargos pendientes pueden aparecer más tarde y cada consulta usa su propia instantánea.
La consulta es gratuita y cuesta 0 créditos. Lee los datos contabilizados sin registrar una llamada de negocio. Puedes usar este GET gratuito con un saldo de cero o negativo. Los dos endpoints de cuenta comparten un límite de 60 solicitudes por cuenta cada 60 segundos.
Envía una solicitud GET a /api/skill-api/v1/account/usage con una clave API de usuario GENERAL en el encabezado Authorization: Bearer. Introduce las fechas y los datos de paginación opcionales como parámetros de consulta. La tabla describe el intervalo de tiempo en UTC. La consulta requiere una clave API de usuario. Los tokens de sesión y las claves de complementos carecen de autorización.
Page through recorded business calls across your account API keys.
GET /api/skill-api/v1/account/usageEnvía una clave de API de usuario GENERAL en la cabecera Authorization Bearer. Los JWT del sitio web, las claves de plugins y los tokens de instalación no pueden llamar a este endpoint. Un saldo cero o negativo no bloquea este GET gratuito.
Authorization: Bearer YOUR_API_KEYLee datos confirmados de la cuenta sin consumir créditos ni añadir una llamada de API de negocio. Ambas consultas comparten un límite de 60 solicitudes por cuenta cada 60 segundos.
/api/skill-api/v1/account/usage| Método | GET |
| Ruta | /api/skill-api/v1/account/usage |
| Autenticación | Bearer API key |
| Cuerpo de la solicitud | Ninguno. Los parámetros opcionales son campos de consulta. |
2026-04-28T20:26:40.000Z → 1777408000000; 2026-05-28T20:26:40.000Z → 1780000000000.
curl -H "Authorization: Bearer YOUR_API_KEY" "https://api.nexscope.ai/api/skill-api/v1/account/usage?startTime=1777408000000&endTime=1780000000000&pageNum=1&pageSize=20"La API usa milisegundos desde la época UTC. En la prueba en línea, introduce la fecha y hora UTC; el área de pruebas convierte esos campos UTC a milisegundos sin usar la zona horaria del navegador. Sin fechas, se usan los 30 días anteriores. Si se proporciona un solo límite, el otro se completa con un intervalo de 30 días o la hora actual. La ventana es [startTime, endTime), no puede superar 180 días ni terminar en el futuro.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
endTime | string | opcional | Optional UTC epoch milliseconds, exclusive. The window must end no later than the request time. |
pageNum | integer | opcional | One-based page number. Predeterminado: 1 Mínimo: 1 |
pageSize | integer | opcional | Rows per page. Predeterminado: 20 Mínimo: 1 Máximo: 100 |
startTime | string | opcional | Optional UTC epoch milliseconds, inclusive. Enter UTC date and time in the tester; the API receives a decimal millisecond string. |
Sobre ResponseData completo. cost es el tiempo de procesamiento en milisegundos, no los créditos cobrados.
{
"code": 0,
"msg": null,
"data": {
"scope": "API_KEY_CALLS",
"observedAt": "1780000000000",
"startTime": "1777408000000",
"endTime": "1780000000000",
"grossChargedCredit": "8",
"calls": {
"records": [
{
"id": "1",
"createTime": "1779999999000",
"apiKeyId": "2",
"path": "/api/skill-api/v1/skills/example/run",
"method": "POST",
"callResult": "SUCCESS",
"chargeStatus": "CHARGED",
"chargedCredit": "8",
"requestId": "example-request",
"correlationRequestId": "example-diagnostic-id",
"latencyMs": 120
}
],
"total": "1",
"size": "20",
"current": "1",
"pages": "1"
}
},
"ts": "1780000000000",
"time": "2026-05-28 20:26:40",
"cost": "13",
"traceId": null
}Los créditos Int64, los ID, los totales de páginas y las horas desde la época son cadenas decimales; los estados enteros y los campos de latencia siguen siendo números JSON. Los campos opcionales pueden ser null o estar ausentes si hay un error.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | opcional | Business result code. Only 0 means success, even when HTTP is 200. |
cost | string | opcional | Request processing duration in milliseconds, not credits. -1 means non-Web context. |
data | object | null | opcional | Account API Key business-call usage on success; null on an error. |
data.calls | object | opcional | Page of business calls, ordered by record ID descending; free account queries are excluded. |
data.calls.current | string | opcional | Current one-based page number, decimal string. |
data.calls.pages | string | opcional | Calculated page count, decimal string. |
data.calls.records | array | opcional | Call records on this page, including failed, rejected, and uncharged calls. |
data.calls.records[] | object | obligatorio | Elemento de data calls records. |
data.calls.records[].apiKeyId | string | null | opcional | Calling API Key ID, decimal string, or null for a rejected call without an identified key. |
data.calls.records[].callResult | string | opcional | Business call outcome, including rejected and failed requests. Permitidos: SUCCESS, FAILED, REJECTED |
data.calls.records[].chargeStatus | string | null | opcional | Recorded charge state (for example CHARGED, SKIPPED, FAILED, or NOT_CHARGED), or null. |
data.calls.records[].chargedCredit | string | null | opcional | Credits actually charged for this call, decimal string, or null. |
data.calls.records[].correlationRequestId | string | null | opcional | Server-generated ID shared with tool call diagnostics. Use this ID for diagnostic lookup; null for legacy records. |
data.calls.records[].createTime | string | null | opcional | Call creation time in UTC epoch milliseconds, or null. |
data.calls.records[].id | string | opcional | API Key call record ID, decimal string. |
data.calls.records[].latencyMs | integer | null | opcional | Call latency in milliseconds, or null. |
data.calls.records[].method | string | null | opcional | Recorded HTTP method, or null. |
data.calls.records[].path | string | null | opcional | Recorded request path, or null. |
data.calls.records[].requestId | string | null | opcional | Original client request ID, or null. This can be reused across calls. |
data.calls.size | string | opcional | Requested page size, decimal string. |
data.calls.total | string | opcional | Total matching call records, decimal string. |
data.endTime | string | opcional | Actual exclusive UTC epoch-millisecond window end. |
data.grossChargedCredit | string | opcional | Windowed sum of actual chargedCredit for CHARGED business calls before refunds; decimal string. |
data.observedAt | string | opcional | UTC epoch milliseconds when this committed-data read was observed. |
data.scope | string | opcional | API Key business-call scope, not the full account ledger or JWT activity. Permitidos: API_KEY_CALLS |
data.startTime | string | opcional | Actual inclusive UTC epoch-millisecond window start. |
msg | string | null | opcional | Optional business message; may be null or omitted on success. |
time | string | opcional | Server-formatted response time (yyyy-MM-dd HH:mm:ss); its zone is not specified by this field. |
traceId | string | null | opcional | Optional error trace ID; may be null or omitted on success. |
ts | string | opcional | Server response timestamp, UTC epoch milliseconds as a decimal string. |
| HTTP 200 | Comprueba ResponseData.code: solo 0 indica un resultado de negocio correcto. Un código distinto de cero puede llegar con HTTP 200. |
| HTTP 400 | Una ventana de tiempo o parámetros de paginación no válidos devuelven un error de parámetros. |
| HTTP 401 / 403 | La clave falta, no es válida o no tiene acceso. |
| HTTP 429 | Protección de frecuencia compartida para consultas de cuenta; Retry-After: 60 segundos. |
| HTTP 5xx | Error del servicio o de una dependencia; reintenta según el estado devuelto. |
grossChargedCredit suma las llamadas de negocio con clave de API cobradas antes de reembolsos, no todo el consumo del libro de cuenta. calls incluye llamadas de negocio fallidas, rechazadas y sin cobro, pero excluye consultas gratuitas de cuenta y actividad JWT.
observedAt indica la hora de lectura. Solo aparecen resultados confirmados; los cargos en curso pueden aparecer más tarde. Las consultas independientes no comparten una instantánea y las páginas de uso pueden cambiar al completarse las llamadas.
Datos explicados y casos de uso prácticos
AI Guide
What usage data can the Account usage API provide, and how might I use it?
This API reports API Key business-call records and charged credits for a time window. It includes successful, failed, rejected, and uncharged calls; free account queries are excluded. Its scope is API_KEY_CALLS, not the full account ledger.
| Data category | Documented fields | What the values mean |
|---|---|---|
| Call outcome | data.calls.records[].callResult, data.calls.records[].chargeStatus | Whether a call succeeded, failed, or was rejected, and its recorded charge state. |
| Credits charged | data.calls.records[].chargedCredit, data.grossChargedCredit | Credits actually charged for an individual call and the window's gross charged total before refunds. Either per-call value may be null. |
| Called operation | data.calls.records[].method, data.calls.records[].path, data.calls.records[].createTime | Recorded HTTP method, path, and call time when available. |
| Key and diagnostics | data.calls.records[].apiKeyId, data.calls.records[].correlationRequestId, data.calls.records[].requestId | Calling key ID and identifiers useful for matching a call to diagnostics; some values may be null, and a client request ID can be reused. |
| Performance | data.calls.records[].latencyMs | Recorded call duration in milliseconds, when available. |
| Paging and window | data.calls.total, data.calls.current, data.calls.pages, data.startTime, data.endTime | Call count, page position, and the inclusive-start/exclusive-end UTC reporting window. |
data.grossChargedCredit before refunds.
correlationRequestId when present.
latencyMs values.