Skip to main content
GET
get_usage_overview

Authorizations

X-API-Key
string
header
required

Query Parameters

window
enum<string>
default:7d

Rolling window ending today (UTC): 7, 30, or 90 days.

Available options:
7d,
30d,
90d

Response

Successful Response

Dashboard figures for a rolling 7d / 30d / 90d window.

Prior-period fields are the same-length window immediately before period_start. The frontend derives the percentage / delta; this response only reports the two raw values. Average processing time is null when the window has no succeeded document-operation jobs.

active_jobs
integer
required
avg_processing_seconds
number | null
required
avg_processing_seconds_prior
number | null
required
documents_processed
integer
required
documents_processed_prior
integer
required
period_end
string<date>
required
period_start
string<date>
required
queued_jobs
integer
required
series
UsageOverviewPoint · object[]
required
window
enum<string>
required
Available options:
7d,
30d,
90d