Api Insights

Associate API components with an API record by accepting clustering recommendation in the API Insights workspace.

As an enterprise architect, gain insights into your organization's API performance, relationships, and governance from the API details page within the API Insights workspace.

Assign roles to control access to features, capabilities, and data in the API Insights application.

Use clustering recommendations to organize and group related API components, improving the efficiency and accuracy of API management.

Compare APIs available within your organization in the API Insights workspace.

Several types of components are installed with activation of the API Insights plugin, including tables, user roles, and scheduled jobs.

As an enterprise architect administrator with the sn_api_insights_ws.api_mgmt_architect_admin role, configure workflows for organizing APIs, including automating API actions and defining settings to enable enterprise architects manage APIs in the API Insights workspace.

As a CMDB administrator with the sn_cmdb_admin role, you can set up data model recommendations for API clustering, configure settings for importing APIs into the API Insights workspace, and optionally review enterprise architect administrator settings for managing APIs.

Set recommendations for clustering API components to align the organization's data with the desired data model.

Set options to import custom and ServiceNow APIs from your instance into the CMDB.

As a user with the admin role, set up the API Insights workspace by installing the application and assigning roles to users for managing API operations.

Configure API Insights settings, including API creation tools, relationship models, ownership groups, and automated workflows, to streamline API governance and operational processes.

Complete the configuration tasks to start using the API Insights workspace.

Create an API data connection added for a Service Graph Connector within API Insights.

Initiate API creation directly from the API Insights workspace by connecting to an external API design tool of your choice.

If any conkeyrefs are broken, re-add them from the doc/source/reuse/domain-separation/domain-separation-overview.dita file.In the short description, edit the first sentence to state whether domain separation is supported or not and add the application name. Keep the conkeyref at the end that describes domain separation.Domain separation is unsupported for API Insights. Domain separation enables you to separate data, processes, and administrative tasks into logical groupings called domains. You can control several aspects of this separation, including which users can see and access data.

You can explore available options for onboarding and maintaining API data using Service Graph Connectors within API Insights.

Learn about API Insights with a sample workflow and review the benefits it can provide for different users in your organization.

Manage incoming received requests for API access in API Insights.

You can install the API Insights application (sn_api_insights_ws) if you have the admin role.If the application does NOT include demo data or it does NOT install related applications and plugins, delete or revise the following sentence:The application installs related ServiceNow Store applications and plugins if they are not already installed.

You can associate APIs with relevant configuration items (CIs) to ensure accurate mappings between APIs and the configuration items they support.

You can use the API Insights workspace to centralize and manage API data for informed decision-making.

You can view the status of your API data connections, including success rates, processing status, and ongoing executions, and monitor the progress of connections added using Service Graph Connectors in API Insights.

Check progress status of API data connections in API Insights.

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

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

The Overview tab in the API Insights workspace provides a centralized overview of your organization's API landscape.

API Insights properties control the behavior of the application.

Manage received and sent requests by granting or rejecting API access, sending reminders, or withdrawing requests in API Insights.

Reference topics provide additional information about API Insights components, API Insights properties, and domain separation.

Request access to an API available within your organization in the API Insights workspace.

Identify and remediate missing API data in the API Insights workspace by linking missing elements and verifying complete API records.

Search for an API or an API component available within your organization in the API Insights workspace.

Manage your sent access requests by either sending a reminder or withdrawing the request in API Insights.

You can configure and automate creating CMDB relationships between APIs and application services or business applications based on API tags.

Improve the operational efficiency of the API ecosystem within your organization by creating a relationship for APIs missing key attributes such as business context also called as business application ownership groups, product models, or designs.

You can access API specification validation rules to verify that your API specifications are complete, consistent, and adhere to best practices.

Manage and monitor all APIs within your organization by reviewing their life cycle stages, identifying missing critical attributes, and accessing helpful resources to ensure proper API maintenance and governance.

Use machine learning-based suggestions to group related API components, improving the organization and mapping of APIs within the system.

View the status of your API data connections using Service Graph Connectors, including success rates, processing status, and ongoing executions.

You can view installed and draft API data connections that were added using Service Graph Connectors within API Insights.

Configure flows in Workflow Studio for automating API actions within API Insights, streamlining processes like API access requests.

The ServiceNow API Insights workspace is an all-in-one application that enables you to track all your APIs. You can also use it to start workflows related to different stages in the application programming interface (API) life cycle.