Reports in Postman - Naukri Code 360

Introduction

You can visualise data for how your team utilises Postman using the reports produced by Postman. These reports provide information about your APIs' tests, documentation, and monitoring coverage. They also give you the ability to monitor performance and SLA compliance.

This blog explains the details of Reports in Postman along with the details of summary reports, team details reports, All Workspaces reports, All API reports, and Security Audit Reports.

Without further ado, let's get started.

Getting started with reports

Postman activity, such as publishing your API, adding a collection to the API, and submitting a request from the collection, is detailed in the reports.

To check your dashboard for reports:

Select Reports from the team information area on the left after selecting Home in the Postman heading.

To view the report for a certain API:

Choose All APIs > View Report by API from the report dashboard.
To find an API, either perform a search or scroll through the list.

Report Availability

Postman does not produce reports instantly, just intermittently. Before report data is released, there could be a four to six-hour wait. The report dashboard sidebar of Postman shows the time of the most recent update at the bottom.

Report permissions

You can only access report data in a specific report if you have the necessary degree of access to the collection, API, element, mock server, or monitor in question. Aggregate visualisations will still show the right number of entities if you are not authorised to view an element, but they won't provide you with the element name or any other pertinent details.

Exploring reports and report data

To explore reports, go as follows:

Choose things from the sidebar of the report dashboard.

To examine data in a report, perform the following steps:

To display a data point's value, point your cursor over it to provide a data point.
To go down and explore more details, choose a data point. Using a column heading, sort the table. To navigate a related report or element, hover your cursor over a table row and click the arrow.

Let's dive into the details of summary reports.

Summary reports

A summary of your APIs can be seen in the Reports Summary dashboard. Additionally, it includes screenshots of your team's Postman usage and interactions with publicly accessible work.

A summary view of your APIs

The visibility of an API must be Team or Public in order to be counted in this measure.

Overview - A breakdown of the total number of APIs, the number of APIs with mocks, monitors, tests, and documentation, the number of APIs on your team's Private API Network, and the number of APIs on the Public API Network.
Team and public workplaces API Response Time - The average response time in milliseconds for all of your APIs over the previous seven days for team and public workspaces.
Results of API tests - The number of tests that passed and failed for your APIs during the previous seven days.
API Uptime - API uptime is the ratio of successful responses for your APIs during the last seven days (returning 1xx or 2xx) to failed responses (returning 3xx, 4xx, or 5xx).

How are people interacting with your publicly shared work?

Whether a user is a team member or not, the metrics in this section reflect all opinions and activities on publicly shared work.

Public Profile View - The total number of times your team's public profile has been viewed.
Views of public workspaces - The total number of views of public workspaces created by your team during the previous three months.
Views of published documentation - The number of times your team's published documentation has been viewed during the previous six months.
Public collection forks and pull requests - The frequency with which a collection in one of your public workspaces has been forked or pulled during the previous six months.
Watch count on public entities - The number of times a collection or API in one of your public workspaces has been watched during the previous six months. Users who watched an element and then stopped watching are included in this figure.

Let's look into the details of Team details reports.

Team details reports

Team-level indicators, such as team overview, team size, payment information, team activity, and workspaces, are displayed in the Team details dashboard. Three reports make up this section:

Team Details
Team Activity
Resource Usage

Team Details

The report on your team's specifics provides a summary of your group's composition, including:

Team Name: It contains your team's name.
Team Created On: The time the squad was formed.
Plan Type: Your team's subscription to The Postman plan.
Total team Members: It contains how many user accounts are currently active in the team.
Team members over time: Continuity of the team members During the previous six months, the team's size is on the last day of each month.
Team roles: It consists of how many team members are assigned the duties of administrator, biller, community manager, or developer. The count for each pertinent role will include a user who has numerous roles.
SSO identity provider: It contains the Members of your team who can access their Postman accounts using any single sign-on provider you've set up.
Billing Cycle: Invoicing cycle for your account (annual or monthly).
Renewal Date: It contains the day your existing Postman plan will automatically renew.

