View as Markdown
Metabase icon

Metabase ACTION

Create Dashboard

Create a new Dashboard. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Metabase account once, then configure and run Create Dashboard from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "metabase-create-dashboard",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    metabase: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    description: "Description",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Dashboard inputs
Property Type Description
name Name string
The name of the dashboard
Required
description Description string
Description of the dashboard
Optional
collectionId Collection ID string
The ID of the collection
Optional Dynamic
collectionPosition Collection Position integer
Position within the collection (must be greater than zero)
Optional
cacheTtl Cache TTL integer
Cache time-to-live in seconds (must be greater than zero)
Optional
parameters Parameters string[]

Array of parameter definition objects.

Required properties:

  • id (string) - Parameter identifier
  • type (string) - Parameter type (e.g., "date/single", "text", "category")

Optional properties:

  • name (string) - Display name
  • slug (string) - URL-friendly identifier
  • sectionId (string) - Section grouping
  • default - Default value
  • values_source_type (enum) - "static-list", "card", or null
  • values_source_config (object) - Dynamic value configuration with card_id, label_field, value_field, values
  • temporal_units (array) - Time-based parameter units

Example: {"id": "date_param", "type": "date/single", "name": "Date Filter", "slug": "date_filter", "default": "2024-01-01"}

Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
metabase-create-dashboard
Version
0.0.4
App
Metabase
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes