Skip to content

create_dashboard_from_run

Use create_dashboard_from_run for an explicit dashboard request or visual from a successful run. Use present_bsheet_editor for ordinary show/open, publish_repo_dashboard for repo HTML, dashboard_spec for retained tables, and list_dashboards for existing dashboards.

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes—
dashboard_nameAnnotated[str, Field(description='Unique name for this dashboard.')]Yes—
chart_type`Annotated[strNone, Field(description=‘Single-chart type; omit when dashboard_spec is supplied.’)]`NoNone
model_run_id`Annotated[strNone, Field(description=‘UUID of a successful run for the single-chart form.’)]`NoNone
output_key`Annotated[strNone, Field(description=‘Named output for the single-chart form.’)]`NoNone
dashboard_spec`Annotated[DashboardSpecNone, Field(description=‘Versioned composition of up to eight panels bound to authorized retained run tables. Each panel declares its run, output, JSON pointer, column mapping, unit, and existing chart type. Histogram mappings name a numeric values_column, explicit increasing bin_edges, and count or density normalization. Heatmap mappings name row_column, column_column, and value_column; duplicate cells are rejected and missing values remain distinct from zero.’)]`NoNone
description`Annotated[strNone, Field(description=‘Optional description displayed below the dashboard title.’)]`NoNone
subtitleAnnotated[str, Field(description='Optional subtitle displayed below the title.')]No''
currency`Annotated[strNone, Field(description=‘Optional ISO 4217 currency override; omitted values inherit the model.’)]`NoNone
locale`Annotated[strNone, Field(description=‘Optional display-locale override; omitted values inherit the model.’)]`NoNone
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)
  • chart_type (string)
  • model_run_id (string)
  • created (boolean)

See the response example below for the full payload shape.

{
"name": "create_dashboard_from_run",
"arguments": {
"model_name": "forecasts",
"dashboard_name": "Q4 Revenue",
"chart_type": "bar",
"model_run_id": "66666666-6666-6666-6666-666666666666",
"output_key": "quarterly_revenue.json",
"currency": "USD"
}
}
{
"dashboard_id": "77777777-7777-7777-7777-777777777777",
"dashboard_name": "Q4 Revenue",
"model": "forecasts",
"chart_type": "bar",
"model_run_id": "66666666-6666-6666-6666-666666666666",
"created": true
}
  • Module: Dashboards
  • Requires an authenticated Bridge Town session (OAuth) or an API token.