learning.postman.com
Open in
urlscan Pro
2600:9000:26da:2800:1c:f6c8:cc40:93a1
Public Scan
Submitted URL: https://go.postman.com/MDY3LVVNRC05OTEAAAGQsc8vM7jlwk7Z5R-9InqDADH_9wsZizN4oPMUYfAl_If4WGYmF6KQ7QhBy9vDaFYaRCFEBUU=
Effective URL: https://learning.postman.com/docs/collections/performance-testing/testing-api-performance/?utm_source=marketo&utm_medium=emai...
Submission: On January 16 via api from US — Scanned from DE
Effective URL: https://learning.postman.com/docs/collections/performance-testing/testing-api-performance/?utm_source=marketo&utm_medium=emai...
Submission: On January 16 via api from US — Scanned from DE
Form analysis 1 forms found in the DOM
<form action="" class="ais-SearchBox-form ais-SearchBox-input" novalidate="" data-dmtracked="true"><input class="ais-SearchBox-input" autocomplete="off" autocorrect="off" autocapitalize="off" placeholder="Search Postman Docs" spellcheck="false"
maxlength="512" type="search" value=""><button class="ais-SearchBox-submit" type="submit" title="Submit the search query"></button><button class="ais-SearchBox-reset" type="reset" title="Clear the search query" hidden=""></button><span
class="ais-SearchBox-loadingIndicator" hidden=""><svg width="16" height="16" viewBox="0 0 38 38" stroke="#444" class="ais-SearchBox-loadingIcon" aria-hidden="true">
<g fill="none" fill-rule="evenodd">
<g transform="translate(1 1)" stroke-width="2">
<circle stroke-opacity=".5" cx="18" cy="18" r="18"></circle>
<path d="M36 18c0-9.94-8.06-18-18-18">
<animateTransform attributeName="transform" type="rotate" from="0 18 18" to="360 18 18" dur="1s" repeatCount="indefinite"></animateTransform>
</path>
</g>
</g>
</svg></span></form>Text Content
* Product
GETTING STARTED
What is Postman?Customer StoriesDownload Postman →
API PLATFORM
Collaborate in WorkspacesOrganize with CollectionsExplore the API ClientBuild
Postman FlowsWork smarter with PostbotBrowse API Tools
ENTERPRISE SOLUTIONS
Enterprise EssentialsAPI Test AutomationInternal API Management
* Pricing
* Enterprise
* Resources and Support
LEARNING
Learning Center DocsPostman AcademyWhite PapersBreaking Changes
ShowTemplatesTutorialsWebinarsState of the API ReportGuide to API-First
COMMUNITY AND EVENTS
POST/CONBlogCommunityPostman SupernovasStudent ProgramEventsPostman Swag
SUPPORT
Support CenterReseller SupportPostman StatusRelease NotesContact Us
* Public API Network
Contact SalesSign InSign Up for FreeLaunch Postman
Learning Center
* Learning Center
Learn about how to get started using Postman, and read more in the product
docs.
* Labs
Flows, gRPC, WebSockets! Learn about the latest cutting-edge features brewing
in Postman Labs.
* Open Technologies
Invest in the knowledge, specifications, standards, tooling, data, people,
and organizations that define the next 50 years of the API economy.
* Collection Format
Understand the specification behind Postman Collections. Check out the docs
and support resources!
* Blog
The Postman blog is your hub for API resources, news, and community. Learn
about the Postman API Platform and much more.
* How a Postman mock server matches requests to saved examples
Using Postman's mock servers requires a collection with requests and saved
request examples. You can save as many examples
* Create and use a mock server using the Postman API
Setting up a mock server enables you to simulate the behavior of a real API
for development or testing purposes
* Authenticate with Windows NTLM authentication in Postman
Windows Challenge/Response (NTLM) is the authorization flow for the Windows
operating system and for standalone systems. To use NTLM…
* Authenticate with OAuth 1.0 authentication in Postman
OAuth 1.0 enables client applications to access data provided by a
third-party API. For example, as a user
* Connect your API to an on-premises Git repository
GitHub Enterprise Server, GitLab Self-Managed, and Azure DevOps Server
(hosted on-premises) integrations are available on Postman Enterprise…
*
* ← Previous
* 1
* 2
* 3
* Next →
*
* Introduction
* Get started
* Send requests
* Write scripts
* Postman Collections
* Overview
* Create and manage collections
* Run collections
* Test API performance
* Run a performance test
* View performance test metrics
* Debug performance test errors
* Inject data into virtual users
* Live Collections
* Newman CLI
* Postman Flows
* Postman CLI
* Collaborate
* Design and develop APIs
* Document APIs
* Monitor APIs
* Administration
* Billing
* API Governance
* Reports
* Developer resources
* Integrations
1. Home /
2. Postman Collections /
3. Test API performance
SIMULATE USER TRAFFIC TO TEST YOUR API PERFORMANCE
> Performance testing is available on Postman Free, Basic, and Professional
> plans. To learn more about availability for Enterprise plans, contact the
> Postman sales team.
Performance testing enables you to simulate user traffic, so you can observe how
your API behaves under load and find out if the performance meets expectations.
It can also help you identify any issues or bottlenecks that affect performance.
You can use the Collection Runner to test the performance of your API with the
same requests, collections, and environments you use for functional API tests.
To configure a performance test, create a collection with the requests you want
to send to your API. Postman uses these requests to simulate the activity of
your API's users. In the Collection Runner, you can set the duration of the test
and the number of virtual users. Each virtual user runs the requests in the
specified order in a repeating loop. All of the virtual users operate in
parallel to simulate real-world load on your API. You can choose whether the
number of virtual users is fixed for the duration of the test or gradually ramps
up during the test. You can also upload a data file with custom values to use
for each virtual user.
The performance test runs on your computer and not in the cloud. When you start
the test, the Collection Runner displays performance metrics in real time. You
can view performance test metrics such as the average response time, error rate,
and throughput for all requests or individual requests. You can also view
details about errors that occurred during the test to help identify the source
of any performance issues.
CONTENTS
* Configure a performance test
* Virtual users and system resources
* View past performance runs
CONFIGURE A PERFORMANCE TEST
> Use the Postman desktop app to configure and run performance tests. You can't
> use the Postman web app for performance testing. During a performance test,
> all requests are sent from the host computer where you are running the Postman
> desktop app.
Before you configure a performance test, create a collection or add a folder
with the requests you want to use to simulate user activity. Each virtual user
runs the selected requests in the specified order and repeats the sequence
throughout the test. Multiple virtual users all operate in parallel to simulate
real-world usage of your API.
To configure a performance test in the Postman desktop app, do the following:
1. Select Collections in the sidebar and select the collection or folder you
want to use for performance testing.
> You can also use a collection or folder that's linked to an API to run a
> performance test. Learn more about adding a collection to an API.
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. Select the Performance tab.
4. (Optional) Change the order the requests are run in by dragging a request to
a new location. To skip a request, clear the checkbox next to its name.
> Performance tests execute all of the requests selected in the Collection
> Runner in order, and each virtual user runs through the sequence of
> requests. This helps you test the performance of your API workflows. To
> test API calls in isolation, you can run performance tests on individual
> requests instead.
5. Enter the number of Virtual users. While the test is running, each virtual
user runs the selected requests in the specified order in a repeating loop.
A higher number of virtual users puts increased load on your API.
> The maximum number of virtual users you can simulate depends on available
> system resources and the collection you're using. Learn more about virtual
> users and system resources.
6. Enter the Test duration in minutes.
7. Select a Load Profile.
* Fixed - The number of virtual users you specified is used throughout the
test.
* Ramp up - Enter a Ramp up duration in minutes. During the ramp-up period,
the number of virtual users gradually increases to the number of users you
specified.
8. (Optional) Select a Data file with custom values to use for each virtual
user. The file must be in CSV or JSON format. Learn more about using a data
file to simulate virtual users.
9. When you're ready to begin the performance test, select Run.
* You can view real-time performance metrics while the test is running.
Learn more about viewing performance test metrics.
* After the test completes, you can view details for any errors that
occurred during the performance test. Learn more about debugging
performance test errors.
Close
> Your Postman plan gives you a limited number of performance runs you can use
> each month. A message will display in the Collection Runner when you're
> approaching your usage limit. Learn more about resource usage in Postman.
VIRTUAL USERS AND SYSTEM RESOURCES
The number of virtual users a performance test can simulate depends on available
system resources and the collection used for the test. Using pre-request or test
scripts will reduce the number of virtual users that can be simulated. The
maximum number of virtual users is determined by your Postman plan.
Use the following guidelines to understand how many virtual users you can
simulate:
* A host with 8 CPU cores and 16 GB RAM can simulate up to 250 virtual users
* A host with 16 CPU cores and 32 GB RAM can simulate up to 500 virtual users
Attempting to simulate a higher number of virtual users may cause inaccurate
metrics and reduced throughput (requests per second). Try running a small test
with 10 to 20 virtual users and observing system resource usage. You can use
this information to estimate that maximum number of virtual users that can be
simulated for your collection and host computer.
> If you have a problem with the performance testing feature, contact the
> Postman support team. Make sure to attach your Postman logs in your support
> request.
VIEW PAST PERFORMANCE RUNS
You can view a list of past performance runs for a collection. Open the
collection, select the Runs tab, and then select the Performance runs tab.
You can view metrics for each run, including the number of virtual users (VUs),
duration, total number of requests, requests per second, average response time,
and error rate. Select the run number to view a graph and full details for the
performance run.
Close
Last modified: 2024/01/10
--------------------------------------------------------------------------------
← Run a collection with imported data
View performance test metrics →
--------------------------------------------------------------------------------
logo-githubEdit This Doc
Additional resources
Videos
Load Testing Your APIs
Blog posts
Test your API’s performance by simulating real-world traffic with Postman
© 2023 Postman, Inc.
PRODUCT
* What is Postman?
* API repository
* Tools
* Governance
* Workspaces
* Integrations
* Enterprise
* Plans and pricing
* Download the app
* Support Center
COMPANY
* About
* Careers and culture
* Press and media
* Contact us
* Partner program
LEGAL AND SECURITY
* Terms of Service
* Trust and Safety
* Privacy policy
* Cookie notice
* Privacy choices
API CATEGORIES
* App Security
* Payments
* Financial Services
* DevOps
* Developer Productivity
* Data Analytics
* Communication
* Artificial Intelligence
SOCIAL
* Twitter
* LinkedIn
* GitHub
* YouTube
* Twitch
© 2023 Postman, Inc.
We use cookies on your device to enhance your navigation experience, analyze
usage to improve our site, and customize our marketing efforts. You can learn
more about cookies in ourCookie Notice.
Reject All Cookies Accept All Cookies
Manage Cookies
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.
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. 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
COOKIE LIST
Search Icon
Filter Icon
Clear
checkbox label label
Apply Cancel
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label
Confirm My Choices