Postman

Postman

Agent Check Agent Check

Linux Mac OS Windows OS Supported

Overview

Postman is an API platform that simplifies the steps of building an API and streamlines collaboration so you can create better APIs-faster.

This integration helps you stay on top of your monitors' health. It enables you to:

  • Analyze the metrics of Postman Monitoring runs in Datadog

  • Generate events for successful and failed monitoring runs.

Setup

You can find detailed instructions on Postman’s documentation page. Postman Integrations require a Postman Team, Business, or Enterprise plan.

Configuration

  1. Generate a Datadog API key.
  2. Sign in to your Postman account and navigate to the Datadog integration.
  3. Select “Add Integration.”
  4. To send your monitor metrics and events to Datadog:
    • Name your new integration.
    • Select the monitor whose data you would like to send to Datadog.
    • Enter your Datadog API key.
    • Select the Datadog region you would like to use.
    • Optionally choose if you want to send events, metrics or both for each run.
  5. Then select “Add Integration” to finish setting up the integration.

Configure Integration

Validation

Data Collected

Metrics

postman.monitor.run.errors
(gauge)
The total number of errors across all requests in a monitoring run
postman.monitor.run.failed_tests
(gauge)
The total number of failed tests across all requests in a monitoring run
postman.monitor.run.passed_tests
(gauge)
Total number of passed tests across all requests in a monitoring run
postman.monitor.run.request_count
(gauge)
Total number of requests in a monitoring run
postman.monitor.run.total_latency
(gauge)
The total latency time for all requests in a monitoring run
postman.monitor.request.bytes
(gauge)
Total bytes sent and received for each request in a monitoring run
postman.monitor.request.failed_tests
(gauge)
Number of failed tests for each request in a monitoring run
postman.monitor.request.passed_tests
(gauge)
Number of passed tests for each request in a monitoring run
postman.monitor.request.latency
(gauge)
The latency for each request in a monitoring 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
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
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

Service Checks

Postman does not include any service checks.

Events

An event is generated each time a monitor runs in Postman. The severity of the event is “Low” if all the tests in the Postman Monitor pass and “Normal” if some of them fail, or if there is an error in execution of any event.

Troubleshooting

Need help? Contact Postman Support.