Section 2 · Foundation SDK fundamentals

Hands-on path to build a dashboard with the Foundation SDK

Estimated time: 2 min

Learning path: Build a dashboard with the Foundation SDK

Path: Build a dashboard with the Foundation SDK

The following table describes the steps you’ll work through in the path.

StepWhat you’ll doOutcome
1. Set up your projectInstall the Foundation SDK and create a projectA working SDK project in Go or TypeScript
2. Create a dashboardUse DashboardBuilder to define a dashboard with UID, tags, and time rangeA complete dashboard definition
3. Add panels and queriesAttach stat and time series panels with data queriesA dashboard with live visualizations
4. Export JSONCall build() and serialize the output to a fileA deployment-ready JSON file
5. Verify the outputInspect the JSON and optionally import into GrafanaConfirmed valid dashboard JSON

Before you start

Have these ready before you open the path:

  • Go 1.21+ or Node.js 18+ installed
  • A terminal and code editor
  • A Grafana Cloud account (optional, for manual import verification)
Learning path

Build a dashboard with the Foundation SDK

Welcome to the learning path that shows you how to define a Grafana dashboard as strongly typed code and export it as deployment-ready JSON.

11 min
Intermediate
Docs & blog posts

Open in Grafana Cloud

Complete this learning path directly in your Grafana Cloud stack with an interactive learning experience.