Team activity

The Team Activity Report provides more information about the activities of your team members, including:

Total team members - The number of user accounts that are currently part of the team.
Active members over time - Members who have been active over time are those who have used Postman at least once on a given day in the previous 30 days.
Team Activity - The cumulative number of user actions in a workspace over the previous six months is known as a team activity. These behaviours consist of the following:
- Request creation, editing, and deletion.
- Sending Request.
- Collections, APIs, environments, mocks, and monitors can all be created, edited, and deleted.
Entities created over time - The total number of Postman entities—including APIs, collections, environments, mocks, and monitors—created over the previous six months. This might apply to objects that were created during the reporting period, even though they have since been removed.
Entity updates over time - In the past six months, changes have been made to APIs, collections, environments, mocks, and monitors, among other entities.

Resource usage

The Resource Usage Report provides more details on how your team is using Postman resources, including:

Team slots

Utilization of paid seats across your team.

Billed slots - The difference between your team's utilised and unused billed slots.
Unbilled slots - Slots that have not yet been billed but will be at the upcoming Auto-Flex renewal.
Used slots over time - The amount of billable and unbilled slots used by your team over the course of the last six months.

Mock Server Call

Mock server calls made - The total number of mock server calls that were made.
Overage calls - The number of overage calls made throughout the reporting period.
Mock server calls over time - The total number of mock server calls made over the course of the last 30 days.

Monitoring server calls

Monitoring server calls - The total number of calls to the monitoring server.
Overage calls - The number of overage calls made throughout the reporting period.
Monitoring calls over time - The number of monitoring calls made throughout the course of the last 30 days.

Postman API calls

API calls made - The total number of API requests made to the Postman API.

Integrations

The integrations your team uses are described in this section.

Integration usage - Integration utilisation is the number of built-in integrations.

Integrations on entities - The number of monitors, collections, and API integrations that have been built.
Integrations by type - A breakdown of the number of integrations by type.

Let's dive into details of All Workspaces reports.

All Workspaces reports

A report containing totaled metrics for all of your workspaces is displayed in the All workspaces dashboard. Additionally, it includes distinct reports for the team and open workspaces. Three reports make up this section:

All Workspaces
Team Workspaces
Public Workspaces

All Workspaces

The following details are included in the report for all workspaces:

Total workspaces - The total number of workplaces includes public, team, individual, and private workspaces.
Workspaces created over time - It consists of the total number of workspaces your team has generated over the course of the last six months. If they were established during the reporting period, workspaces that have since been deleted might be included.
Workspaces by type - The overall number of individual, private, shared, and team workspaces and the proportion of each kind's vacant workspaces. Workspaces that are empty are those that lack any APIs, environments, monitors, mocks, or collections.
Active workspaces over time - The number of workplaces that have had at least one action on that day over the past 30 days. The actions consist of the following:
- Request creation, editing, and deletion.
- Sending Request
- Collections, APIs, environments, mocks, and monitors can all be created, edited, and deleted.

Team Workspaces

The Team Workspaces report provides details about your team workspaces, including:

Total team workspaces - This refers to all of your team's team workspaces.
Most active team workspace - A link to the team workspace that has had the most activity over the previous 30 days. Actions consist of:
- Request creation, editing, and deletion.
- Sending Request
- Collections, APIs, environments, mocks, and monitors can all be created, edited, and deleted.
Team workspace entities - The total amount of workspaces for each team that have environments, monitors, mocks, collections, and APIs.
Team collection forks and pull requests - The number of forks and pull requests made in the previous six months for each collection in your team workspaces. Forks and pull requests that were produced within the reporting period may be included, even if they have since been deleted.
Watch count - The number of times a collection or API has been seen in your team workspaces over the previous six months is known as the "watch count." Users who watched an element and then stopped watching are included in this figure.
Comments over time - The number of comments made on an API, collection, pull request, request, or folder in your team workspaces over the course of the last six months.

