Skip to content

share_dashboard

Mark a saved dashboard as shared with the model team and return an authenticated app URL. The URL can only be opened by users who already have Bridge Town access to the model — no anonymous or public access is granted. Requires at least Editor access to the model. expires_hours: enforced sharing duration in hours (1–, default 24), or null for an indefinite authenticated share that never expires until explicitly revoked.

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
dashboard_nameAnnotated[str, Field(description='Name of the dashboard to share.')]Yes
expires_hours`Annotated[intNone, Field(description=f’Sharing policy duration in hours (1–{_MAX_EXPIRES_HOURS}, default: 24). Pass null explicitly for an indefinite authenticated share that never expires until revoked. Finite values outside the allowed range raise a validation error.’)]`No24
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • dashboard_id (string)
  • dashboard_name (string)
  • model (string)
  • dashboard_url (string)
  • access_note (string)
  • expires_hours (integer)
  • share_expires_at (string)

See the response example below for the full payload shape.

{
"name": "share_dashboard",
"arguments": {
"model_name": "forecasts",
"dashboard_name": "ARR Bridge",
"expires_hours": 48
}
}
{
"dashboard_id": "77777777-7777-7777-7777-777777777777",
"dashboard_name": "ARR Bridge",
"model": "forecasts",
"dashboard_url": "https://app.bridgetown.builders/dashboards/77777777-7777-7777-7777-777777777777",
"access_note": "This URL requires the recipient to be a collaborator on 'forecasts' with a Bridge Town account. No anonymous access is granted.",
"expires_hours": 48,
"share_expires_at": "2026-03-31T10:00:00+00:00"
}
  • Module: Dashboards
  • Requires authentication via API token or Auth0 JWT.