Analyzing with reports
API reporting is available on Postman Enterprise and Business plans.
You can access reports on your APIs in your Postman dashboard. API reports visualize data on API activities including creation, collection execution, test runs, and more, providing insights on performance, troubleshooting, and SLA adherence, as well as team and organization metrics.
To generate reports in Postman, first ensure you have carried out the following steps:
- Share your API
- Add a collection to the API
- Turn on Save Responses in History on the left of Postman
- Send a request from the collection
To view reports, in APIs on the left of Postman, select the API and click Reports.
The Reports section of the web dashboard will open in your browser. Postman generates reports on teams and APIs.
Your API reports will include different information if you're on an Enterprise or Business plan.
Enterprise reports
You can access the following reports from the left navigation bar of your dashboard:
- Team Activity
- All API reports
- Private Network API reports
- Security Audit reports
- Individual API view reports
Team activity reports
The Reports > Team Activity report provides team level metrics, including team overview, team size, billing details, team activity and workspaces. Click to view the details on a particular metric. This dashboard view can be split into three sections:
Team overview
Team overview reporting provides the following information:
- Team created on is the date when the team was created
- Team size over time is the size of the team over a period of time
- Team size is the number of user accounts in the team
- SSO identity provider is any SSO login you have configured for your team to access their Postman accounts
- Active users over time displays the users who have signed into Postman at least once over the past 30 days
In this example, the active users for the month of Nov 2020 is 240.
- Total slots is the number of slots in the team
- Invitations sent is the total number of invitations sent to join the team
- Open vs used slots indicates unused slots vs invitations that are either pending or approved by a team admin
In this example, the open slots for the month of Nov 2020 is 44 whereas the used slots is 306.
Billing
Billing reporting provides the following information:
- Plan is the current active plan you have subscribed
- Billing cycle is either monthly or annually
- Renewal date is the date of renewal of the existing plan
Team activity
Team activity reporting provides the following information:
- Total Workspaces is the total number of workspaces including team, personal and private workspaces
- Empty workspaces are workspaces with no collections in them
- Active workspaces have had at least one revision during the last 24 hours, not including personal workspaces
In this example, the number of active workspaces is 58 whereas the number of empty workspaces is 103.
- Total APIs is the total number of APIs in the team and personal workspaces, including private workspaces
- Requests sent in Postman is the requests sent manually in Postman but not any requests sent via Newman, monitoring runs, or the collection runner
In this example, the total API requests sent in Postman for Nov 2020 is 38,243.
- Total collections are the total number of collections in team and personal workspaces, including private workspaces
- Collections created is the total number of collections created in team workspaces, including private workspaces
- Collection runs is the number of collection runs made in team workspaces, including private workspaces
- Active monitors is the total number of active monitors in team workspaces including private workspaces (any monitor currently scheduled to run is active)
- Monitoring requests is the number of requests made from monitors in team workspaces, including private workspaces.
In this example, the monitoring requests for the month of May 2020 is 5618K.
- Publicly documented collections indicates any collections for which your team has published the documentation
- Views of public documentation is the number of times people have viewed your team's public documentation
- Views of private documentation is the number of times people have viewed your team's private documentation
In this example, the number of public documentation views for Feb 2021 is 15,767 whereas the number of private documentation views is 1,603.
All API reports
The Reports > All APIs report provides metrics including an overview of your total APIs, a visualization of API creation over time, and a separate view of your APIs with and without mocks, monitors, tests, and documentation. This dashboard view can be split into two sections:
API overview
The API overview reporting provides the following information:
- Total APIs is the total number of APIs created in Postman in all the team workspaces
- Private Network APIs is the number of APIs published on the teams' network
- Shared APIs is the number of APIs shared with team workspaces
- APIs created over time is the total number of APIs created during the month
- APIs created in last 24 hours is the APIs created in the past 24 hours
- APIs updated in last 24 hours APIs are considered active if there is some kind of activity in the last one day
For APIs created over a period of time, you can access the total count of APIs on a monthly basis.
In this example, the total number of APIs created for the month of July is 76.
API development
The API development reporting provides the following information:
- API Versions by Schema Type indicates APIs by the type of schema used to define them (OpenAPI, GraphQL, Swagger, etc) visualized as a horizontal bar chart
In this example, the count of APIs for OpenAPI(3.0) is 249.
- API Versions with Mocks is the number of APIs your team has added mocks to
- API Versions with Monitors is the number of APIs your team has added monitors to
- API Versions with Tests is the number of APIs your team has added test suites, integration tests and contract tests to
- API Versions with Documentation is the number of APIs your team has added documentation to
In this example, the APIs with/without mocks, monitors, tests and documentation are visualized in percentages. Hover over the chart to view the API data in figures. From the chart, you can see that 28% of the APIs have documentation.
Private Network API reports
The Reports > Private Network APIs report provides metrics including an overview of your total published APIs, a visualization of API categorised by schema type, and a separate view of your APIs with and without mocks, monitors, tests, and documentation.
The Private network API reporting provides the following information:
- Total published APIs are the number of APIs that are published to the Private API network
- API Versions by Schema Type indicates APIs by the type of schema used to define them (OpenAPI, GraphQL, Swagger, etc) visualized as a horizontal bar chart
- API Versions with Mocks is the number of APIs your team has added mocks to
- API Versions with Monitors is the number of APIs your team has added monitors to
- API Versions with Tests is the number of APIs your team has added test suites, integration tests and contract tests to
- API Versions with Documentation is the number of APIs your team has added documentation to
In this example, the APIs with/without mocks, monitors, tests and documentation are visualized in percentages. Hover over the chart to view the API data in figures. From the chart, you can see that 75% of the APIs have documentation.
Security Audit reports
The Reports > Security Audit report provides metrics including an overview of your total collections scanned, collections with exposed tokens, total exposed token and separate visualizations of exposed tokens by type and over time. This report consolidates the findings of the Postman token scanner from public documentation. For more on the Postman token scanner, see Postman security scans.
The Security Audit reporting provides the following information:
- Total collections scanned are the number of collections that are published or updated
- Collections with exposed tokens indicates total collection scans that has an exposed token
- Total exposed tokens are the total tokens that are exposed across all published collections
- Exposed tokens by type indicates the exposed tokens by type visualized as a donut chart
- Exposed tokens over time indicates the exposed tokens over a period of time visualized as a column chart
Individual API view reports
The View reports by API provide the individual API view where you can enter the API name in the search box and generate a report on the API.
Click View reports by API > Enter Reporting in the search box to view the above report.
Business reports
The Team > Overview report provides organization level metrics, including new and active APIs, team size, and workspaces. Click to view more data on a particular metric.
Team reports
Team reports provide the following information:
- Total number of APIs present in the team, including in private and public workspaces
- New APIs created within the team, not including new versions
- Active APIs having at least one request being sent through a linked collection in the Postman request builder
- Team size as the number of user accounts in the team
- Empty workspaces with no collections in them
- Active workspaces with at least one revision during the last 24 hours, not including personal workspaces
Team API requests are the count of requests sent over a period of time. The summary average is calculated by taking into account all days (even if no request is sent during a day).
In this example, 15 requests were sent on Jun 12. Over the next six days, no requests were sent. The 7-day average is 2.14 (15/7).
API reports
API reports provide a graphical representation of data and enable you to filter the data by collection and duration (last 7 or 30 days). You can view reports for any individual collections you have linked to an API.
Reports only track data from APIs you have shared to team workspaces. If your API is only shared to a personal workspace you will not see reports for it.
API reports provide the following information:
- Average response size of requests in bytes or kilobytes
- Average response time for your API to serve a request
- Number of error responses indicating error codes returned by your API
- Traffic in Postman indicating usage and API traffic for performance measurement
- Failed test runs indicating the number of failed tests in collection runs and monitors, for debugging and troubleshooting errors in your requests
The average response size is calculated based on the size of the response and the number of requests sent on a particular day.
In this example, the response size is shown for Jun 12. No request is sent on other dates in the graph.
The average response time is calculated based on the time taken to return the response of the request and the number of requests sent on a particular day.
In this example, the response time is shown for Jun 12. No response is received on other dates because no request is sent.
Summary average response size may not match the average of the graph, because raw data is accounted for when calculating averages. In order to determine an accurate average, Postman does not calculate averages using data from already derived averages.
Failed test runs are the number of failed tests for collection runs during a period of time. The summary average is calculated by taking into account all of the days in that time period (even if no requests are sent on certain days).
Report detail
Reports are not generated in realtime. You may experience a lag of a few minutes to 24 hours in report data being available. You can view the last updated time for reports.
You cannot currently download or export your reports.
Postman reports track data sent only through the request builder, and not through Newman, collection runs, or monitors. However, failed test runs generate reports using collection runs.
You cannot view the details of entities you do not have access to.
If you don't see any data in your reports, or your data is incomplete (for example you have empty response times or sizes) this may be due to one of the following reasons:
- It's too early to check. The data refreshes every 24 hours.
- You may not have linked a collection to your API.
- You may not have sent a request—or you may have executed requests from monitoring, collection runs, or Newman, but not from the request builder in Postman.
- You may not have enabled Save Responses in the History tab in Postman.
- Sync is not successfully communicating with the Postman servers.
If none of the above reasons apply and you can't see your data, please file a GitHub issue.
Next steps
You can use monitors to gain detailed insight into your APIs.