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 a comprehensive view of data ingestion activities and integration health. Access it by navigating toWorkspaces > API Insights, where it opens by default. CMDB administrators can monitor API data, assess alignment with the data model, and rectify any misaligned or incomplete data to ensure accurate CMDB records.
Show less
Key Features
- Search APIs: Locate specific APIs for review or management within the organization. Requires role sncmdbadmin.
- Connection Status: Displays total active API connections and processing errors for reliable data ingestion. Requires role sncmdbadmin.
- Active Connections: Total installed connections with active import schedules, accessible by selecting the count.
- Errors: Total processing errors for installed connections, requiring roles sncmdbadmin and cmdbinstadmin.
- API Clustering Recommendations: Indicates current clustering recommendations based on data model settings. Requires roles sncmdbadmin, mlreportuser, and platformmlread.
- APIs by Discovery Source: Shows count of discovered APIs categorized by their discovery methods. Requires role sncmdbadmin.
- APIs by Life Cycle: Categorizes APIs as Operational, Deploy, or End of Life, offering visibility into their readiness.
- APIs by Type: Displays APIs by protocol or communication type, such as REST or SOAP.
- APIs by Environment: Count of APIs in various environments (Development, Test, Production) to monitor deployment progress.
- APIs by Ownership Group: Categorizes APIs by assigned ownership, defined by an enterprise architect administrator.
- APIs Missing Data: Tracks APIs lacking key attributes, with visual indicators to prioritize remediation efforts based on severity.
- APIs by Business Application: Counts APIs linked to business applications to enhance integration post-connection.
- Connections Overview: Summarizes the status and activity of API data connections, including successful and failed connection tests.
Key Outcomes
By utilizing the Overview tab, CMDB administrators can effectively monitor and manage API data ingestion, ensuring the integrity and alignment of CMDB records. The insights provided enable proactive issue resolution and data completeness, thus enhancing the overall integration health within 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, ml_report_user, and platform_ml_read |
| 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 |