Monitoring your APIs
Postman Monitoring helps you to stay up to date on the health and performance of your APIs. Within a matter of seconds, you can set up Postman's monitoring service and integrate it into your API development pipeline.
Contents
What is monitoring?
Monitoring is a way to stay up to date on the health and performance of your APIs. Postman's built-in monitoring service helps you consolidate an additional step in your API development lifecycle.
Postman monitors are based on collections. Monitors will run through each request in your collection, similar to the collection runner. You can also attach a corresponding environment with variables you'd like to utilize during each collection run.
The value of monitors lies in your test scripts. When running your collection, a monitor will use your tests to validate the responses it's receiving. When one of these tests fail, you can automatically receive an email notification or configure the available integrations to receive alerts in tools like Slack, PagerDuty, or HipChat.
You can configure your monitors to run as frequently as you would like. For paid plans, monitors can be scheduled to run as often as every five minutes. For free plans, monitors can be scheduled to run as often as every hour.
Pricing
You can use Postman monitoring with any paid or free plan type.
Usage limits
You can find your account type's monthly usage limits by referring to your usage overview.
Postman maintains default limits on various team and user actions to ensure the overall performance and availability of monitoring.
These include the following limits:
- Maximum number of active and paused monitors per team = 300
- Maximum parallel runs of multiple monitors = 500
- Maximum parallel runs of a single monitor = 200
Postman will notify team admins via email if your team encounters these limits, as well as notify team members in the app.
For assistance regarding these limits and to request changes, contact the Postman support team.
Overages
With a free Postman account, once you've reached your usage limit for monitoring you'll be automatically capped for the remainder of your monthly cycle. To continue to use monitoring for the remainder of your cycle, you can upgrade your Postman plan.
With a paid Postman account, you have the option to cap your monthly monitoring usage by navigating to your billing dashboard > Overages and deselecting Allow monitoring overages. Overages are allowed by default and are charged at a pay-as-you-go rate. You can also opt to purchase monitoring blocks.
Unused monitoring requests or blocks do not roll over and must be consumed during the month purchased.
See more on how Postman calculates usage.
Viewing monitor usage
To view a high-level overview of your team's monitoring usage, you can access your monitor usage dashboard by navigating to your team usage dashboard and selecting View detailed monitoring usage under Monitoring Usage.
This page allows you to view your team's current billing period, how many requests have been made, and which monitors have run. It also identifies monitors by name, collection, environment, and creator.
If you are concerned about or are surprised by overages, this is the place to go to find all of your team's active monitors in one place, plus information to help you and your team make informed decisions on items like monitoring frequency.
How Postman calculates monitor usage
Postman calculates monitoring usage based on the actual number of requests made during a run, which may or may not be equal to the number of requests in your collection.
If you use postman.setNextRequest() to skip a request or run a request multiple times, Postman will take that into account when calculating usage. Postman will also count any requests required for authorization.
Running collections in a monitor
There are a few differences between running collections in a Postman monitor and running them via the in-app collection runner, so take note of the following.
Variables
- You cannot import existing global variables to a monitor, but you can create new ones during a run.
-
Global and environment variables can be updated and subsequently used during a monitoring run, however they will immediately revert to their original values.
- If you require persistent variables, you can add a call to update your environment using the Postman API.
Console output
- For your security and privacy, Postman does not log request or response bodies in the console.
- Postman will also not log headers, as they may include items like cookies and authorization keys.
Time limits
- Runs are limited to five minutes, including all HTTP requests, responses, pre-request, and test scripts.
File uploads
- You cannot attach files to requests, unlike in the request builder, however you can upload data as a raw request body.
Data files
- You cannot attach data files, unlike in the collection runner, but you can access them via APIs, including Google Docs, Google Sheets, and Dropbox.
Multiple iterations
- Monitors only run one iteration by default, but you can use setNextRequest() to run multiple iterations.
Multi-region monitoring
- When setting up or editing a monitor, you can select multiple geographic regions you'd like your monitor to run from if you are on a paid plan, or opt for Postman to auto-select a region for you. If you are on a Free plan, you can upgrade your Postman plan to manually select specific monitoring regions.
If you’re interested in a region that’s not listed in the Postman interface, contact the Postman support team.
Accessible APIs
- Monitors require all URLs to be publicly available on the internet as they run in the Postman cloud. A monitor cannot directly access your localhost or run requests behind a firewall. However, to overcome this issue, static IPs are available on Postman Business and Enterprise plans.
Next steps
Learn how to set up a monitor and check out monitoring APIs and websites to get started.