Integrate Postman with New Relic

New Relic is an application performance management solution to monitor real-time and trending data for your processes or web apps. Using Postman's New Relic integration, you can send Postman monitor results to New Relic.

Setting up a New Relic monitor integration requires you to get an API key (Ingest License 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.

You can also view New Relic application performance management (APM) metrics in the Postman API Builder. Viewing APM metrics is a separate integration from sending monitor results to New Relic and uses a different New Relic API key. Learn more about viewing New Relic APM metrics.

Retrieving your New Relic API key

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

To retrieve your Ingest License key from New Relic, do the following:

  1. Sign in to New Relic.
  2. Select your avatar in the upper right corner, then select API keys.
  3. Select the three dots next to the INGEST - LICENSE key and then select Copy.
Get a New Relic Ingest key

There are different types of API keys in New Relic. Make sure to use an Ingest License key for Postman monitor integration. For more information on API Keys in New Relic, see the New Relic API keys documentation.

Configuring New Relic integration

  1. From the Home page select Integrations.

  2. Select Browse All Integrations, and then search for New Relic.

  3. There are two New Relic integrations available in Postman. Next to the option labeled Bring Postman monitor results into New Relic, select Add Integration.

    Select New Relic monitor integration
  4. Enter a Nickname for this integration.

  5. Select the name of the workspace with the monitor you want to use, or enter a new one.

  6. Select the monitor you want to use.

  7. For New Relic API key, enter the Ingest License key you copied from New Relic.

  8. Select a New Relic region. New Relic offers US and EU region instances. See the New Relic data center documentation for more information.

  9. Select Add Integration.

You can view your configured integrations on the Browse Integrations page. You can also view integrations that have been configured for a monitor by opening the monitor and selecting the information icon Information icon in the right sidebar. Learn more about viewing or editing integrations.

Visualize your data with the Postman quickstart

New Relic I/O (Instant Observability) has integrations and quickstarts that bundle observability tools to help you get started with monitoring your stack. The Postman quickstart provides you with an out-of-the-box dashboard with a suggested view for API monitoring.

To visualize your data with the Postman quickstart, do the following:

  1. Go to the Postman quickstart in New Relic I/O, and select + Install quickstart.
  2. If you don't have a New Relic account, follow the sign up instructions to get started for free. Check your email for a link to continue to the next step.
  3. Select an account and select Begin installation.
  4. Under Postman (manual install) select Done if you have already completed the steps in the Configuring New Relic Integration section.
  5. Select See your data.
  6. You can visualize your Postman API data on the New Relic dashboard.

Manually view and query data in New Relic

When your monitor runs, Postman starts sending metrics data to New Relic. Once the data is present in New Relic, you can query and display metrics.

In New Relic, select Metrics and Events and then select Metrics. To view Postman monitor results, search for metrics that begin with postman. You can create queries to customize the graph displayed. New Relic also has a query builder to help you construct advanced searches.

View data in New Relic

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

Metrics pushed to New Relic

Postman pushes the following metrics and their values to New Relic. Run-level metrics are valid for the entire run (for example, the number of errors). Request-level metrics send data for each request in the collection used by the monitor. You can filter for each specific request using the dimensions passed along with the metric.

postman.monitor.request.failedtestsThe number of failed tests written in the Postman post-response script for a request.
postman.monitor.request.passedtestsThe number of passed tests written in the Postman post-response script for a request.
postman.monitor.request.requestbytesThe total number of bytes exchanged in a request.
postman.monitor.request.totallatencyThe total latency of a request. total number of errors (such as DNS resolution errors) that occurred while executing the requests. number of failed tests written in the Postman post-response script, across all requests in a collection.,, total count of these returned status codes for your APIs within a collection. number of failed tests written in the Postman post-response script, across all requests in a collection. number of requests in the collection. total number of bytes exchanged while running the monitor. total latency after executing all the requests in the collection. total number of warnings after executing all the requests in the collection.

Dimension attributes

You can use several attributes as dimensions when viewing metrics in New Relic. For example, add or to show separate lines for the monitor or user in the graph. The following example pivots latency data with regions:

New Relic filters

You can use the following attributes as dimensions:

  • region

Last modified: 2022/11/10