Import, export, and add dashboards and charts

You can use dashboards to visualize and track your system's health, tackle issues, and plan any further steps. Learn to share all that information with your team, customers, or other stakeholders with various import and export options.

Import a dashboard as JSON

You can import a dashboard as JSON when you want to modify an out-of-the-box dashboard at the code level. For example, if you want to create a custom dashboard by merging two existing dashboards together, you can modify a base dashboard's JSON and then import it back to New Relic.

To import a dashboard as JSON:

1. Go to one.newrelic.com > All capabilities > Dashboards.

2. Open an existing dashboard's JSON by click the ... icon, then select Copy JSON.

3. Go back to the Dashboards page.

4. In the top-right corner, click Import dashboard.

5. Paste your JSON code.

6. Choose the account and permission settings for the dashboard. You can't change the account once you've set it, but you can change the permissions at any time.

7. Click Save.

Export a dashboard as PDF

To export your dashboard as a PDF file, in the dashboard's top right corner, click the ... icon and select Export dashboard as PDF.

Consider the following when exporting a dashboard as PDF via the UI:

• Custom visualizations aren't supported.

To export as PDF or PNG with additional options such as custom dimensions and template variable overrides, use the NerdGraph API.

Export dashboards and charts via NerdGraph API

Use the NerdGraph API to programmatically export dashboards and individual chart widgets as snapshot images. The API supports options not available in the UI, including custom dimensions, template variable overrides, and entity filters.

Export a dashboard as PDF or PNG

The dashboardCreateSnapshotUrl mutation generates a snapshot URL for a full dashboard page.

{
  actor {
    entitySearch(
      query: "parentId ='YOUR_DASHBOARD_GUID' AND tags.isDashboardPage = 'true'"
    ) {
      results {
        entities {
          guid
          name
        }
      }
    }
  }
}

Mutation schema:

mutation {
  dashboardCreateSnapshotUrl(
    guid: EntityGuid!
    params: SnapshotUrlInput
  ): String
}

input SnapshotUrlInput {
  timeWindow: SnapshotUrlTimeWindowInput
  display: SnapshotUrlDisplayInput
  variables: [SnapshotUrlVariableInput!]
  filter: String
  format: SnapshotUrlFormat
}

input SnapshotUrlTimeWindowInput {
  beginTime: EpochMilliseconds
  endTime: EpochMilliseconds
  duration: Milliseconds
}

input SnapshotUrlDisplayInput {
  width: Int
  height: Int
}

input SnapshotUrlVariableInput {
  name: String!
  values: [String!]!
}

enum SnapshotUrlFormat {
  PDF
  PNG
}

Parameter reference:

Examples:

mutation {
  dashboardCreateSnapshotUrl(guid: "YOUR_DASHBOARD_PAGE_GUID")
}

mutation {
  dashboardCreateSnapshotUrl(
    guid: "YOUR_DASHBOARD_PAGE_GUID"
    params: { format: PNG, display: { width: 1920, height: 1080 } }
  )
}

mutation {
  dashboardCreateSnapshotUrl(
    guid: "YOUR_DASHBOARD_PAGE_GUID"
    params: {
      variables: [
        { name: "environment", values: ["production"] }
        { name: "region", values: ["us-east-1", "eu-west-1"] }
      ]
      filter: "env = 'production' AND service = 'checkout'"
    }
  )
}

Get a chart image

The dashboardWidgetCreateSnapshotUrl mutation generates a PNG snapshot URL for a single chart widget. The widget does not need to exist on a dashboard — you can define it inline, which makes this useful for generating chart images programmatically.

Mutation schema:

mutation {
  dashboardWidgetCreateSnapshotUrl(
    widget: DeclarativeUiWidget!
  ): WidgetSnapshotResult
}

type WidgetSnapshotResult {
  url: String!
}

The widget parameter accepts a DeclarativeUiWidget — a JSON object with three nested layers:

declarative/widget envelope
└── widget node        ← title and widget-level props
    └── visualization  ← visualization type and configuration

{
  "type": "declarative/widget",
  "version": 1,
  "content": {
    "type": "widget",
    "props": {
      "title": "My Chart Title"
    },
    "content": {
      "type": "visualization",
      "id": "viz.line",
      "props": {
        // visualization-specific config (nrqlQueries, colors, thresholds, etc.)
      }
    }
  }
}

If you're building the widget definition from a dashboard you've exported as JSON, use this field mapping:

Examples:

mutation {
  dashboardWidgetCreateSnapshotUrl(
    widget: {
      version: 1
      type: "declarative/widget"
      content: {
        type: "widget"
        props: { title: "Throughput by environment" }
        content: {
          type: "visualization"
          id: "viz.line"
          props: {
            nrqlQueries: [
              {
                accountIds: [YOUR_ACCOUNT_ID]
                query: "SELECT count(*) FROM Transaction TIMESERIES"
              }
            ]
            legend: { enabled: true }
          }
        }
      }
    }
  ) {
    url
  }
}

mutation {
  dashboardWidgetCreateSnapshotUrl(
    widget: {
      version: 1
      type: "declarative/widget"
      content: {
        type: "widget"
        props: { title: "Error rate" }
        content: {
          type: "visualization"
          id: "viz.billboard"
          props: {
            nrqlQueries: [
              {
                accountIds: [YOUR_ACCOUNT_ID]
                query: "SELECT percentage(count(*), WHERE error IS true) AS 'Error rate' FROM Transaction SINCE 1 hour ago"
              }
            ]
            thresholds: [
              { alertSeverity: "WARNING", value: 1 }
              { alertSeverity: "CRITICAL", value: 5 }
            ]
          }
        }
      }
    }
  ) {
    url
  }
}

Export a chart as CSV

To export a dashboard's table chart as a CSV file, in the chart's top right corner, click ... and select Export as CSV.

Consider the following when exporting a chart as CSV:

• Data always exports in UTC time
• Export doesn't support aggregator functions like average()
• Export doesn't support the COMPARE_WITH clause
• In some scenarios, the UI may perform additional formatting of the data that’s not replicated in the exported CSV which may lead to small discrepancies (such as -1.1E-17 rendering as 0 in the UI but not in the CSV)
• You can't export the results of cross-account queries.

Query and explore charts

For details about what you can do with the charts, see Querying and charting options.