Skip to Content
API GovernanceGovernance Dashboard and Dpendency Tree

📊 Dashboard and Dependency Tree in API Governance (ATA)

Dashboard and Dependency Tree in API Governance are powerful tools that provide visibility into the health, status, and relationships of APIs across your organization. They help API producers, consumers, and teams track the lifecycle of APIs, monitor their security, and understand their dependencies with other services. These features play a critical role in managing the API ecosystem, promoting collaboration, and ensuring compliance across teams and business units.

🔑 What is the Dashboard in API Governance?

The Dashboard in API Governance gives you a centralized view of the status, categorization, and usage of APIs across your organization. It aggregates key metrics, trends, and insights, helping you track how APIs are performing and being utilized.

Key Features of the Dashboard:

  1. Total APIs Managed:
    • See the total number of APIs that are being managed within your organization. This is the total count of APIs across all teams and business applications, giving you an overview of your API landscape.
  2. API Lifecycle Status: This breakdown helps you monitor the current state of your API portfolio and identify which APIs need attention or deprecation. Example:
    • The dashboard provides a percentage breakdown of the API lifecycle status, showing the number of APIs in the following states:
      • Active: APIs that are currently in use.
      • Deprecated: APIs that are no longer recommended for use but are still available.
      • Retired: APIs that are no longer in use and should be considered for removal.
      • Draft: APIs that are still in development and not yet published.
    • Active: 65%
    • Deprecated: 15%
    • Retired: 5%
    • Draft: 15%
  3. API Categorization: This categorization helps you understand the distribution of your APIs based on their usage, security requirements, and access types. Example:
    • The dashboard shows the API categorization in terms of their exposure type:
      • Internal: APIs that are used within the organization.
      • BFF (Backend for Frontend): APIs that serve as a backend service for frontend applications.
      • 3rd Party: APIs that are provided by external vendors or partners.
      • API Gateway: APIs that are exposed through an API Gateway.
    • Internal: 50%
    • BFF: 10%
    • 3rd Party: 25%
    • API Gateway: 15%
  4. API Schema: Example:
    • The dashboard displays the percentage of APIs with and without an API schema. This helps you track which APIs have properly defined data models and which ones may lack a clear schema for validation.
    • With Schema: 75%
    • Without Schema: 25%
  5. Top 5 Business Applications by API Count:
    • The dashboard shows the Top 5 business applications that have the most APIs associated with them. This gives you a quick overview of which business applications are heavily reliant on APIs.
  6. API Versioning & Deprecation:
    • The dashboard includes API versioning information, showing how many versions of each API are active, and how many have been deprecated. This helps in tracking API evolution and ensuring backward compatibility.
  7. Top 5 Domains by API Count:
    • The dashboard lists the Top 5 business domains based on the number of APIs they manage. This helps identify which domains have a larger API footprint, guiding teams to focus on those with more dependencies.
  8. Most Used Security Protocols:
    • View the most commonly used security protocols across APIs (e.g., OAuth2, API Key, JWT, etc.), helping you track and enforce security practices across your API ecosystem.
  9. APIs Exposing PII Risk Categorization:
    • The dashboard shows the risk categorization for APIs exposing Personally Identifiable Information (PII). It helps you ensure that sensitive data is properly secured and that APIs handling PII adhere to the necessary security standards.
  10. API List:
    • A detailed list of all APIs in your organization, with their associated metadata such as status, exposure type, version, and team. You can access detailed information and take action from this list.

🔄 What is the Dependency Tree in API Governance?

The Dependency Tree allows you to view the relationships and dependencies between different APIs, teams, business applications, and endpoints. It helps you visualize and track how your APIs are interconnected, which is especially useful when managing complex systems or microservices architectures.

The Dependency Tree helps you:

  • Track dependencies between APIs and their consumers or dependent services.
  • Monitor the impact of changes to one API on others that rely on it.
  • Understand the relationship between business applications, APIs, and teams.

How the Dependency Tree Works

Custom Filters for API Dependencies:

ATA allows you to use custom filters to refine the dependencies you want to view. These filters help you focus on specific areas of your API ecosystem and generate the most relevant dependency map.

  1. Key Focus Area Dropdown:
    • API App: View dependencies related to a specific API Application.
    • Web App: See dependencies related to Web Applications.
    • Endpoint: Track dependencies at the endpoint level, showing how individual endpoints interact with others.
  2. Select Team:
    • Filter the dependencies based on the team responsible for the API or service.
  3. Select Business Application:
    • Filter dependencies by the business application, showing how APIs are used within different business units.
  4. Select API Application:
    • Focus on dependencies related to a specific API Application.

Output Options for Dependency Tree:

  1. Internal Config Items: View the internal configuration items within your organization and how they are interconnected.
  2. Internal APIs: View the APIs that are used internally within the company, helping you track dependencies between internal services.
  3. External APIs: Track the dependencies with external APIs that your APIs consume or rely on. This is important for understanding integration points with third-party systems.

Saving Filters for Reusability:

  • You can save custom filters for future use. If you frequently need to analyze the same set of dependencies, you can save the filter and quickly apply it again without re-entering the criteria.

💡 Benefits of the API Dashboard and Dependency Tree

  1. Centralized Visibility:
    • The Dashboard provides a centralized overview of your API landscape, showing key metrics like API status, exposure types, and usage patterns.
    • The Dependency Tree allows you to visualize and track the relationships and interdependencies between APIs, teams, and applications.
  2. Proactive Issue Detection:
    • Both tools help you spot issues before they become critical. By visualizing dependencies, you can easily see the impact of changes on related APIs, helping you proactively address potential integration or performance problems.
  3. Better Collaboration:
    • The API Dashboard provides transparency across teams and business units, enabling better communication and collaboration when managing APIs.
    • The Dependency Tree helps teams understand how their APIs interact with others, fostering better coordination between teams that consume or depend on each other’s APIs.
  4. Simplified Monitoring:
    • With the Dashboard, you can quickly track the health and usage of your APIs, allowing you to monitor key metrics and quickly identify underperforming or deprecated APIs.
    • The Dependency Tree helps track dependencies and ensure that your ecosystem of APIs remains stable and integrated.

API Dashboard and Dependency Tree in ATA are powerful tools for managing and visualizing the relationships, health, and usage of APIs within your organization. With real-time metrics, detailed insights, and customizable filters, these features provide full visibility into your API ecosystem. Whether you’re tracking dependencies, monitoring API health, or managing API lifecycle stages, the Dashboard and Dependency Tree are critical for ensuring smooth operations and proactive API management.

Happy managing! 🚀

Ask AI About Your APIsPII Configuration