Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tumban.com/llms.txt

Use this file to discover all available pages before exploring further.

Return lifetime scan counters for the authenticated organization. 
GET /api/v2/org/usage

​
Response

​
total_scans_completed
integer
required
Lifetime count of scans that produced a triage report (status completed or completed_with_partial).
​
total_scans_dropped
integer
required
Lifetime count of scans that did not produce a triage report (failures and timeouts).

​
Example

curl https://api.tumban.com/api/v2/org/usage \
  -H "Authorization: Bearer sk_xxx"

{
  "total_scans_completed": 1284,
  "total_scans_dropped": 7
}

​
Errors

StatusDetail
404Org settings not found.

​
Using the dashboard

The Usage page reads from this and the related usage endpoints to render:
  • Three stat tiles — Total scans (lifetime), Last 30 days, and Today.
  • A bar chart Scans over time with a toggle between Daily (30d) and Monthly (12m). Powered by Get scan timeseries.
  • A donut chart Priority distribution — last 30 days broken down by recommendation. Powered by Get priority distribution.
The captions under each chart show “Updated X min ago · cache” or ”… · live”, indicating whether the response came from the pre-aggregated cache or a live database query.
The Usage page in the dashboard is admin-only. The underlying API endpoints are not role-gated — members can call them directly.