Administering data ingestion and model alignment with API Insights

  • Release version: Yokohama
  • Updated July 31, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    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 and integration health. It allows CMDB administrators to monitor incoming API data, assess alignment with the data model, and address any data inconsistencies to ensure accurate CMDB records. Access this feature by navigating toWorkspaces > API Insights.

    Show full answer Show less

    Key Features

    • Search APIs: Locate specific APIs within the organization for review or management.
    • Connection Status: View total active API connections and processing errors to ensure reliable data ingestion.
    • Active Connections: Count of installed connections with active import schedules.
    • Errors: Number of processing errors for installed connections.
    • API Clustering Recommendations: Current clustering recommendations based on data model settings.
    • APIs by Discovery Source: Count of discovered APIs categorized by their source.
    • APIs by Life Cycle: APIs categorized into Operational, Deploy, or End of Life stages.
    • APIs by Type: Categorization of APIs by protocol (REST, GraphQL, SOAP) for integration insights.
    • APIs by Environment: Count of APIs deployed across Development, Test, and Production environments.
    • APIs by Ownership Group: Classification of APIs by assigned ownership groups defined by enterprise architects.
    • APIs Missing Data: Identifies APIs lacking key attributes, helping prioritize remediation efforts based on severity.
    • APIs by Business Application: Count of APIs linked to business applications for improved integration tracking.
    • Connections Overview: Summary of API data connection statuses, including counts of successful and failed connections.

    Key Outcomes

    By utilizing the Overview tab, customers can effectively monitor and manage API data ingestion, resolve data alignment issues, and maintain the integrity of their CMDB records. The visual metrics and categorization features enable proactive decision-making and prioritization of remediation efforts, leading to improved data quality and operational efficiency.

    The Overview tab in the API Insights workspace provides a centralized view of data ingestion activities and integration health.

    API Insights Overview tab for CMDB administrators.

    Access the API Insights Overview tab

    To access the Overview tab, navigate to Workspaces > API Insights. The Overview tab opens by default.

    Required roles

    CMDB administrators can access the Overview tab within the API Insights workspace to monitor incoming API data, evaluate alignment with the data model, and take action on misaligned or incomplete data to verify consistent and accurate CMDB records. They can view and resolve errors in connections when importing API data into CMDB using Service Graph Connectors and adjust data based on clustering recommendations.
    Note:
    As a user with the sn_cmdb_admin role, you need additional roles such as ml_report_user and cmdb_inst_admin to access some of the features and data.

    Features

    Access the various cards on the Overview tab to gain insights on the API data available in your organization.
    Note:
    Select a segment or count on a chart to open the KPI Details page and analyze how a specific metric trends over time. To learn more about the KPI Details feature, see KPI Details.
    Table 1. Overview tab features for CMDB administrators
    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.

    Active connections
    Total number of installed connections with active import schedules. Select the count to view installed connections.
    Errors
    Total number of processing errors for installed connections.
    		 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:

    Red
    More than 50% of APIs are missing the attribute.
    Yellow
    Between 10% and 50% of APIs are missing the attribute.
    Green
    Less than 10% of APIs are missing the attribute.

    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