Public Workspaces

The Public Workspaces report provides details about your public areas, including:

Total public workspaces - This figure represents all of your team's public workplaces.
Most active public workspace - A link to the most popular public workspace during the previous 30 days is provided. Actions consist of:
- Requests can be created, edited, deleted, and sent.
- Collections, APIs, environments, mocks, and monitors can all be created, edited, and deleted.
The most popular public workplace - A link to the public workspace that has received the most views over the last three months.
Views on public entities - How many times your public workspaces and collections have been seen over the past three months.
Entities in public workspaces - The number of environments, monitors, mocks, collections, and APIs in the public workspaces created by your team.
Forks and Pull requests on public collections over time - The number of public workspace collections in your workspaces that have been forked or pulled over the course of the last six months. Forks and pull requests that were produced within the reporting period may be included, even if they have since been deleted.
Watch count - The number of times a collection or API in one of your public workspaces has been viewed in the past six months. Users who watched an element and then stopped watching are included in this figure.
Comments over time - The number of comments made on an API, collection, pull request, request, or folder in your public workspaces over the course of the last six months.

Let's look into the details of APIs reports.

All APIs reports

The All APIs dashboard offers distinct reports for the team, private network, and public APIs in addition to an overview of all your APIs. You may obtain a thorough report for each API using it as well.

Overview of all APIs

The following details are provided in the report on All APIs:

Total APIs: This represents all APIs developed by your team across all workspaces.
Distribution of APIs: The quantity of APIs developed in the individual, group, public, or team workspaces, as well as in the Private API Network.
APIs created over time - It consists of the total number of APIs created over the course of the last six months, broken down each month. If they were developed during the reporting period, this might include APIs that have since been deleted.

Team APIs

The Team APIs report offers details on APIs used in team workspaces, such as:

Total APIs in team workspaces – Total APIs in team workspaces.
Schemas by type - Types of schemas and the number of APIs in team workspaces (like OpenAPI, GraphQL, and Swagger). The same API will be counted in the column for each applicable schema type if an API has multiple versions with various schema types.
APIs updated over time - The total number of APIs that have been modified in the previous 30 days in team workspaces.
API response time - The average response time for all APIs in team workspaces over the previous seven days is known as API response time. The request to which a response pertains must be a collection component connected to a team API to be considered.
API test results - Results of the last seven days' worth of API tests, broken down into successful and unsuccessful attempts.
API uptime - The proportion of successful responses (returning 1 or 2) to failed responses (returning 3 or 5) during the last seven days.
API mock coverage - API mock coverage measures how many APIs in team workspaces your team has mocked.
API monitoring coverage - The total number of APIs in team workspaces for which your team has added monitors.
API test coverage - The number of APIs in your team workspaces that have tests added to them is known as API test coverage.
API documentation coverage - API documentation coverage measures how many APIs in team workspaces your team has documented.
Watch count - The number of times an API has been seen in a team workspace over the previous six months is known as the "watch count." This figure includes users that watched an API and subsequently stopped watching it.
Comments over time - The number of times an API has received comments in a team workspace over the course of the last six months.

Private Network APIs

The Private Network APIs report offers metrics about the APIs in your Private API Network, such as a summary of all of your APIs, a visualisation of APIs organised by type of schema, and a separate view of your APIs with and without mocks, monitors, tests, and documentation.

The Private Network APIs report provides the following details:

Total APIs on Private API Network - The total number of APIs on the Private API Network is the total number of APIs that have been published there.
Schemas by type - Types of schemas and the number of APIs in the Private API Network (like OpenAPI, GraphQL, and Swagger).
API mock coverage - The number of APIs in the Private API Network to which your team has added mocks is known as API mock coverage.
API monitoring coverage - The number of APIs your team has added monitors to in the Private API Network is known as API monitoring coverage.
API test coverage -It consists of the number of APIs in the Private API Network to which your team has added tests is known as API test coverage.
API documentation coverage - API documentation coverage is the quantity of Private API Network APIs to which your team has added documentation.
Watch count - The total number of times an API has been seen within the past six months on the Private API Network. Users that watched an API and then stopped watching are included in this total.
Comments over time - The number of times an API in the Private API Network has received comments over the course of the last six months.

