Use this endpoint to power customer-facing management dashboards. It returns scoped usage telemetry for credits spent, pages processed, extraction volume, processing status, review activity, token usage, credit balance, active users, active API keys, and time-series breakdowns.
Authentication
string
required
API key with the usage:read scope.
Access Scope
The endpoint automatically scopes results based on the authenticated user:
Caller
Default scope
Project member
Active project only
Organization admin
Entire organization
Platform admin
Platform-wide unless filters are provided
Regular project members cannot request telemetry for a project other than their active project.
Query Parameters
string
Organization UUID. Non-admin users can only request their own organization.
string
Project UUID. Organization admins can request any project in their organization; regular members can only request their active project.
string
User UUID. Platform admin only.
integer
default:"30"
Relative lookback window when start_date is omitted. Range: 1 to 3660.
string
Inclusive ISO 8601 start timestamp.
string
Inclusive ISO 8601 end timestamp. Defaults to the current time.
string
default:"day"
Time-series grouping. Options: day, week, month.
Response Shape
object
Resolved telemetry scope: platform, organization, project, or user.
object
Resolved date range and time-series grouping.
object
Top-line metrics for documents, credits, pages, tokens, reviews, activity, credit balance, and processing time.
array
Per-period counts for extraction records, completed/failed/pending records, charged documents, pages, credits, and tokens.
object
Breakdowns by status, project, and model/cost tier.
object
Coverage and deduplication metadata, including processing-time coverage.