Creating monitors in Postman - Test Execution Walkthrough

Test Overview

This test creates a Postman monitor to run a collection automatically and verifies the monitor creation success message.

Test Code - PyTest

Postman

import requests

# Set Postman API endpoint and API key
api_key = 'your_postman_api_key'
collection_uid = 'your_collection_uid'
url = 'https://api.getpostman.com/monitors'

# Define monitor creation payload
payload = {
    "monitor": {
        "name": "Daily API Test Monitor",
        "target": {
            "type": "collection",
            "data": {
                "uid": collection_uid
            }
        },
        "environment": null,
        "schedule": {
            "enabled": true,
            "delay": 0,
            "interval": {
                "count": 1,
                "unit": "hour"
            }
        },
        "region": "us-east-1"
    }
}

# Set headers
headers = {
    'X-Api-Key': api_key,
    'Content-Type': 'application/json'
}

# Send POST request to create monitor
response = requests.post(url, json=payload, headers=headers)

# Assert monitor creation success
assert response.status_code == 200, f"Expected status 200 but got {response.status_code}"
json_response = response.json()
assert 'monitor' in json_response, "Response JSON does not contain 'monitor' key"
assert json_response['monitor']['name'] == 'Daily API Test Monitor', "Monitor name mismatch"

Execution Trace - 6 Steps

Step	Action	System State	Assertion	Result
1	Test starts	Test environment ready with API key and collection UID configured	—	PASS
2	Sends POST request to Postman API endpoint to create a monitor with specified name and schedule	HTTP POST request sent to https://api.getpostman.com/monitors with JSON payload	—	PASS
3	Receives HTTP response from Postman API	Response status code and JSON body received	Check response status code is 200	PASS
4	Parses JSON response and verifies 'monitor' key exists	JSON response parsed	Verify 'monitor' key is present in response JSON	PASS
5	Verifies the monitor name in response matches the requested name	Monitor details extracted from response	Monitor name equals 'Daily API Test Monitor'	PASS
6	Test ends successfully	Monitor created and verified	—	PASS

Failure Scenario

Failing Condition: API key is invalid or missing, or collection UID is incorrect

Execution Trace Quiz - 3 Questions

What does the test verify after sending the POST request?

A That the monitor runs immediately

B That the response contains a list of collections

C That the response status code is 200 and the monitor name matches

D That the API key is printed in the response

Key Result

Always verify the API response status code and key response fields to confirm that the resource was created successfully.

Practice

1. What is the main purpose of creating a monitor in Postman?

easy

A. To run API tests automatically on a schedule

B. To manually execute API requests one by one

C. To write new API test scripts

D. To create API documentation

Solution

1. Step 1: Understand what monitors do

   Monitors in Postman are designed to run tests automatically without manual intervention.

2. Step 2: Identify the main use

   They run API tests on a schedule to catch issues early.

3. Final Answer:

   To run API tests automatically on a schedule -> Option A

4. Quick Check:

   Monitors = Automated scheduled tests [OK]

Hint: Monitors run tests automatically, not manually [OK]

Common Mistakes:

• Thinking monitors are for manual testing
• Confusing monitors with writing test scripts
• Assuming monitors create documentation

2. Which of the following is required before creating a monitor in Postman?

easy

A. A manual test run report

B. An active Postman environment variable

C. A Postman workspace with no collections

D. A saved collection with tests

Solution

1. Step 1: Recall monitor prerequisites

   Monitors need a saved collection that contains tests to run automatically.

2. Step 2: Check other options

   Environment variables help but are not strictly required; a workspace without collections cannot run tests; manual reports are unrelated.

3. Final Answer:

   A saved collection with tests -> Option D

4. Quick Check:

   Monitor setup = saved collection needed [OK]

Hint: Monitors need collections with tests saved first [OK]

Common Mistakes:

• Assuming environment variables are mandatory
• Trying to create monitors without collections
• Confusing manual reports with monitor setup

3. Consider this scenario: You create a monitor for a collection that tests an API endpoint. The monitor is set to run every hour. What will happen if the API is down during a monitor run?

medium

A. The monitor will skip the test and report success

B. The monitor run will fail and report errors

C. The monitor will run tests but ignore failures

D. The monitor will automatically fix the API issue

Solution

1. Step 1: Understand monitor behavior on failure

   If the API is down, the requests in the collection will fail during the monitor run.

2. Step 2: Identify monitor reporting

   Monitors report test failures and errors; they do not skip or ignore failures, nor fix issues automatically.

3. Final Answer:

   The monitor run will fail and report errors -> Option B

4. Quick Check:

   API down = monitor reports failure [OK]

Hint: Monitors report errors if API is down during run [OK]

Common Mistakes:

• Thinking monitors skip failed tests
• Believing monitors fix API problems
• Assuming monitor reports success despite failures

4. You created a monitor but it never runs at the scheduled time. What is the most likely reason?

medium

A. The collection used by the monitor was deleted

B. The monitor schedule is set to run every minute

C. The monitor has no tests in the collection

D. The monitor is set to manual run only

Solution

1. Step 1: Check monitor prerequisites

   If the collection linked to the monitor is deleted, the monitor cannot run.

2. Step 2: Evaluate other options

   Running every minute is valid; having no tests means no failures but monitor still runs; monitors do not have manual-only mode.

3. Final Answer:

   The collection used by the monitor was deleted -> Option A

4. Quick Check:

   Deleted collection = monitor won't run [OK]

Hint: Deleted collection breaks monitor runs [OK]

Common Mistakes:

• Assuming schedule frequency stops runs
• Thinking monitors can be manual-only
• Confusing empty tests with no runs

5. You want to create a monitor that runs your API tests every day at 9 AM UTC and sends email alerts only if tests fail. Which steps should you follow?

hard

A. Create a new collection without tests, schedule monitor hourly, disable alerts

B. Save a collection with tests, create a monitor with no schedule, enable all alerts

C. Save a collection with tests, create a monitor scheduled daily at 9 AM UTC, enable email alerts on failure

D. Create a monitor without a collection, schedule daily, enable email alerts

Solution

1. Step 1: Prepare the collection

   You must have a saved collection that contains the API tests to run.

2. Step 2: Configure the monitor schedule and alerts

   Create a monitor scheduled daily at 9 AM UTC and enable email alerts only on test failures.

3. Final Answer:

   Save a collection with tests, create a monitor scheduled daily at 9 AM UTC, enable email alerts on failure -> Option C

4. Quick Check:

   Collection + daily schedule + alerts on failure = correct setup [OK]

Hint: Schedule monitor + enable alerts only on failure [OK]

Common Mistakes:

• Scheduling monitor without tests in collection
• Disabling alerts when failures occur
• Creating monitor without a collection