View reports about API rule compliance in API specifications

With the API Governance report dashboard, you can view metrics on API Governance rule compliance in your specifications in Spec Hub. As a Super Admin or API Governance Manager, you can gain insight into specifications violating your governance rules, identify rules with frequent violations, and much more.

Access the report dashboard

To access the API Governance report dashboard, do the following:

1. Go to the Postman home screen.
2. Click API Catalog in the team information pane.
3. Click Governance Groups.
4. Select the Reports tab.

View report metrics

By default, the report dashboard shows metrics for public workspaces and internal workspaces everyone in your team can access in the All Workspaces governance group. To filter metrics by specific governance groups, select the Filter by Governance Groups dropdown list and select your governance groups.

You can select any metric in the report dashboard to view more details in a dialog. This includes the API specifications included in the metric, the workspaces where they’re located, the number of rules each specification violates, and more. You can also select any specification name, workspace name, governance rule, and more to open them in a new tab. Select any column header to filter a table by that column’s data, in alphabetical or numerical order.

The report provides the following information:

• Spec conformance status — The number of specifications with governance rules applied. You can view the number of Conformant specifications with Info or Hint severity or no rule violations. You can also view the number of Non conformant specifications with Error or Warning severity.
• Rule violations by severity — The number of governance rules violations. You can view the breakdown of governance rules violations by severity.
• Spec conformance over time — The number of specifications with and without governance rule violations, per month over the last 12 months.
• Rule violations over time — The number of governance rule violations by severity, per month over the last 12 months.
• Rules and violations — The governance rules violations, the rules’ violations count, and the number of specifications violating each rule. Click View more to view all governance rule violations.
• Workspaces with most non-conformant Specs — The workspaces with the most specifications in violation of governance rules. You can select View more actions next to a governance group to filter the report dashboard by that governance group or open the governance group in a new tab.