Skip to content
bucker

API reference

rollups

2 operations. Shapes are sketches of the declared schemas, bounded in depth — the authoritative document is linked from the index.

GET/orgs/{orgSlug}/rollups

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/rollups
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 64

Response 200

{
  rollups: {
    id: string
    version: integer
    ownerCard: string
    shape: "tap" | "recompute" | "materialized_view"
    store: "postgres"
    grains: string[]
    state: "proposed" | "backfilling" | "live" | "stale" | "quality_failed" | "stopped"
    consumersStale: boolean
    watermark: string | null
    freshnessObjectiveSeconds: integer | null
    beforeSampling: boolean
    precision: string
    projectRows: integer | null
  }[]
}

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}/rollups \
  -H "authorization: Bearer $BUCKER_TOKEN"

GET/orgs/{orgSlug}/rollups/{rollupId}

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/rollups/{rollupId}
NameInTypeNotes
orgSlugrequiredpathstringmin length 1, max length 64
rollupIdrequiredpathstringmin length 1, max length 64

Response 200

{
  rollup: {
    id: string
    version: integer
    ownerCard: string
    shape: "tap" | "recompute" | "materialized_view"
    store: "postgres"
    grains: string[]
    state: "proposed" | "backfilling" | "live" | "stale" | "quality_failed" | "stopped"
    consumersStale: boolean
    watermark: string | null
    freshnessObjectiveSeconds: integer | null
    beforeSampling: boolean
    precision: string
    projectRows: integer | null
    sources: string[]
    dimensions: string[]
    measures: {
      name: string
      state: string
      errorBound: string
      isApproximate: boolean
    }[]
    retentionClass: Record<string, string>
    consumers: string[]
    checks: "totals" | "non_negative" | "monotonic" | "freshness"[]
    tolerancePct: number
    writer: {
      kind: "recompute" | "tap" | "existing"
      name: string
    }
    lastCheck: {
      at: string
      ok: boolean
      window: object
      driftPct: number | null
      failedChecks: "totals" | "non_negative" | "monotonic" | "freshness"[]
      overridden: boolean
    } | null
    lastCheckAt: string | null
  }
}

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}/rollups/{rollupId} \
  -H "authorization: Bearer $BUCKER_TOKEN"