Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
A dashboard in Grafana is represented by a JSON object, which stores metadata of its dashboard. Dashboard metadata includes dashboard properties, metadata from panels, template variables, panel queries, etc.
To view the JSON of a dashboard:
Navigate to a dashboard.
In the top navigation menu, click the Dashboard settings (gear) icon.
Click JSON Model.
JSON fields
When a user creates a new dashboard, a new dashboard JSON object is initialized with the following fields:
Note
In the following JSON, id is shown as null which is the default value assigned to it until a dashboard is saved. Once a dashboard is saved, an integer value is assigned to the id field.
annotations metadata, see annotations for how to add them
refresh
auto-refresh interval
schemaVersion
version of the JSON schema (integer), incremented each time a Grafana update brings changes to said schema
version
version of the dashboard (integer), incremented each time the dashboard is updated
panels
panels array, see below for detail.
Panels
Panels are the building blocks of a dashboard. It consists of data source queries, type of graphs, aliases, etc. Panel JSON consists of an array of JSON objects, each representing a different panel. Most of the fields are common for all panels but some fields depend on the panel type. Following is an example of panel JSON of a text panel.