Metabase Dashboards Get
Certified
Get a Metabase dashboard
Metabase Dashboards Get
Get a Metabase dashboard
Retrieves a dashboard (GET /api/dashboard/{id}) from Metabase. The cards are returned in cards and left out of dashboard.
type: io.kestra.plugin.metabase.dashboards.GetExamples
Get details and embedded cards for a dashboard
id: metabase_get_dashboard
namespace: company.team
tasks:
- id: get
type: io.kestra.plugin.metabase.dashboards.Get
url: "{{ secret('METABASE_URL') }}"
apiKey: "{{ secret('METABASE_API_KEY') }}"
dashboardId: 5
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-metabase --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
Properties
dashboardId *integerstring
Dashboard ID
The ID of the Metabase dashboard to retrieve.
url *string
Metabase server URL
Base URL of the Metabase instance, for example https://metabase.example.com or http://localhost: 3000.
apiKey string
Metabase API key
API key sent in the x-api-key header. Requires Metabase v0.47 or later.
Set exactly one authentication mode: apiKey, sessionToken, or both username and password.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150password string
Metabase password
Password used to open a session through POST /api/session. Must be set together with username.
requestTimeout string
PT1MHTTP request timeout
Connect and read timeout for each HTTP request made to Metabase. Defaults to 60 seconds. Does not limit the task duration.
sessionToken string
Metabase session token
Session token sent in the X-Metabase-Session header.
Set exactly one authentication mode: apiKey, sessionToken, or both username and password.
username string
Metabase username
Username or email used to open a session through POST /api/session. Must be set together with password.
The session is closed with DELETE /api/session when the task ends.
Outputs
cards array
Dashboard cards
The cards (dashcards) placed on the dashboard.
dashboard object
Dashboard details
Metadata of the Metabase dashboard, without its cards.