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 you to get an API key from Datadog 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 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.

Retrieving your Datadog API key

  1. Sign in to Datadog. Open your Organization Settings page and select API Keys.

  2. Select + New Key. Create a name for the new API key, then select Create Key.

  3. Copy the new API key so you can use it later.

Configuring Postman Monitors

  1. From the Home page select Integrations.

    Home page and integrations
  2. Select Browse All Integrations.

  3. Search and select Datadog.

    You can select View all for a list of all the integrations created by your team.

  4. Next to Post monitoring results, select Add Integration to start the configuration process.

    Datadog integrations page
  5. To send your monitor metrics and events to Datadog:

    • Nickname - A nickname for your integration.
    • Workspace - The workspace that has your monitor.
    • Monitor - The monitor which will send its results to Datadog.
    • Region - Select the Datadog region you want to use.
    • Datadog API Key - Enter your Datadog API key.
    • Select the checkbox if you want to send events for completed runs.
    • Select the checkbox if you want to send metrics for each run.
  6. 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.

Viewing data in Datadog

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

view in datadog

Once the data is present in Datadog, you can filter it based on the 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.

Forwarding metrics

Postman can forward a wide array of metrics for the specified monitors to Datadog. This table lists the name, type, and level of the metrics, and a description of the metric. For more information on Datadog metric collection, see the Datadog documentation.

Metrics NameTypeDescriptionLevel
postman.monitor.run.errorsGaugeTotal number of errors across all requests in a monitoring runRun
postman.monitor.run.failed\_testsGaugeTotal number of failed tests across all requests in a monitoring runRun
postman.monitor.run.passed\_testsGaugeTotal number of passed tests across all requests in a monitoring runRun
postman.monitor.run.request\_countGaugeTotal number of requests in a monitoring runRun
postman.monitor.run.total\_latencyGaugeThe total latency time for all requests in a monitoring runRun
postman.monitor.run.http\_status\_2xxGaugeTotal number of requests in a monitoring run that return an HTTP status code in the 200 rangeRun
postman.monitor.run.http\_status\_4xxGaugeTotal number of requests in a monitoring run that return an HTTP status code in the 400 rangeRun
postman.monitor.run.http\_status\_5xxGaugeTotal number of requests in a monitoring run that return an HTTP status code in the 500 rangeRun
postman.monitor.request.latencyGaugeLatency for each request in a monitoring runRequest
postman.monitor.request.failed\_testsGaugeNumber of failed tests for each request in a monitoring runRequest
postman.monitor.request.passed\_testsGaugeNumber of passed tests for each request in a monitoring runRequest
postman.monitor.request.bytesGaugeTotal bytes sent and received for each request in a monitoring runRequest

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:

TagDescription
RegionThe region from where the monitor is run
TriggersWhat triggered the monitor run: Manual, Webhook, or Scheduled
Run resultsSuccessful, Failure, Error, or Abort
LevelThe level the metric is captured for: Run or Request
Status CodeHTTP response code for the request run
Job IDMonitor's Job ID
Request IDThe request identifier

Updating existing integrations

Postman is a Datadog Technology Partner, and Postman’s integration is listed on the Datadog Integrations page. To enable the partnership, the metrics being emitted by Postman have been renamed as described in the Forwarding metrics section.

If you have integrations created before the integration listing on Datadog, you must update them to take the 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.

    Datadog upgrade 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. Datadog dashboard

Last modified: 2023/04/21