Meet NerdGraph: our GraphQL API

NerdGraph is our GraphQL-format API that lets you query New Relic data and configure some New Relic features. After you sign up for a free New Relic account and install any of our monitoring services, you can get started with NerdGraph.

What is NerdGraph?

NerdGraph is one of several New Relic APIs. NerdGraph is the API we recommend for querying New Relic data and for performing some specific configurations (learn more about features). NerdGraph provides a single API interface for returning data from New Relic's various APIs and microservices. Over time, other configuration capabilities will be added to NerdGraph.

Important

NerdGraph isn't used for data ingest. For that, you'd use our data ingest APIs.

NerdGraph is built using GraphQL, which is an open source API format that allows you to request exactly the data needed, with no over-fetching or under-fetching.

Requirements

Before you get started:

You need a New Relic account, and with that account, you can access your API that you need to include with queries and mutations.
User type and assigned roles can affect your NerdGraph permissions. For more details, see Factors affecting access.

Endpoints

The API endpoint you use depends on your data center region:

Main endpoint: https://api.newrelic.com/graphql
Endpoint for accounts using EU data center: https://api.eu.newrelic.com/graphql

To access the endpoint, you could make calls from your code, use the NerdGraph API explorer, or make a curl command similar to this:

bash

$curl -X POST https://api.newrelic.com/graphql \
>     -H 'Content-Type: application/json' \
>     -H 'API-Key: YOUR_NEW_RELIC_USER_KEY' \
>     -d '{ "query":  "{ requestContext { userId apiKey } }" }'

Use the NerdGraph API explorer

An easy way to experiment with the NerdGraph API is to use the NerdGraph API explorer. For help getting started with this tool, see NerdGraph API explorer tutorial.

NerdGraph functionality

NerdGraph functionality can be broken down into two main categories:

Querying data. You can fetch data for a variety of purposes, including using it in a programmatic workflow, or building a New Relic app for custom data visualizations.
Configuring features. There are a variety of configurations available and more will be added over time. You can do things like add tags, configure workloads, or customize "golden metrics."

You can use NerdGraph to return and configure a wide range of data. One way to see what NerdGraph can do is to start building queries and exploring the schema using the NerdGraph explorer.

These are some of the most commonly used NerdGraph features:

Get data about your monitored entities
Query your data using NRQL (our query language)
Create dashboards

Here are all our available NerdGraph docs:

Topic	Tutorials
Account management	Manage accounts Manage users Manage user groups Create and manage API keys (data ingest keys, and user keys)
Alerts	For New Relic alerts: see all alert-related tutorials For alert correlation: Configuring topology for incident correlation
agents	APM agent configuration
	Install browser agent and configure monitoring Instrument multiple apps using npm package
Change tracking	Track changes using NerdGraph Track changes using the CLI
Dashboards	Create and manage dashboards Dashboards: charts and widgets Export dashboards to other accounts Export dashboards as files Manage externally shared dashboards
Cloud integrations (AWS, Azure, GCP)	Configure cloud integrations
Data management	Convert event data to metric data Data retention Streaming data export Drop data
Distributed tracing	Query distributed tracing data Configure Infinite Tracing
Entities	Get data about monitored entities Understand entity relationships and dependencies (used to build service maps) Query and configure "golden metrics" (important entity metrics)
Log management	Manage log data partitions Manage log parsing rules Manage obfuscation expressions and rules
Mobile monitoring	Create a new mobile app Retrieve an application token Examples of configuring
New Relic apps	Build a New Relic app
Querying and charts	Run NRQL queries of your data Run queries across multiple accounts Asynchronous, longer-running queries
Service levels	Configure and manage service levels
Synthetic monitoring	Manage your monitors
Tags	Add and manage tags
Workloads	View and configure workloads

NerdGraph terminology

The following are terms that originate with GraphQL, the API format NerdGraph uses.

Term	Definition
Queries and mutations	There are two classes of GraphQL operations: Queries are basic requests used only to fetch data. These queries are not static, meaning that you can ask for more data or less data, depending on your needs. For each query, you can specify exactly what data you want to retrieve, as long as it is supported by the schema. Mutations are requests that perform an action, such as creating a resource or changing configuration. Mutations require the keyword `mutation`, as well as the `name` of the mutation.
Type	Data in GraphQL is organized into types. Types can be scalars (like strings, numbers, or booleans) or object types. An object type is a custom type made up of a collection of fields. For example, an object type called `User` may represent a user in a system.
Field	A field represents a piece of information on an object type that can be queried. Fields can be scalars, lists, or objects. For example, a `User` object type could have a string field called `name`.
Interface	An interface is an abstract type that represents a collection of common fields that other object types can `implement`.