Public APIs

The Public APIs report gives statistics on the APIs in your open workspaces, including a summary of all of your APIs, an overview of API updates and views, and a distinct view of your APIs with and without mocks, monitors, tests, and documentation.

The Private API report contains the same data as the Public API report, with the exception of Schemas by type. Additionally, it contains the following:

Total public APIs - The total number of public APIs in your workspaces is represented by this number.
APIs updated over time - It consists of the total number of APIs in your public workspaces that have been modified over the past 30 days.
Most popular public API - A link to the three most popular public APIs created by your team.
Public API views - Views of your APIs in your public workspaces during the previous three months are referred to as "public API views."
API mock coverage - The number of APIs in your public workspaces that your team has contributed mocks to is known as API mock coverage.
API monitoring coverage - The number of APIs in your public workspaces that your team has added monitors to is known as API monitoring coverage.
API test coverage - The number of APIs in your public workspaces that your team has added tests to is known as API test coverage.
API documentation coverage - API documentation coverage measures how many APIs in your open workspaces your team has documented.
Watch count - The number of times an API in one of your public workspaces has been watched during the previous six months. This figure includes users that watched an API and subsequently stopped watching it.
Comments over time - The number of times an API in one of your public workspaces has received comments over the course of the last six months.

View Report by API

You may see reports using the API. To access the report, choose an API from the list of APIs, search for it using the search box, or both. The following details are included in every API report:

API name - The API's name.
API developed by - The API's developer.
API created on - When the API was created, this is the date.
Number of API requests - The total number of API queries submitted during the previous 30 days.
Failed test runs - It consists of the number of failed test runs during the previous 30 days.
Average response size- The 30-day average of response size in bytes.
Average response time- The 30-day rolling average of response time in milliseconds.
API response codes - The HTTP response codes for each API response during the previous 30 days are known as API response codes.

Let's look into the details of Security audit reports.

Security audit reports

A summary of your total scanned collections, collections with exposed tokens, the total number of exposed tokens, and different visualisations of exposed tokens by type and over time are among the metrics included in the Security Audit report. The results of the Postman token scanner from open documentation are compiled in this report.

The following details over the previous 30 days are provided in the Security Audit report:

Published documentation scanned - Number of published documentation sets that were examined by the token scanner in terms of scanned published documentation.
Published documentation with exposed tokens - The number of published documentation sets that have exposed tokens is known as the "exposed token publication count."
Total exposed tokens - Tokens that have been exposed overall across all published documentation sets are counted as total exposed tokens.
Exposed tokens by type - The total number of exposed tokens broken down by type.
Tokens exposed over time - The number of tokens exposed each day.

Frequently Asked Questions

What is Postman used for?

Postman is an API client for Developers to easily create share, test, and document APIs.

What information is included in the reports produced by Postman?

Postman reports provide information about the tests, documentation, and monitoring coverage of your APIs. They also give you the ability to monitor performance and SLA adherence.

Is Postman a free tool?

Yes, Postman is open-source software.

Conclusion

In this article, we have extensively discussed the details of Reports in Postman along with the details of summary reports, team details reports, All Workspaces reports, All API reports, and Security Audit Reports.

We hope that this blog has helped you enhance your knowledge regarding Reports in Postman, and if you would like to learn more, check out our articles on Postman, Web Testing, API Testing. You can refer to our guided paths on the Coding Ninjas Studio platform to learn more about DSA, DBMS, Competitive Programming, Python, Java, JavaScript, etc. To practice and improve yourself in the interview, you can also check out Top 100 SQL problems, Interview experience, Coding interview questions, and the Ultimate guide path for interviews. Do upvote our blog to help other ninjas grow. Happy Coding!!