overview
1 operation. Shapes are sketches of the declared schemas, bounded in depth — the authoritative document is linked from the index.
GET/orgs/{orgSlug}/overview
Requires bearerAuth
Which parts of the whole product an organization has data in, for the Overview page: a derived boolean per pillar (errors, logs, traces, APM, metrics, infrastructure, databases, uptime, alerts, product and web analytics, replay, heatmaps, surveys, flags, experiments, LLM and coding agents, cost, security, releases, CI, dashboards, agents, approvals), a few counts capped at 1000, whether the operator has switched on each capability a screen depends on, and where end-user product analytics stands (the amended data terms: pending, needs acceptance, accepted). Every fact is an existence probe of stored rows and none depends on the caller's role; the cost fact needs cost:read and is null, named in omitted, without it. Nothing is written.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
orgSlugrequired | path | string | min length 1 |
Response 200
{
facts: {
projects: boolean
errors: boolean
logs: boolean
traces: boolean
apm: boolean
metrics: boolean
infrastructure: boolean
databases: boolean
uptime: boolean
alerts: boolean
productAnalytics: boolean
webAnalytics: boolean
replay: boolean
heatmaps: boolean
surveys: boolean
flags: boolean
experiments: boolean
llm: boolean
codingAgents: boolean
cost: boolean | null
security: boolean
releases: boolean
ci: boolean
dashboards: boolean
… 2 more
}
counts: {
projects: integer
agents: integer
dashboards: integer
capped: boolean
}
switches: {
apm_red_rollups: boolean
metric_rollups: boolean
collector_pull: boolean
db_monitoring: boolean
product_events: boolean
web_rollups: boolean
interaction_stream: boolean
flag_mirror: boolean
ai_usage_rollup: boolean
ci_ingest: boolean
}
analyticsGate: {
dpa: "amendment_pending" | "acceptance_needed" | "accepted"
enabledProjects: boolean
}
omitted: {
id: "cost"
scope: string
}[]
}Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.
{
error: {
code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
message: string
details?: unknown
requestId?: string
}
}Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.
{
error: {
code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
message: string
details?: unknown
requestId?: string
}
}Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.
{
error: {
code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
message: string
details?: unknown
requestId?: string
}
}Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.
{
error: {
code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
message: string
details?: unknown
requestId?: string
}
}Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.
{
error: {
code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
message: string
details?: unknown
requestId?: string
}
}Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.
{
error: {
code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
message: string
details?: unknown
requestId?: string
}
}Request
curl https://api.bucker.io/orgs/{orgSlug}/overview \
-H "authorization: Bearer $BUCKER_TOKEN"