Administering data ingestion and model alignment with API Insights
Summarize
Summary of Administering Data Ingestion and Model Alignment with API Insights
The Overview tab in the API Insights workspace offers CMDB administrators a centralized view of API data ingestion and integration health. It is accessible by navigating toWorkspaces > API Insights, providing tools to monitor and manage incoming API data, ensuring alignment with the data model, and resolving any inconsistencies in CMDB records.
Show less
Key Features
- Search APIs: Locate specific APIs within the organization for review or management (Role: sncmdbadmin).
- Connection Status: Displays the total count of active API connections and processing errors to ensure reliable data ingestion (Role: sncmdbadmin).
- Active Connections: Indicates the number of installed connections with active import schedules (Role: sncmdbadmin).
- Errors: Shows the total number of processing errors for installed connections (Role: sncmdbadmin, cmdbinstadmin).
- API Clustering Recommendations: Reflects current clustering recommendations based on data model settings (Role: sncmdbadmin, mlreportuser).
- APIs by Discovery Source: Counts discovered APIs grouped by their source to understand discovery methods (Role: sncmdbadmin).
- APIs by Life Cycle: Categorizes APIs by their life cycle stages—Operational, Deploy, or End of Life (Role: sncmdbadmin).
- APIs by Type: Classifies APIs by protocol or communication type such as REST, GraphQL, and SOAP (Role: sncmdbadmin).
- APIs by Environment: Displays counts of APIs in Development, Test, and Production environments (Role: sncmdbadmin).
- APIs by Ownership Group: Groups APIs by assigned ownership group, facilitating management and oversight (Role: sncmdbadmin).
- APIs Missing Data: Highlights APIs missing key attributes, enabling prioritization of remediation efforts based on severity (Role: sncmdbadmin).
- APIs by Business Application: Counts APIs linked to business applications, aiding in tracking integration efforts (Role: sncmdbadmin).
- Connections Overview: Summarizes the status and activity of API data connections, including success and failure rates (Role: sncmdbadmin, cmdbinstadmin).
Key Outcomes
By leveraging the Overview tab, CMDB administrators can efficiently monitor and manage API data ingestion, ensure alignment with the data model, and take corrective actions on any identified discrepancies. This proactive management helps maintain accurate and consistent CMDB records, ultimately enhancing integration and operational efficiency across the organization.
The Overview tab in the API Insights workspace provides a centralized view of data ingestion activities and integration health.
Access the API Insights Overview tab
To access the Overview tab, navigate to . The Overview tab opens by default.
Required roles
Features
| Feature | Description | Required roles |
|---|---|---|
| Search APIs | API search within the organization to locate specific APIs for review or management. | sn_cmdb_admin |
| Connection status | Total count of active API connections and processing errors. Provides insight into the status of API connections and highlights any processing issues to verify reliable data ingestion.
|
sn_cmdb_admin and cmdb_inst_admin |
| API clustering recommendations | Number representing the current clustering recommendation, based on the data model recommendation settings. See Configure data model recommendations for API clustering in API Insights. |
sn_cmdb_admin and ml_report_user |
| APIs by discovery source | Total count of discovered APIs grouped by source. Provides insight into the discovery methods of APIs across your organization. |
sn_cmdb_admin |
| APIs by life cycle | Total count of APIs grouped by life cycle stage as Operational, Deploy, or End of Life. Provides visibility into API readiness and maintenance status across your organization. |
sn_cmdb_admin |
| APIs by type | Total count of APIs categorized by protocol or communication type. Includes technologies such as REST, GraphQL, and SOAP, providing insight into the integration styles and interoperability across your organization. |
sn_cmdb_admin |
| APIs by environment | Count of APIs deployed in each environment. Highlights distribution across Development, Test, and Production stages, enabling monitoring of deployment progress and assessment of risk exposure. |
sn_cmdb_admin |
| APIs by ownership group | Total count of APIs categorized by assigned ownership group. Groups APIs by managing team or function, as defined by an enterprise architect administrator with the sn_api_insights_ws.api_mgmt_architect_admin role in settings. For more information on setting an ownership group, see Configure settings to manage APIs in API Insights. |
sn_cmdb_admin |
| APIs missing data | Count of APIs missing key attributes, including business context, ownership group, product model, or design. Each bar represents a key attribute and indicates the number of APIs missing the attribute. Color coding indicates the severity of missing data:
Use the visual indicator to prioritize remediation efforts based on data completeness. Select a bar in the bar chart to start the remediation process. See Identifying and remediating missing API data in API Insights. |
sn_cmdb_admin |
| APIs by business application | Count of APIs linked to business applications. Enables tracking of API connections to business applications to improve integration after connections are established. |
sn_cmdb_admin |
| Connections overview | Summary of the status and activity of API data connections using Service Graph Connectors, including counts of successful, failed, or unknown connection tests, recent import success rate, and the number of connections currently processing data imports. | sn_cmdb_admin and cmdb_inst_admin |