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
}
Management API — Tokens & Usage
Usage statistics
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
}
Returns request-count totals for a given key environment over a rolling time window. Like the other
An invalid
console/ endpoints, this lives on the regular Scanova API host (qcg-api.scanova.io), authenticated with your dashboard OAuth access token.
Figures are aggregated across every key sharing the given
environment on your account, not a single key. If you want a single key’s lifetime total, that’s the usage_count field returned by GET /console/token/.Request
GET https://qcg-api.scanova.io/console/usage/
Authorization: Bearer <your_oauth_access_token>
string
required
One of
sandbox, live, zapier, mcp. Selects which keys’ logs to aggregate.string
default:"week"
One of
day, week, month, year. The rolling window ending now over which requests are counted.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
}
Response fields
integer
Total requests logged for keys in this environment within the window.
integer
Requests that returned a status code below
400.integer
Requests that returned a status code of
400 or above.Errors
environment is required — omitting it, or passing a value outside the four listed above, returns:
400 Bad Request
{ "environment": ["A valid environment is required."] }
period returns:
400 Bad Request
{ "period": ["period must be one of day, week, month, year."] }
No rate limits are currently enforced on the Management API — these usage endpoints exist purely for visibility, not for policing a quota. See Daily usage for a per-day trend and Usage by endpoint for a breakdown by route.
Related
- Daily usage — the same figures, broken out per calendar day.
- Usage by endpoint — the same figures, broken out per route and method.
- Create an API token — where the per-key lifetime
usage_countfield (distinct from these environment-wide totals) comes from.
Authorizations
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.
Query Parameters
Available options:
day, week, month, year Response
200
Usage stats
Was this page helpful?
⌘I