overview
Tenant activity, health, quota, and governance rollups.
| Method | Path | Operation ID |
|---|---|---|
| GET | /v1/overview |
getOverview |
GET /v1/overview
Section titled “GET /v1/overview”Operation ID: getOverview
Read reviewed tenant rollups composed with bounded current authoritative state.
Authentication: Authorization: Bearer <API key or console session> (Authentication).
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
range |
query | enum | no | One of: 7d, 30d, 12m. Default "7d". |
Responses
Section titled “Responses”| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | application/json OverviewResponse |
| 401 | The bearer credential is missing, malformed, expired, revoked, or otherwise invalid. Clerk sessions and scoped API keys fail identically and the body never reveals which credential was presented or whether it exists. | application/json HttpErrorResponse |
| 403 | The provider deleted this identity, or the account is deactivated. A valid session cannot authorize a tombstoned identity back into use; an API key must also grant the scope required by the operation, and an operation is not classified by the route/scope policy and is denied by default. An API key restricted to client networks is refused from any other network with the API_KEY_IP_NOT_ALLOWED envelope. |
application/json HttpErrorResponse or ErrorResponse |
| 409 | Just-in-time provisioning conflicted: the verified email belongs to another provisioned account. | application/json HttpErrorResponse |
| 422 | A verified email is unavailable for account provisioning. | application/json HttpErrorResponse |
| 429 | The API key’s own request rate limit was exceeded (API_KEY_RATE_LIMITED). Only keys configured with a rate limit can receive this. Retryable after Retry-After seconds; the refused request consumed no capacity. |
application/json ErrorResponse |
| 503 | Credential verification is unavailable: Clerk session verification is not configured, no API-key pepper is enrolled, or bounded API-key verification is temporarily overloaded. Retryable. | application/json HttpErrorResponse |
200 response fields
Section titled “200 response fields”| Field | Type | Required | Description |
|---|---|---|---|
activity |
array of OverviewActivityBucketResponse | yes | |
as_of |
string | yes | |
attention |
array of OverviewAttentionResponse | yes | |
comparison |
OverviewComparisonResponse or null | yes | |
freshness |
OverviewFreshnessResponse | yes | |
governance |
OverviewGovernanceResponse | yes | |
health |
OverviewHealthResponse | yes | |
jobs |
OverviewJobMetricsResponse | yes | |
media_kinds |
object | yes | |
quota |
OverviewQuotaResponse | yes | |
range |
enum | yes | One of: 7d, 30d, 12m. |
range_end |
string | yes | |
range_start |
string | yes | |
unavailable |
array of OverviewUnavailableResponse | yes | |
verification_outcomes |
object | yes | |
webhooks |
OverviewWebhookResponse | yes |