curl -G "https://qcg-api.scanova.io/console/usage/" \
-H "Authorization: Bearer <your_oauth_access_token>" \
-d environment=live \
-d period=month
{
"total_requests": 4820,
"successful_requests": 4761,
"failed_requests": 59
}
API de gestión — Tokens y uso
Estadísticas de uso
GET /console/usage/
GET
/
console
/
usage
/
curl -G "https://qcg-api.scanova.io/console/usage/" \
-H "Authorization: Bearer <your_oauth_access_token>" \
-d environment=live \
-d period=month
{
"total_requests": 4820,
"successful_requests": 4761,
"failed_requests": 59
}
Devuelve los totales de recuento de solicitudes para un entorno de clave determinado a lo largo de una ventana de tiempo móvil. Al igual que los demás endpoints
Un
console/, este reside en el host habitual de la API de Scanova (qcg-api.scanova.io), autenticado con tu token de acceso OAuth del panel.
Las cifras se agregan a través de todas las claves que comparten el
environment indicado en tu cuenta, no de una sola clave. Si quieres el total de por vida de una sola clave, ese es el campo usage_count devuelto por GET /console/token/.Solicitud
GET https://qcg-api.scanova.io/console/usage/
Authorization: Bearer <your_oauth_access_token>
string
requerido
Uno de
sandbox, live, zapier, mcp. Selecciona los registros de qué claves se agregan.string
predeterminado:"week"
Uno de
day, week, month, year. La ventana móvil que termina ahora, sobre la cual se cuentan las solicitudes.curl -G "https://qcg-api.scanova.io/console/usage/" \
-H "Authorization: Bearer <your_oauth_access_token>" \
-d environment=live \
-d period=month
{
"total_requests": 4820,
"successful_requests": 4761,
"failed_requests": 59
}
Campos de la respuesta
integer
Total de solicitudes registradas para las claves de este entorno dentro de la ventana.
integer
Solicitudes que devolvieron un código de estado inferior a
400.integer
Solicitudes que devolvieron un código de estado de
400 o superior.Errores
environment es obligatorio — omitirlo, o pasar un valor fuera de los cuatro indicados arriba, devuelve:
400 Bad Request
{ "environment": ["A valid environment is required."] }
period no válido devuelve:
400 Bad Request
{ "period": ["period must be one of day, week, month, year."] }
Actualmente no se aplican límites de frecuencia en la API de gestión — estos endpoints de uso existen puramente para dar visibilidad, no para vigilar una cuota. Consulta Uso diario para ver una tendencia por día y Uso por endpoint para ver un desglose por ruta.
Relacionado
- Uso diario — las mismas cifras, desglosadas por día del calendario.
- Uso por endpoint — las mismas cifras, desglosadas por ruta y método.
- Crear un token de API — de dónde proviene el campo
usage_countde por vida por clave (distinto de estos totales a nivel de entorno).
Autorizaciones
Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.
Parámetros de consulta
Opciones disponibles:
day, week, month, year Respuesta
200
Usage stats
¿Esta página le ayudó?
⌘I