Slide 3 of 3

Build a dashboard learning path

Learning path: Build a dashboard with the Foundation SDK

The following table describes the steps you’ll work through in the learning 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, or in the Grafana Play stack, with an interactive learning experience.

Open in Grafana Cloud Try in Grafana Play
View on website

Script

Time to put these concepts into practice. The learning path walks you through every step: setting up a project, creating a dashboard with the builder pattern, adding panels and queries, exporting the JSON, and verifying the output.

Before you open the path, make sure you have Go or Node.js installed, a terminal, and a code editor. Work through each milestone in order.

Previous Start next section