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.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
model_name | Annotated[str, Field(description='Name of the Bridge Town model.')] | Yes | — | |
dashboard_name | Annotated[str, Field(description='Unique name for this dashboard.')] | Yes | — | |
chart_type | `Annotated[str | None, Field(description=‘Single-chart type; omit when dashboard_spec is supplied.’)]` | No | None |
model_run_id | `Annotated[str | None, Field(description=‘UUID of a successful run for the single-chart form.’)]` | No | None |
output_key | `Annotated[str | None, Field(description=‘Named output for the single-chart form.’)]` | No | None |
dashboard_spec | `Annotated[DashboardSpec | None, 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.’)]` | No | None |
description | `Annotated[str | None, Field(description=‘Optional description displayed below the dashboard title.’)]` | No | None |
subtitle | Annotated[str, Field(description='Optional subtitle displayed below the title.')] | No | '' | |
currency | `Annotated[str | None, Field(description=‘Optional ISO 4217 currency override; omitted values inherit the model.’)]` | No | None |
locale | `Annotated[str | None, Field(description=‘Optional display-locale override; omitted values inherit the model.’)]` | No | None |
workspace_id | `Annotated[str | None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]` | No | None |
Returns
Section titled “Returns”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.
Example
Section titled “Example”Tool Call
Section titled “Tool Call”{ "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" }}Response
Section titled “Response”{ "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.