Nexscope

Account usage

Page through recorded business calls across your account API keys.

Coste0 credits / call
Probar en línea

Casos de uso de Account usage

Auditoría de llamadas grabadas

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.

Revisar los cargos efectivos

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.

Construir un tablero de cuentas

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.

Preguntas frecuentes sobre Account usage

¿Qué devuelve la consulta de uso?

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.

¿Cuántos créditos cuesta la consulta?

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.

¿Cómo se realiza la consulta?

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.

Ver planes y créditos

Related APIs

API de cuenta

Vista general de la API

Page through recorded business calls across your account API keys.

Endpoint
GET /api/skill-api/v1/account/usage

Autenticación

Enví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_KEY

Ejecutar API

Lee 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.

GET/api/skill-api/v1/account/usage

Ejecutar esta API

Endpoint

MétodoGET
Ruta/api/skill-api/v1/account/usage
AutenticaciónBearer API key
Cuerpo de la solicitudNinguno. Los parámetros opcionales son campos de consulta.

Ejemplo de código

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"

Parámetros de la solicitud

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.

NombreTipoObligatorioDescripción
endTimestringopcional
Optional UTC epoch milliseconds, exclusive. The window must end no later than the request time.
pageNumintegeropcional
One-based page number.
Predeterminado: 1
Mínimo: 1
pageSizeintegeropcional
Rows per page.
Predeterminado: 20
Mínimo: 1
Máximo: 100
startTimestringopcional
Optional UTC epoch milliseconds, inclusive. Enter UTC date and time in the tester; the API receives a decimal millisecond string.

Ejemplo de respuesta

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
}

Campos de respuesta

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.

NombreTipoObligatorioDescripción
codeintegeropcional
Business result code. Only 0 means success, even when HTTP is 200.
coststringopcional
Request processing duration in milliseconds, not credits. -1 means non-Web context.
dataobject | nullopcional
Account API Key business-call usage on success; null on an error.
data.callsobjectopcional
Page of business calls, ordered by record ID descending; free account queries are excluded.
data.calls.currentstringopcional
Current one-based page number, decimal string.
data.calls.pagesstringopcional
Calculated page count, decimal string.
data.calls.recordsarrayopcional
Call records on this page, including failed, rejected, and uncharged calls.
data.calls.records[]objectobligatorio
Elemento de data calls records.
data.calls.records[].apiKeyIdstring | nullopcional
Calling API Key ID, decimal string, or null for a rejected call without an identified key.
data.calls.records[].callResultstringopcional
Business call outcome, including rejected and failed requests.
Permitidos: SUCCESS, FAILED, REJECTED
data.calls.records[].chargeStatusstring | nullopcional
Recorded charge state (for example CHARGED, SKIPPED, FAILED, or NOT_CHARGED), or null.
data.calls.records[].chargedCreditstring | nullopcional
Credits actually charged for this call, decimal string, or null.
data.calls.records[].correlationRequestIdstring | nullopcional
Server-generated ID shared with tool call diagnostics. Use this ID for diagnostic lookup; null for legacy records.
data.calls.records[].createTimestring | nullopcional
Call creation time in UTC epoch milliseconds, or null.
data.calls.records[].idstringopcional
API Key call record ID, decimal string.
data.calls.records[].latencyMsinteger | nullopcional
Call latency in milliseconds, or null.
data.calls.records[].methodstring | nullopcional
Recorded HTTP method, or null.
data.calls.records[].pathstring | nullopcional
Recorded request path, or null.
data.calls.records[].requestIdstring | nullopcional
Original client request ID, or null. This can be reused across calls.
data.calls.sizestringopcional
Requested page size, decimal string.
data.calls.totalstringopcional
Total matching call records, decimal string.
data.endTimestringopcional
Actual exclusive UTC epoch-millisecond window end.
data.grossChargedCreditstringopcional
Windowed sum of actual chargedCredit for CHARGED business calls before refunds; decimal string.
data.observedAtstringopcional
UTC epoch milliseconds when this committed-data read was observed.
data.scopestringopcional
API Key business-call scope, not the full account ledger or JWT activity.
Permitidos: API_KEY_CALLS
data.startTimestringopcional
Actual inclusive UTC epoch-millisecond window start.
msgstring | nullopcional
Optional business message; may be null or omitted on success.
timestringopcional
Server-formatted response time (yyyy-MM-dd HH:mm:ss); its zone is not specified by this field.
traceIdstring | nullopcional
Optional error trace ID; may be null or omitted on success.
tsstringopcional
Server response timestamp, UTC epoch milliseconds as a decimal string.

Respuestas

HTTP 200Comprueba ResponseData.code: solo 0 indica un resultado de negocio correcto. Un código distinto de cero puede llegar con HTTP 200.
HTTP 400Una ventana de tiempo o parámetros de paginación no válidos devuelven un error de parámetros.
HTTP 401 / 403La clave falta, no es válida o no tiene acceso.
HTTP 429Protección de frecuencia compartida para consultas de cuenta; Retry-After: 60 segundos.
HTTP 5xxError 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.

¿Qué puedes hacer con esta API?

Datos explicados y casos de uso prácticos

AI Guide

Question

What usage data can the Account usage API provide, and how might I use it?

AI answer

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 categoryDocumented fieldsWhat the values mean
Call outcomedata.calls.records[].callResult, data.calls.records[].chargeStatusWhether a call succeeded, failed, or was rejected, and its recorded charge state.
Credits chargeddata.calls.records[].chargedCredit, data.grossChargedCreditCredits actually charged for an individual call and the window's gross charged total before refunds. Either per-call value may be null.
Called operationdata.calls.records[].method, data.calls.records[].path, data.calls.records[].createTimeRecorded HTTP method, path, and call time when available.
Key and diagnosticsdata.calls.records[].apiKeyId, data.calls.records[].correlationRequestId, data.calls.records[].requestIdCalling key ID and identifiers useful for matching a call to diagnostics; some values may be null, and a client request ID can be reused.
Performancedata.calls.records[].latencyMsRecorded call duration in milliseconds, when available.
Paging and windowdata.calls.total, data.calls.current, data.calls.pages, data.startTime, data.endTimeCall count, page position, and the inclusive-start/exclusive-end UTC reporting window.
  • Audit which API paths an API Key called during the reported window.
    • Prompt example: “For the last seven days, list the API paths called by my API Key and the recorded call times. Ask me which key to use if more than one is available, and page through the result before summarizing it.”
  • Investigate failed or rejected calls alongside their charge states.
    • Prompt example: “For my API Key over the last seven days, show failed and rejected calls with callResult, chargeStatus, chargedCredit, path, and time where returned. Do not assume every failure was charged.”
  • Reconcile charged call records with data.grossChargedCredit before refunds.
    • Prompt example: “For my API Key over the last seven days, sum the available chargedCredit values by call and compare them with grossChargedCredit for the returned window. Flag null per-call charges and explain any unresolved difference without inventing refunds.”
  • Find a call's diagnostic record using correlationRequestId when present.
    • Prompt example: “I have a correlationRequestId for a call. Ask me for it, then find the matching API Key call and show its path, time, result, charge state, and diagnostic IDs where available.”
  • Review latency for calls with recorded latencyMs values.
    • Prompt example: “For my API Key over the last seven days, show the calls that have latencyMs, ordered from slowest to fastest. Include path, time, and latency, and distinguish missing latency from zero.”