Translate Grafana dashboards to New Relic dashboards

Convert your existing Grafana dashboards into New Relic native dashboards using our translation REST API. Whether you're looking to consolidate your observability tools, migrate your entire monitoring setup to New Relic, or simply test out New Relic dashboards alongside your existing Grafana setup, this API makes it easier to get started.

This API uses New Relic PromQL translation logic to translate your queries. To see a list of supported PromQL features and functions, see PromQL features support guide.

Prerequisites

Before using this API, you'll need:

A New Relic user API key
Your New Relic account ID

Make a request to the API endpoints

To translate a Grafana dashboard to a New Relic dashboard, send a POST request to the appropriate endpoint for your region with the dashboard you want to translate in the body of the request.

US: https://prometheus-api.newrelic.com/api/v1/translate/dashboard/grafana
EU: https://prometheus-api.eu.newrelic.com/api/v1/translate/dashboard/grafana
JP: https://prometheus-api.jp.newrelic.com/api/v1/translate/dashboard/grafana

API reference

Authentication

All API calls require a user API key. Include this key in the api-key header of your request.

Request body

The request body must be a JSON object with the following format:

{
  "accountId": int[optional],
  "dashboard": object[required]
}

Where dashboard is the Grafana dashboard JSON object you want to translate. The accountId field is optional — if omitted, the translated dashboard will query data from the account of the user making the request.

Response format

The API returns a JSON object containing the translated New Relic dashboard:

{
  "dashboard": {
    "name": "Translated Dashboard",
    "permissions": "PUBLIC_READ_WRITE",
    "pages": [...]
    }
}

Examples

bash

$export NR_USER_KEY="YOUR_NEW_RELIC_USER_API_KEY"
$export JSON_FILE="my_grafana_dashboard.json"
$export TRANSLATOR_ENDPOINT="<TRANSLATOR_ENDPOINT_FOR_YOUR_REGION>" # (see API endpoints section above)
$
$curl -s ${TRANSLATOR_ENDPOINT} \
>-H "Content-Type: application/json" \
>-H "api-key:${NR_USER_KEY}" \
>-d "$(jq -c -n --slurpfile dashboard "${JSON_FILE}" '{dashboard: $dashboard[0]}')" \
>| jq '.dashboard'

If you want to override the account of which your dashboard will query data from, you can include accountId: int in the payload of the request. This will make all queries in the dashboard query data from the specified account.

bash

$export NR_USER_KEY="YOUR_NEW_RELIC_USER_API_KEY"
$export ACCOUNT_ID="YOUR_NEW_RELIC_STAGING_ACCOUNT_ID"
$export JSON_FILE="my_grafana_dashboard.json"
$export TRANSLATOR_ENDPOINT="<TRANSLATOR_ENDPOINT_FOR_YOUR_REGION>" # (see API endpoints section above)
$
$curl -s ${TRANSLATOR_ENDPOINT} \
>-H "Content-Type: application/json" \
>-H "api-key:${NR_USER_KEY}" \
>-d "$(jq -c -n --arg accountId "$ACCOUNT_ID" --slurpfile dashboard "$JSON_FILE" '{accountId: $accountId, dashboard: $dashboard[0]}')" \
>| jq '.dashboard'

ヒント

For more information on how to use NerdGraph and to find your regional endpoint, see Introduction to New Relic NerdGraph.

bash

$export NR_USER_KEY="YOUR_NEW_RELIC_USER_API_KEY"
$export ACCOUNT_ID="YOUR_NEW_RELIC_STAGING_ACCOUNT_ID"
$export JSON_FILE="my_grafana_dashboard.json"
$export TRANSLATOR_ENDPOINT="<TRANSLATOR_ENDPOINT_FOR_YOUR_REGION>" # (see API endpoints section above)
$export NERDGRAPH_ENDPOINT="<NERDGRAPH_ENDPOINT_FOR_YOUR_REGION>"
$
$NR_DASHBOARD=$(curl -s ${TRANSLATOR_ENDPOINT} \
>-H "Content-Type: application/json" \
>-H "api-key:${NR_USER_KEY}" \
>-d "$(jq -c -n --arg accountId "$ACCOUNT_ID" --slurpfile dashboard "$JSON_FILE" '{accountId: $accountId, dashboard: $dashboard[0]}')" \
>| jq '.dashboard')
$
$
$curl -X POST ${NERDGRAPH_ENDPOINT} \
>-H "Content-Type: application/json" \
>-H "API-Key: ${NR_USER_KEY}" \
>-d '{
$"query": "mutation($accountId: Int!, $dashboard: DashboardInput!) { dashboardCreate(accountId: $accountId, dashboard: $dashboard) { entityResult { guid name } errors { description } } }",
$"variables": {
$"accountId": '${ACCOUNT_ID}',
$"dashboard": '${NR_DASHBOARD}'
$}
$}'

Troubleshoot translation errors

When the translator encounters issues that prevent complete translation of a widget or query, it creates "Action Items" — special Markdown widgets that explain what went wrong and suggest fixes.

The following is a list of Grafana widget types that we support and their corresponding New Relic widget types.

Grafana widget type	New Relic widget type
singlestat (deprecated)	BILLBOARD
stat	BILLBOARD
bargauge	BILLBOARD
gauge	BULLET
table	TABLE
graph (line chart)	LINE
graph (area chart)	AREA
text	MARKDOWN
piechart	PIE
heatmap	HEATMAP
bar-chart	BAR
barchart	BAR

Translate Grafana dashboards to New Relic dashboards

Prerequisites

Make a request to the API endpoints

API reference

Authentication

Request body

Response format

Examples

Example: Basic API call to translate a Grafana dashboard

Example: Translate dashboard with account ID override

Example: Upload translated dashboard to New Relic using NerdGraph API

ヒント

Troubleshoot translation errors

Grafana and New Relic widget types

Translate Grafana dashboards to New Relic dashboards

Prerequisites .css-21sua1{background:none;border:none;width:0;padding:0;}

Make a request to the API endpoints

API reference

Authentication

Request body

Response format

Examples

Example: Translate dashboard with account ID override

Example: Upload translated dashboard to New Relic using NerdGraph API

Troubleshoot translation errors

Grafana and New Relic widget types

Prerequisites