Introduction to New Relic APIs

New Relic offers a variety of APIs and SDKs you can use to:

Retrieve data from New Relic.
Send data to New Relic.
Adjust settings.

This document provides examples and reference information for our API endpoints. For developer-focused content on how to use and customize New Relic, see developer.newrelic.com.

Tip

To use APIs and SDKs, as well as the rest of our observability platform, join the New Relic family! Sign up to create your free account in only a few seconds. Then ingest up to 100GB of data for free each month. Forever.

NerdGraph (GraphQL)

NerdGraph is New Relic's GraphQL-format API, an efficient and flexible query language that lets you request exactly the data you need, without over-fetching or under-fetching. NerdGraph is the preferred API for querying New Relic data and making a range of feature configurations.

To get started, see Introduction to NerdGraph.

REST APIs by capability

New Relic capabilities, like APM, infrastructure monitoring, or alerts, are often used together, and sometimes they overlap in functionality. This is why multiple APIs may be relevant to each area. Some API functionality will depend on your access to features and data.

Tip

To learn more about different API key types, see Understand New Relic API keys.

API resources for application monitoring include:

Resource	Details
REST API	REST API features include: Retrieve APM data, including metrics, Apdex, error rates, and host data. Report deployments. Change the app name in the UI.
Agent APIs	Every APM language agent has an API that lets you customize the agent's default behavior, including reporting custom data. APM agent APIs include: C SDK API Go agent API Java agent API .NET agent API Node.js agent API PHP agent API Python agent API Ruby agent API
Query API	To query APM data, use the Query API.
Account management APIs	For APIs related to accounts and subscription usage, see the account-related APIs.

The Browser API resources include:

Resource	Details
Browser agent API	Use the Browser agent API for tasks such as: Report custom end user data to browser monitoring. Monitor asynchronous browser activity using SPA API calls. Insert custom data into New Relic dashboards . Manage source maps.
REST API	With the REST API you can: Retrieve page load timing data and throughput. Add or list apps monitored by browser monitoring. Manage alerts conditions for your browser data.
Query API	To retrieve browser monitoring data, use the Query API.
Account management APIs	For APIs related to accounts and subscription usage, see the account-related APIs.

The Infrastructure API resources include:

Resource	Details
Query API	To retrieve infrastructure data, use the Query API. This API can also be used to retrieve subscription usage data.
Infrastructure alert API	To manage your infrastructure alerts, use the Infrastructure alert API.
Integrations SDK	To make your own custom integrations for reporting data to infrastructure monitoring, use the Integrations SDK.
NerdGraph	You can use NerdGraph (our GraphQL API) to query your cloud integration data and make changes to cloud integration settings.

Mobile API resources include:

Resource	Details
Mobile agent APIs	Mobile APIs let you custom instrument your own code and send events to New Relic. See the platform-specific documentation: iOS Android Unity
REST API	Use the REST API for such tasks as: Retrieve a list of monitored apps. Get subscription usage data. Get metric names and data. Get crash count and crash rate data. Manage New Relic alerts conditions for your mobile apps.
Query API	To retrieve Mobile data from New Relic, use the Query API.
Account management APIs	For account-related APIs, see Account APIs.

Synthetics API resources include:

Resource	Details
Synthetics REST API	The Synthetics REST API functionality includes: Create and manage synthetics monitors. Manage synthetics alert notifications. Add labels to monitors, and retrieve monitors with specific labels.
Query API	To retrieve synthetics event data, use the Query API.
Alerts API	To create and manage alert conditions that target synthetics monitors, use the Alerts API.

Resource

Details

Synthetics REST API

The Synthetics REST API functionality includes:

Query API

To retrieve synthetics event data, use the Query API.

Alerts API

To create and manage alert conditions that target synthetics monitors, use the Alerts API.

Telemetry APIs for core data types

We offer several APIs that allow you to get our core data types (metrics, logs, traces, and events) into New Relic without the use of an installed agent.

Data type	Description
Trace API	Send distributed tracing data to New Relic.
Event API	Send event data to New Relic.
Metric API	Send metrics to New Relic from any source (including other telemetry monitoring services).
Log API	Send your log data to New Relic.

Account management, admin, and usage APIs

Like any other New Relic product or service, you want to be confident that your APIs protect you and your customers' data privacy. The following are API resources related to New Relic account administration and usage.

For more information about API capabilities, see the specific New Relic API. For more information about New Relic's security measures, see our security and privacy documentation, or visit the New Relic security website.

Resource	Details
REST API	REST API features include: Find your API keys, account ID, and information needed to use the REST API. Return a list of account users (original user model only). Get SLA report data for browser and application monitoring.
Subscription usage	You can use the Query API to retrieve subscription usage data. This can be helpful to see how usage compares to your current subscription level, or for doing departmental chargebacks.
Partner API	To retrieve information about your New Relic partner account, sub-accounts, and users, use the Partner API.

Resource

Details

REST API

REST API features include:

Find your API keys, account ID, and information needed to use the REST API.
Return a list of account users (original user model only).
Get SLA report data for browser and application monitoring.

Subscription usage

You can use the Query API to retrieve subscription usage data. This can be helpful to see how usage compares to your current subscription level, or for doing departmental chargebacks.

Partner API

To retrieve information about your New Relic partner account, sub-accounts, and users, use the Partner API.

Other APIs

API resources for Insights include:

Resource	Details
Insert events API	To report custom data use the Event insertion API.
Query API	To query your Insights data using NRQL-formatted queries, use the Query API. This API can also be used to retrieve subscription usage data.
Dashboard API	To create, read, update, and delete dashboards, use the Dashboard API.
Other New Relic product APIs	You can also report custom data from other New Relic features. For more information, see the API sections for other products.
NerdGraph	You can use NerdGraph (our GraphQL API) to query data with NRQL.

Use the REST API for New Relic plugins and the API Explorer to:

Get a list of plugins, including their names, IDs, and GUIDs.
List one or more plugin components, their output, and their metric timeslice data.
Developers and New Relic partners can also use New Relic's Plugin API to write an agent in any language that can work directly with the API for plugins. This allows you to send your own metric data to our plugins and view data received from the API in New Relic.

See APIs in action

For more on how you as a developer can optimize your ability to solve problems using New Relic, go to developer.newrelic.com.

For more help

If you need more help, check out these support and learning resources:

Browse the Explorers Hub to get help from the community and join in discussions.
Find answers on our sites and learn how to use our support portal.
Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
Review New Relic's data security and licenses documentation.

Tip

NerdGraph (GraphQL)

REST APIs by capability

Tip

Alerts

APM

Browser monitoring

Infrastructure monitoring

Mobile monitoring

Synthetic monitoring

Telemetry APIs for core data types

Account management, admin, and usage APIs

Other APIs

Insights

Plugins

See APIs in action

For more help

Introduction to New Relic APIs

Tip

NerdGraph (GraphQL)

REST APIs by capability

Tip

APM

Browser monitoring

Infrastructure monitoring

Mobile monitoring

Synthetic monitoring

Telemetry APIs for core data types

Account management, admin, and usage APIs

Other APIs

Insights

Plugins

See APIs in action

.css-s3mb0o{fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;}.css-1bvd50p{width:1rem;height:1rem;fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;}For more help

For more help