View as Markdown
Grafana icon

Grafana ACTION

Get Dashboard

Get the full dashboard model by UID, including all panels, their queries, variables, and configuration. Use Search Dashboards first to find the dashboard UID. The returned model can be modified and saved back with Save Dashboard.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Grafana account once, then configure and run Get 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: "grafana-get-dashboard",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    grafana: { authProvisionId: "apn_xxxxxxx" },
    uid: "Dashboard UID",
  },
})

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.

Get Dashboard inputs
Property Type Description
uid Dashboard UID string
The dashboard UID. Use Search Dashboards to find it.
Required

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
grafana-get-dashboard
Version
0.0.3
App
Grafana
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes