Running a collection in Postman

Introduction

Running a collection lets you test many API requests automatically in one go. It saves time and helps find problems fast.

You want to test all API endpoints of your app at once.

You need to check if your API works after making changes.

You want to run the same tests every day to catch bugs early.

You want to share your tests with teammates easily.

You want to see a report of all test results together.

Syntax

Postman

pm.collection.run(collectionId, options, callback);

collectionId is the ID or name of the collection you want to run.

options can include environment variables or data files for the run.

Examples

Runs the collection named 'My API Tests' with default settings.

Postman

pm.collection.run('My API Tests');

Runs the 'User API' collection using the 'Dev Env' environment variables.

Postman

pm.collection.run('User API', { environment: 'Dev Env' });

Runs 'Order API' collection with data from 'orders.json' and logs when done.

Postman

pm.collection.run('Order API', { data: 'orders.json' }, function(err, summary) {
  console.log('Run complete');
});

Sample Program

This script runs the 'Sample Collection' using the 'Testing Env' environment. It prints the total and failed requests after the run.

Postman

const collectionId = 'Sample Collection';
const options = { environment: 'Testing Env' };
pm.collection.run(collectionId, options, function(err, summary) {
  if (err) {
    console.log('Error running collection:', err);
  } else {
    console.log('Collection run complete.');
    console.log('Total requests:', summary.run.stats.requests.total);
    console.log('Failed requests:', summary.run.stats.requests.failed);
  }
});

Important Notes

Make sure the collection and environment names are correct.

You can run collections manually in Postman or automate with Newman CLI.

Check the summary object for detailed test results after running.

Summary

Running a collection tests many API requests automatically.

Use options to set environment or data for the run.

Check the run summary to see how many tests passed or failed.

Practice

1. What is the main purpose of Running a collection in Postman?

easy

A. To write code for APIs

B. To create new API endpoints

C. To execute a group of API requests in a specific order

D. To delete saved requests

Solution

1. Step 1: Understand what a collection is

   A collection in Postman is a group of API requests organized together.

2. Step 2: Purpose of running a collection

   Running a collection means executing all requests in that group one after another automatically.

3. Final Answer:

   To execute a group of API requests in a specific order -> Option C

4. Quick Check:

   Running a collection = executing grouped requests [OK]

Hint: Running a collection means running all requests together [OK]

Common Mistakes:

• Confusing running a collection with creating requests
• Thinking it deletes requests
• Assuming it writes code automatically

2. Which of the following is the correct way to start running a collection in Postman?

easy

A. Drag the collection to the trash bin

B. Right-click the collection and select 'Delete'

C. Open the collection and edit the request

D. Click the 'Run' button on the collection

Solution

1. Step 1: Locate the collection in Postman

   Collections appear in the sidebar with a 'Run' button visible when selected.

2. Step 2: Starting the run

   Clicking the 'Run' button starts executing all requests in the collection.

3. Final Answer:

   Click the 'Run' button on the collection -> Option D

4. Quick Check:

   Run button starts collection execution [OK]

Hint: Look for the 'Run' button to start collections [OK]

Common Mistakes:

• Choosing delete instead of run
• Editing requests does not run collection
• Dragging to trash deletes collection

3. Given a collection with 3 requests, if you run the collection and the second request fails, what happens next?

medium

A. The collection stops running immediately

B. The collection continues to run the third request

C. The collection retries the second request automatically

D. The collection deletes the failed request

Solution

1. Step 1: Understand default run behavior

   By default, Postman runs all requests in a collection sequentially regardless of individual request failures.

2. Step 2: Effect of a failed request

   A failed request does not stop the collection run; it moves on to the next request.

3. Final Answer:

   The collection continues to run the third request -> Option B

4. Quick Check:

   Collection runs all requests even if one fails [OK]

Hint: Collection runs all requests unless manually stopped [OK]

Common Mistakes:

• Assuming run stops on failure
• Thinking Postman retries automatically
• Believing failed requests get deleted

4. You try to run a collection but get an error saying 'No requests found'. What is the likely cause?

medium

A. The collection is empty with no requests inside

B. You have not selected any environment

C. Postman is offline

D. You clicked 'Run' on a single request instead of collection

Solution

1. Step 1: Analyze the error message

   'No requests found' means the collection has no requests to run.

2. Step 2: Check collection contents

   If the collection is empty, running it will cause this error.

3. Final Answer:

   The collection is empty with no requests inside -> Option A

4. Quick Check:

   Empty collection = no requests to run error [OK]

Hint: Check if collection has requests before running [OK]

Common Mistakes:

• Confusing environment selection with requests
• Assuming offline causes this error
• Thinking running single request triggers this

5. You want to run a collection multiple times with different data sets for each run. Which Postman feature helps you do this efficiently?

hard

A. Using a data file with the Collection Runner

B. Manually editing each request before running

C. Running each request separately

D. Duplicating the collection for each data set

Solution

1. Step 1: Identify the need for multiple data sets

   Running the same collection with different inputs requires data-driven testing.

2. Step 2: Use Collection Runner with data files

   Postman allows uploading CSV or JSON files to run collections multiple times with varied data.

3. Final Answer:

   Using a data file with the Collection Runner -> Option A

4. Quick Check:

   Data files + Collection Runner = multiple runs with different data [OK]

Hint: Use data files in Collection Runner for repeated tests [OK]

Common Mistakes:

• Editing requests manually wastes time
• Running requests separately is inefficient
• Duplicating collections is unnecessary