Skip to content
bucker

API reference

lineage

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

GET/orgs/{orgSlug}/lineage

Requires bearerAuth

Parameters

Parameters for GET /orgs/{orgSlug}/lineage
NameInTypeNotes
orgSlugrequiredpathstringmin length 1
kindrequiredquery"dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 moreone of "dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 more
idrequiredquerystringmin length 1, max length 128
fieldPathquerystringmin length 1, max length 200
directionquery"up" | "down" | "both"default "down", one of "up" | "down" | "both"
depthqueryintegerdefault 2, min 1, max 3

Response 200

{
  root: {
    kind: "dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 more
    id: string
    fieldPath: string
  }
  direction: "up" | "down" | "both"
  depth: integer
  nodes: {
    kind: "dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 more
    id: string
    name: string
    state: string | null
    projectId: string | null
    owner: {
      principalId: string
      name: string
    } | null
    lastRunAt: string | null
    depth: integer
    side: "up" | "down"
  }[]
  edges: {
    from: {
      kind: "dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 more
      id: string
    }
    to: {
      kind: "dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 more
      id: string
    }
    relation: "reads" | "joins" | "feeds" | "alerts_on" | "exports_to" | "writes"
    fieldPath: string
    match?: "field" | "whole_object"
  }[]
  hiddenPrivate: integer
  hiddenScope: integer
  truncated: boolean
  coverage: {
    declared: "dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 more[]
    undeclared: "dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 more[]
    unwired: "dataset" | "source" | "saved_query" | "widget" | "alert_rule" | "destination" | "export" | "join" | … 2 more[]
  }
  untrustedFields: string[]
  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}/lineage \
  -H "authorization: Bearer $BUCKER_TOKEN"