learning.postman.com
Open in
urlscan Pro
2600:9000:2491:5a00:7:d2b9:2cc0:93a1
Public Scan
Submitted URL: https://iterable.links.postman.com/u/click?_t=45a94676dd7342a9a5d24a86b9d12ca9&_m=09c55bc93a6a4c77afc4197856456a90&_e=Kbggt7_VydAyJ...
Effective URL: https://learning.postman.com/docs/running-collections/intro-to-collection-runs/
Submission: On September 08 via api from SG — Scanned from DE
Effective URL: https://learning.postman.com/docs/running-collections/intro-to-collection-runs/
Submission: On September 08 via api from SG — Scanned from DE
Form analysis 1 forms found in the DOM
<form novalidate="" class="ais-SearchBox-form" action="" role="search"><input type="search" placeholder="Search Postman Docs" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" required="" maxlength="512" value=""
class="ais-SearchBox-input"><button type="submit" title="Submit your search query." class="ais-SearchBox-submit"></button><button type="reset" title="Clear the search query." class="ais-SearchBox-reset" hidden=""></button></form>Text Content
* Product
What is Postman?API repositoryToolsIntelligenceWorkspacesIntegrationsGet
started free →
* Pricing
* Enterprise
Postman EnterpriseEnterprise case studiesContact sales
* Resources and support
LEARNING
DocsWebinarsBreaking Changes showPostman Space CampCase studiesState of the
API
COMMUNITY AND EVENTS
BlogCommunityStudent programStudent SummitPostman GalaxyPostman for
NonprofitsPostman swag
SUPPORT
Support CenterReseller supportPostman statusRelease notesContact us
* Explore
Sign InSign Up for FreeLaunch Postman
Learning Center(current)
* Docs
* Admin
* Developer
* Installing and updating
Postman is available on the web at go.postman.co/home and as a native desktop
app for Mac (Intel
* Working with certificates
You can add and manage certificates in Postman to enable authentication when
sending requests. To connect to an API that
* Collection SDK
The Collection SDK is a Node.js module that allows you to work with Postman
Collections and build them dynamically
* Mocking with examples
Mock servers simulate an API by returning predefined data, enabling you to
develop or test against an API before it
* Validating APIs
You can validate your API schema in Postman, and validate your elements
(documentation, tests, mock servers, and monitors) against your
* «
* ← Previous
* 1
* 2
* 3
* 4
* 5
* 6
* 7
* Next →
* Getting Started
* Sending Requests
* Writing Scripts
* Running Collections
* Using the Collection Runner
* Scheduling runs with monitors
* Triggering runs with webhooks
* Building request workflows
* Importing data files
* Using Newman CLI
* Collaborating in Postman
* Designing and Developing your API
* Publishing Your API
* Monitoring Your API
* API Governance
* Administration
* Using Reports
* Developer Resources
* Integrations
1. Home /
2. Running Collections
USING THE COLLECTION RUNNER
The Collection Runner enables you to run the API requests in a collection in a
specified sequence. It logs your request test results and can use scripts to
pass data between requests and alter the request workflow.
You can configure the Collection Runner to meet your development needs. You can
run collections using a specific environment, and can pass data files into a
run. Collection runs allow you to automate your API testing, and you can
schedule runs using monitors. You can also integrate collection runs with your
CI/CD pipeline using Newman, a Postman tool that enables you to run and test
collections directly from the command line.
Close
CONTENTS
* Configuring a collection run
* Running your collections
* Sharing collection runs
* Automating collection runs
* Next steps
CONFIGURING A COLLECTION RUN
To configure a collection run:
1. Select Collections in the sidebar and select the collection you want to run.
2. On the overview tab, select Run.
> You can also select Runner from the Postman footer and drag a collection
> from Collections or History in the sidebar.
3. Before you start a collection run, you can choose optional configuration
parameters:
* Iterations - The number of iterations for your collection run. You can
also run collections multiple times against different data sets to build
workflows.
* Delay - An interval delay in milliseconds between each request.
* Data - A data file for the collection run.
* Save responses - Save response headers and bodies to the log to review
them later. For large collection runs, this setting can affect
performance.
* Keep variable values - Persist the variables used in the run, so that any
variables updated by the run will remain changed after it completes. If
you don't persist variables, changes aren't saved after the run completes.
Note that persisting variables in the collection run will update the
current value only.
* Run collection without using stored cookies - If your requests use
cookies, you can optionally deactivate them for a collection run.
* Save cookies after collection run - Save the cookies used in this session
to the cookie manager. Any values affected by requests during the run will
remain after it completes.
4. If you want your collection to run against an environment, select it using
the environment selector at the top right of the workbench. You can also
select Environments in the sidebar, then select the environment you want to
use.
5. By default, your requests run in the sequence they're listed in the
collection. If you need to change the order of execution, select a request
and drag it to move it to its new order. You can also remove an individual
request from the run by clearing the checkbox next to its name.
> You can alter the flow of execution from your request scripts using
> setNextRequest to create workflows.
6. When you have completed your configuration, select Start Run.
RUNNING YOUR COLLECTIONS
Postman displays your request executions and test results in real time. To
access more data about what happened when a request executed, select its name
from the list of results.
Close
To view more details, including any log statements used in your collection,
select Console from the footer.
To view details about the run, select View Summary. The summary also has a
column for each iteration of your collection run so you can review test output
for the whole run.
Close
To return to the overview of the run, select View Results.
VIEWING TEST RESULTS
If your collection has tests, the View Results page indicates whether each
request passed or failed. You can also filter on each using the Passed and
Failed tabs at the top. If any tests in a request script fail during the
collection run, the whole request fails.
> If you select Save responses when you start a collection run, Postman displays
> the responses in the run results.
VIEWING ITERATIONS
If you set an iteration number for the collection run, you can access the
overview for each iteration by selecting one from the list on the right.
SHARING COLLECTION RUNS
You can share collection run results with others by exporting the results from
the Collection Runner.
To export a collection run:
1. Open the collection run in the Runner. You can also access the collection
run using History in the sidebar if you don't have the run open.
2. Select Export Results at the top right to download the run.
3. Choose a location to save your downloaded collection run, then select Save.
AUTOMATING COLLECTION RUNS
You can also use collection runs in conjunction with other Postman utilities to
build automation into your API projects.
* Newman, the Postman command-line interface, enables you to run collections
and build them into your development pipeline, responding to test outcomes to
support your API performance.
* Adding a monitor to your collection lets you schedule collection runs and
stay informed of any issues.
* You can also set up a collection webhook to trigger a collection run at a
specific time with your own custom payload.
NEXT STEPS
Now that you know the fundamentals of using the Collection Runner, you can
extend its functionality with workflows.
* To learn how to use scripts to build workflows with conditional sequences for
running the requests in your collections, visit Building request workflows.
Last modified: 2022/07/26
Was this helpful?
Thumbs UpThumbs Down
--------------------------------------------------------------------------------
Scheduling runs with monitors →
--------------------------------------------------------------------------------
logo-githubEdit this Doc
Prerequisites
Sending requests
Grouping requests in collections
Additional Resources
Videos
Log Response Data in Collection Runs | Postman Level Up
Intro to Postman | Run a Collection
Blog Posts
The Most Popular Collection in the Postman API Network
Add Same-Day Delivery to Your Business Using DoorDash’s Drive API
4 Postman Performance Improvements for Faster Workflows
Case Studies
Lightspeed
iQmetrix
© 2022 Postman, Inc.
PRODUCT
* What is Postman?
* API repository
* Tools
* Intelligence
* Workspaces
* Integrations
* Enterprise
* Plans and pricing
* Download the app
* Support Center
COMPANY
* About
* Careers and culture
* Press and media
* Contact us
* Partner program
SECURITY AND LEGAL
* Trust and Security
* Privacy policy
* Terms
SOCIAL
* Twitter
* LinkedIn
* GitHub
* YouTube
* Asset 2
Twitch
© 2022 Postman, Inc.
By clicking “Accept All Cookies”, you agree to the storing of cookies on your
device to enhance site navigation, analyze site usage, and assist in our
marketing efforts.
Accept All Cookies
Cookies Settings
PRIVACY PREFERENCE CENTER
When you visit any website, it may store or retrieve information on your
browser, mostly in the form of cookies. This information might be about you,
your preferences or your device and is mostly used to make the site work as you
expect it to. The information does not usually directly identify you, but it can
give you a more personalized web experience. Because we respect your right to
privacy, you can choose not to allow some types of cookies. Click on the
different category headings to find out more and change our default settings.
However, blocking some types of cookies may impact your experience of the site
and the services we are able to offer.
More information
Allow All
MANAGE CONSENT PREFERENCES
STRICTLY NECESSARY COOKIES
Always Active
These cookies are necessary for the website to function and cannot be switched
off in our systems. They are usually only set in response to actions made by you
which amount to a request for services, such as setting your privacy
preferences, logging in or filling in forms. You can set your browser to block
or alert you about these cookies, but some parts of the site will not then work.
These cookies do not store any personally identifiable information.
Cookies Details
FUNCTIONAL COOKIES
Functional Cookies
These cookies enable the website to provide enhanced functionality and
personalisation. They may be set by us or by third party providers whose
services we have added to our pages. If you do not allow these cookies then some
or all of these services may not function properly.
Cookies Details
TARGETING COOKIES
Targeting Cookies
These cookies may be set through our site by our advertising partners. They may
be used by those companies to build a profile of your interests and show you
relevant adverts on other sites. They do not store directly personal
information, but are based on uniquely identifying your browser and internet
device. If you do not allow these cookies, you will experience less targeted
advertising.
Cookies Details
PERFORMANCE COOKIES
Performance Cookies
These cookies allow us to count visits and traffic sources so we can measure and
improve the performance of our site. They help us to know which pages are the
most and least popular and see how visitors move around the site. All
information these cookies collect is aggregated and therefore anonymous. If you
do not allow these cookies we will not know when you have visited our site, and
will not be able to monitor its performance.
Cookies Details
Back Button
PERFORMANCE COOKIES
Search Icon
Filter Icon
Clear
checkbox label label
Apply Cancel
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label
*
View Cookies
* Name
cookie name
Confirm My Choices