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 per-day or per-month scan counts, broken down by terminal status. Useful for charting throughput over time. 
GET /api/v2/org/usage/scans

​
Query parameters

​
range
string
default:"daily"
daily returns the last 30 days. monthly returns the last 12 months.

​
Response

​
range
string
required
Echoes the range you requested.
​
points
object[]
required
One entry per day or month. Missing periods are filled with zeros so the series is continuous.
​
updated_at
string
required
ISO 8601 UTC timestamp of when the data was generated.
​
source
string
required
cache if served from the warmer cache, live if computed on the fly.

​
points[]

​
date
string
required
ISO 8601 UTC timestamp pinned to T00:00:00Z. For monthly ranges, always the first of the month.
​
total
integer
required
Scans submitted in this period (sum of the status-broken-out fields).
​
completed
integer
required
Scans whose final status was completed.
​
completed_with_partial
integer
required
Scans whose final status was completed_with_partial.
​
failed
integer
required
Scans whose final status was failed.
​
processing
integer
required
Scans still in flight at the time the response was generated.

​
Example

curl "https://api.tumban.com/api/v2/org/usage/scans?range=daily" \
  -H "Authorization: Bearer sk_xxx"

{
  "range": "daily",
  "points": [
    {
      "date": "2026-04-29T00:00:00Z",
      "total": 42,
      "completed": 40,
      "completed_with_partial": 1,
      "failed": 1,
      "processing": 0
    }
  ],
  "updated_at": "2026-04-29T12:00:00Z",
  "source": "cache"
}