Monitoring APIs and assessing data quality with API Insights
The Overview tab in the API Insights workspace provides a centralized view of data ingestion activities and integration health.
Image omitted: api-insights-overview.png
API Insights overview tab.
API Insights overview tab.
Access the API Insights Overview tab
To access the Overview tab, navigate to Workspaces > API Insights. The Overview tab opens by default.
Required roles
You need the sn_api_insights_ws.api_mgmt_architect or the sn_api_insights_ws.api_mgmt_architect_admin role.
Use cases
For examples of how different people in your organization would use this workspace, see these use cases.
| User | Workspace use |
|---|---|
| Enterprise architect | Search for APIs, compare APIs, request access to APIs, and address data issues. |
| Enterprise architect administrator | Manage API Insights settings, including API creation tools, business context relationship models, and ownership groups. |
Features
Access the various cards on the Overview tab to gain insights on the API data available in your organization.
| Feature | Description | Required roles |
|---|---|---|
| Search APIs | API search within the organization to locate specific APIs for review or management. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| Access requests received | Number of access requests received indicating the need for API access management. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| Your access requests | Number of access requests created by the logged-in user, indicating the activity for API access management. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| Helpful resources | Links to product documentation, knowledge base articles, and a community forum for additional support and information. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| APIs missing data | ||
| Missing business context | Count of APIs with no business context assigned. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| Missing ownership groups | Count of APIs with no ownership group assigned.Ownership groups enable tracking remediation and managing access requests. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| Missing product models | Count of APIs with no product model assigned, Product models enable accurate reporting and interactions with multiple versioned APIs. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| Missing design | Count of runtime APIs, available as API configuration items \(CIs\), with no design representation.Linking runtime APIs with design-time APIs, available as Digital Interface records, improves usability. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| Your team's APIs | ||
| All APIs | Total number of APIs managed by a team. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| In design | Number of APIs currently being designed. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| Operational | Number of APIs in active use. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| End of Life | Number of APIs that are retired or decommissioned. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |
| APIs managed by your team | ||
| All APIs managed by your team | Overview of the APIs managed by a team, based on the group associated with the logged-in user and the APIs linked to that group. API details include name, consumer count, management platform, life cycle stage, version, and requests per minute.Populates data corresponding to the selected card in the Your team's APIs section. | - sn\_api\_insights\_ws.api\_mgmt\_architect - sn\_api\_insights\_ws.api\_mgmt\_architect\_admin |