Skip to content
bucker

API reference

stats

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

GET/orgs/{orgSlug}/stats/verification

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/stats/verification
NameInTypeNotes
orgSlugrequiredpathstringmin length 1

Response 200

{
  orgId: string
  orgSlug: string
  generatedAt: string
  verifiedFixRate: {
    key: string
    label: string
    definition: string
    sources: string[]
    numerator: integer
    sampleSize: integer
    rate: number | null
    polarity: "HIGHER_IS_BETTER" | "LOWER_IS_BETTER"
    sufficient: boolean
    publishable: boolean
    statement: string
    window: {
      kind: "LIFETIME" | "AS_OF_NOW"
      since: string | null
      until: string
      watchWindowDays: integer | null
      note: string
    }
  }
  reproFirstFailRate: {
    key: string
    label: string
    definition: string
    sources: string[]
    numerator: integer
    sampleSize: integer
    rate: number | null
    polarity: "HIGHER_IS_BETTER" | "LOWER_IS_BETTER"
    sufficient: boolean
    publishable: boolean
    statement: string
    window: {
      kind: "LIFETIME" | "AS_OF_NOW"
      since: string | null
      until: string
      watchWindowDays: integer | null
      note: string
    }
  }
  inWindowRegressionRate: {
    key: string
    label: string
    definition: string
    sources: string[]
    numerator: integer
    sampleSize: integer
    rate: number | null
    polarity: "HIGHER_IS_BETTER" | "LOWER_IS_BETTER"
    sufficient: boolean
    publishable: boolean
    statement: string
    window: {
      kind: "LIFETIME" | "AS_OF_NOW"
      since: string | null
      until: string
      watchWindowDays: integer | null
      note: string
    }
  }
  reversalDebt: {
    key: string
    label: string
    definition: string
    sources: string[]
    numerator: integer
    sampleSize: integer
    rate: number | null
    polarity: "HIGHER_IS_BETTER" | "LOWER_IS_BETTER"
    sufficient: boolean
    publishable: boolean
    statement: string
    window: {
      kind: "LIFETIME" | "AS_OF_NOW"
      since: string | null
      until: string
      watchWindowDays: integer | null
      note: string
    }
  }
  reversalDebtCounts: {
    open: integer
    overdue: integer
    cleared: integer
    writtenOff: integer
    outstanding: integer
  }
  publishable: boolean
  honesty: {
    minRateSample: integer
    minPublishableSample: integer
    note: 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}/stats/verification \
  -H 'authorization: Bearer $BUCKER_TOKEN'