New Relic

Integrations are available on Postman Team, Business, and Enterprise plans.

New Relic is an application performance management solution to monitor real-time and trending data for your processes or web apps. You can use Postman's New Relic integration and configure your Postman monitors to send metrics to New Relic.

Setting up a New Relic integration requires you to get an API key from New Relic and configure your Postman Monitors. After you set up the integration, you can view real-time alerts based on the results of your monitors.

If you don't already have a New Relic account, you'll need to create one.

Retrieving your New Relic API Key

  1. Log in to New Relic.
  2. Click your avatar icon in the upper right of the page.
  3. On the user menu, select API keys.
  4. On the API keys page, go to the Not seeing your keys? heading and click Insights Insert Keys. New Relic API keys
  5. Click Show to the right of an existing key and copy it, or click + to create a new key. New Relic API keys

There are multiple API key types in New Relic. The account level API Keys cannot be used for inserting data into New Relic. Insights Insert Keys must be used.

For more information on API Keys in New Relic, see the New Relic documentation.

Configuring New Relic Integration

  1. On your Postman Home page, navigate to Integrations, click Browse All Integrations, and click New Relic in the list of third-party integrations. new relic search
  2. Click Add Integration to create your New Relic integration. new relic add integration
  3. Enter a nickname for the integration.
  4. Select a workspace from the list which contains the monitor you want to use.
  5. Select the monitor you wish to use from the list.
  6. In New Relic API key, enter the API key you copied above.
  7. Select a New Relic region. New Relic offers US and EU region instances. See the New Relic documentation for more information.
  8. Click the Add Integration button.

Viewing data in New Relic

As soon as your monitor runs, Postman will start sending metrics data to New Relic. Once the data is present in New Relic, you can query it and display metrics. In New Relic, click Query your data and click Metrics. You can then search for metrics that begin with postman and form simple queries for the graph displayed. There is also a Query builder for more sophisticated searches.

New Relic metrics

You can also add one or more charts to a dashboard, tracking key metrics over time. For more information see the dashboard documentation in New Relic.

Metrics pushed to New Relic

The following metrics and their values are pushed from Postman to New Relic. Run-level metrics comprise metrics valid for the entire run - the number of errors, for example. Request-level metrics send data for each request within the collection. You can filter to each specific request using the dimensions passed along with the metric.

Metric Description
postman.monitor.request.failedtests The number of failed tests written in the Postman test script for a request.
postman.monitor.request.passedtests The number of passed tests written in the Postman test script for a request.
postman.monitor.request.requestbytes The total number of bytes exchanged in a request.
postman.monitor.request.totallatency The total latency of a request.
postman.monitor.run.errors The total number of errors (such as DNS resolution errors) that occurred while executing the requests.
postman.monitor.run.failedtests The number of failed tests written in the Postman test script, across all requests in a collection.
postman.monitor.run.httpstatus2xx, postman.monitor.run.httpstatus4xx, postman.monitor.run.httpstatus5xx The total count of these returned status codes for your APIs within a collection.
postman.monitor.run.passedtests The number of failed tests written in the Postman test script, across all requests in a collection.
postman.monitor.run.requestcount The number of requests in the collection.
postman.monitor.run.totalbytes The total number of bytes exchanged while running the monitor.
postman.monitor.run.totallatency The total latency after executing all the requests in the collection.
postman.monitor.run.warnings The total number of warnings after executing all the requests in the collection.

Dimension attributes

There are several attributes can be used as dimensions when viewing metrics in New Relic. For example, you could add monitor.name or user.name to show separate lines for the monitor or user shown in the graph. The following example pivots latency data with regions:

New Relic filters

The following attributes can be used as dimensions:

  • region
  • run.id
  • collection.id
  • collection.name
  • monitor.id
  • monitor.name
  • environment.id
  • environment.name
  • request.id
  • request.name
  • user.id
  • user.name