Skip to content
Postman API Testing Tips

How To Use Monitor In Postman

API Testing Blog

Monitoring APIs with Postman: A Comprehensive Guide

Postman isn’t just a tool for sending API requests – it’s a powerful platform for building and managing API workflows. One of its most valuable features is the ability to monitor APIs, ensuring they’re always running smoothly and delivering reliable service.

This guide dives deep into how to use Postman’s monitoring capabilities, from setting up your first monitor to fine-tuning its behavior and leveraging advanced features.

Getting Started: Setting Up a Basic Monitor

  1. Create a Collection: Organize your API tests within a Postman Collection. This provides a logical grouping for your monitors.
  2. Select the Request: Choose the API request you want to monitor.
  3. Navigate to the Monitor Tab: In the top right corner of your request window, click the “Monitor” tab.
  4. Configure Your Monitor:
    • Name: Give your monitor a descriptive name.
    • Frequency: Set how often you want the monitor to run (e.g., every 5 minutes, every hour).
    • Time Zone: Choose your preferred time zone for scheduling.
    • Location: Select the geographic location from which your monitor will run. This ensures you’re testing the API from different parts of the world.
  5. Create the Monitor: Click the “Create Monitor” button.

Example: Creating a Monitor for a Weather API

// Sample POSTMAN Collection for weather api
[
  {
    "name": "Get Current Weather",
    "request": {
      "method": "GET",
      "header": [
        {
          "key": "Accept",
          "value": "application/json"
        }
      ],
      "url": {
        "raw": "https://api.openweathermap.org/data/2.5/weather?q=London,uk&appid=YOUR_API_KEY",
        "protocol": "https",
        "host": ["api", "openweathermap", "org"],
        "path": [
          "data",
          "2.5",
          "weather"
        ],
        "query": [
          {
            "key": "q",
            "value": "London,uk"
          },
          {
            "key": "appid",
            "value": "YOUR_API_KEY"
          }
        ]
      }
    }
  }
]

Understanding Monitor Execution and Results

  • Execution Logs: Every time your monitor runs, Postman generates a log detailing the request, response, and overall status (success or failure).
  • Alerting: You can configure Postman to send you email or Slack notifications when your monitor encounters errors.
  • Visualizations: Monitor performance data is presented in intuitive charts and graphs, allowing you to analyze trends and identify potential issues.

Advanced Monitoring Techniques

1. Monitoring with Assertions

Assertions are powerful tools for verifying specific aspects of your API’s behavior.

Example:

// Assertions in a POSTMAN Test
pm.test("Status code is 200", function () {
  pm.response.to.have.status(200);
});
pm.test("Body contains London", function () {
  pm.expect(pm.response.text()).to.include("London");
});

2. Using Environment Variables

Environment variables allow you to dynamically adjust your monitors, for instance, targeting different API endpoints or using different authentication credentials.

Example:

// Sample POSTMAN environment variable
{
  "id": "YOUR_ENVIRONMENT_ID",
  "name": "weatherApi",
  "values": [
    {
      "key": "apiKey",
      "value": "YOUR_API_KEY"
    }
  ],
  "current": true
}

3. Creating Custom Monitors with Code and Scripts

For greater flexibility, Postman enables you to write custom scripts using JavaScript. This allows you to implement complex monitoring logic.

Example:

// Sample POSTMAN custom code
pm.test("Custom test", function () {
  // Process the response body here
  const responseBody = pm.response.json();
  // Make sure the temperature is above a certain threshold
  pm.expect(responseBody.main.temp).to.be.above(10);
});

Conclusion

By leveraging Postman’s monitor features, you gain invaluable insights into your API’s health and performance. From simple smoke tests to complex custom monitors, Postman empowers you to ensure that your APIs consistently deliver the results you expect. Stay proactive in your API testing, identify issues before they affect users, and maintain a robust and reliable API ecosystem.

API Testing Blog