Postman Collection Monitors

If you already have your API calls set up in Postman, no need to duplicate the setups in APImetrics

If you have your API calls and tests in PostmanPostman, duplicating effort to add them to APImetrics can seem like a daunting task.

To solve this problem, we now offer the ability to monitor your Postman Collections directly.

📘

Importing APIs also available

If you'd rather import your API definitions from Postman or a variety of other formats, see the Importing API Calls and Importing from Postman pages.

🚧

Postman Monitoring uses the Postman API

Make sure your Postman subscription has enough quota

Setup

To get started, on the Monitor Postman Collection page, click "Configure a new Postman Collection monitor".

You may need to generate an APImetrics API key - click "Generate Auth Settings" to continue.

Generate Postman API key

To monitor your Postman Collection directly, first you need to generate a Postman API key. We will use this to fetch your Postman Collections.

More information on how to access or generate a key is available here: https://learning.getpostman.com/docs/postman/postman_api/intro_api/#authentication.
The first step is to log into postman and view your dashboard and select Integrations:

Browse integrations and select Postman API

Select Get API Key to generate an API key:

Once generated, copy your Postman API key and enter it in the APImetrics site, and click Validate:

As long as the API key is correct, and you have Postman quota available, we will show you the list of Collections available to import:

Select your Collection and Environment

Select the Collection you wish to monitor. On the next page select the Environment (if any) you wish to use.

On the last page, there are some optional parameters you may add or change. Once happy, press "Create new monitor" to create the monitor.

The collection will appear under your Configured Postman collection list at the top.

Start monitoring

❗️

Schedule your collection

You must schedule the collection to start monitoring

Select a schedule to start monitoring. The schedule must be a Postman-only schedule as the Postman monitors are only available on a sub-set of our locations.

You can use the Add Schedule button to create a new schedule:

Once the Collection monitoring starts, your account will be populated with the API calls in the collection, and the results will appear. Note that you cannot edit the API calls in APImetrics - you must save any changes to the Collection from Postman.

🚧

Ensure timing accuracy

As we’re running the Postman Collections “natively”, it re-uses connections when running sequential calls in a collection. This means that will see DNS lookup, TCP connection time and SSL handshake values will appear as 0ms for subsequent API calls. In order to avoid that, add a “Connection: close” header to the API calls in the Collection. This is purely optional, but will mean we get more accurate timings.