View as Markdown
Metabase icon

Metabase ACTION

Export Query with Format

Execute a saved question/card with parameters and export results in the specified format (CSV, JSON, XLSX, or API). See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Metabase account once, then configure and run Export Query with Format 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-export-query-with-format",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    metabase: { authProvisionId: "apn_xxxxxxx" },
    cardId: 10,
    exportFormat: "Export Format",
  },
})

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.

Export Query with Format inputs
Property Type Description
cardId Card ID integer
The ID of the card (question)
Required Dynamic
exportFormat Export Format string
The format to export the query results in
Required
formatRows Format Rows boolean
Whether to format rows for display
Optional
pivotResults Pivot Results boolean
Whether to pivot the results
Optional
parameters Parameters string[]
Query parameters as JSON objects. Each parameter should be a JSON string with the parameter properties. Example: {"type": "category", "target": ["variable", ["template-tag", "parameter_name"]], "value": "your_value"}
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-export-query-with-format
Version
0.0.1
App
Metabase
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes