Integrate Postman with Datadog

Datadog is a monitoring service for cloud-scale applications. It combines data from servers, databases, tools, and services to present a unified view of an entire stack. This integration enables you to configure your Postman Monitors to send metrics to Datadog, where you can visualize and compare them with other metrics.

Setting up a Datadog integration requires a Datadog API key and configuring your Postman monitors. After setting up the integration, you can view real-time alerts based on the results of your monitors.

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

Get your Datadog API key

1. Sign in to Datadog. Open your Organization Settings interface, then select API Keys.
2. Create a Datadog API key, then copy it so you can use it later.

Configure your Postman Monitors

1. From the Home page, select Integrations.

2. Select Browse All Integrations, then select Datadog.

3. Select Add Integration for Post monitoring results.

4. Configure your integration settings for Datadog:

   • Nickname - A nickname for the integration.
   • Choose workspace - Select the workspace that has your monitor.
   • Choose Monitor - Select the monitor that sends its results to Datadog.
   • Select Datadog region - Select the Datadog region you want to use.
   • Datadog API Key - Enter your Datadog API key.
   • Select the Send events for completed runs or Send metrics for each run checkboxes if you don't want to send run events or metrics.

5. Select Add Integration to complete the 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 Monitor details in the right sidebar. Learn more about viewing or editing integrations.

View data in Datadog

When your monitor runs, the data starts flowing into Datadog.

Once the data is present in Datadog, you can filter it. You can filter results by monitor name or ID, collection name or UID, user name or ID, and environment name or UID (if present). You can also combine different metrics to create a dashboard.

Forward Postman metrics

Postman can forward a wide array of monitor metrics to Datadog. The following table lists the metric, its type, and the metric's level. For more information about Datadog's metric collection, see Datadog's Metrics documentation.

Metric	Type	Description	Level
postman.monitor.run.errors	Gauge	Total number of errors across all requests in a monitoring run.	Run
postman.monitor.run.failed\_tests	Gauge	Total number of failed tests across all requests in a monitoring run.	Run
postman.monitor.run.passed\_tests	Gauge	Total number of passed tests across all requests in a monitoring run.	Run
postman.monitor.run.request\_count	Gauge	Total number of requests in a monitoring run.	Run
postman.monitor.run.total\_latency	Gauge	The total latency time for all requests in a monitoring run.	Run
postman.monitor.run.http\_status\_2xx	Gauge	Total number of requests in a monitoring run that return an HTTP status code in the 200 range.	Run
postman.monitor.run.http\_status\_4xx	Gauge	Total number of requests in a monitoring run that return an HTTP status code in the 400 range.	Run
postman.monitor.run.http\_status\_5xx	Gauge	Total number of requests in a monitoring run that return an HTTP status code in the 500 range.	Run
postman.monitor.request.latency	Gauge	Latency for each request in a monitoring run.	Request
postman.monitor.request.failed\_tests	Gauge	Number of failed tests for each request in a monitoring run.	Request
postman.monitor.request.passed\_tests	Gauge	Number of passed tests for each request in a monitoring run.	Request
postman.monitor.request.bytes	Gauge	Total bytes sent and received for each request in a monitoring run.	Request

Metrics tags

Postman sends tags to Datadog along with each metric and event. Tags enable you to filter the metric based on various parameters such as monitor name or collection name. The following tags are sent by Postman to Datadog:

Tag	Description
Region	The region from where the monitor is run.
Triggers	What triggered the monitor run: Manual, Webhook, or Scheduled.
Run results	Successful, Failure, Error, or Abort.
Level	The level the metric is captured for: Run or Request.
Status Code	HTTP response code for the request run.
Job ID	Monitor's Job ID.
Request ID	The request identifier.

Update existing integrations

Postman is a Datadog Technology Partner, and Postman's integration is available in Datadog's Integrations. To enable the partnership, the metrics produced by Postman were renamed, as detailed in the Forward Postman metrics section. If you have integrations created before the integration listing on Datadog, you must update them to take advantage of the integration listing.

To update existing integrations, do the following:

1. Go to the Post monitoring results page.

2. Select the integration you want to upgrade.

3. Select Update Now, then select Update Integration on the confirmation box to upgrade the integration.

   

4. Select Confirm.

The updated integration has the following benefits:

• The Postman metrics for the integration are no longer treated as Custom Metrics in Datadog, which means they're free. (Custom metrics on Datadog are charged.)
• Datadog provides a default dashboard that you can use to observe the monitor. Change the monitor_name variable to the monitor for which you want to observe the dashboard.