Executive Summary
The Executive Summary page (Analyze > Executive Summary) provides a high-level view of your Application Programming Interface (API) in an easy-to-share format. It delivers a comprehensive suite of insights featuring new analytic metrics and trends without requiring any data collection or analysis tasks.
The Executive Summary complements the existing reports available on the administration dashboard. It caters to a broad audience, such as API Administrators, API Product Managers, Business Development and Marketing Executives, and Technical Executive leadership.
The Executive Summary page consists of two sections:
The summary data displayed in both sections are independent of each other.
Calendar Heat Map
The Calendar Heat Map displays time-based activity patterns for a specific metric over the course of a year. Each day is color-coded to the corresponding metric value, and you can interactively highlight a specific day.
You can select the following metrics to check the data of an API:
Calendar Heat Map Signals (or Metrics)
| Signal (or Metrics) | Description |
|---|---|
| Total Number of API Calls | Total number of API calls for the selected period. |
| API Platform Status | Ratio of the summation of API calls with a status code of either 503 or 504 divided by the total number of API calls for the selected period. |
| Platform Availability | Defined as one minus the API platform status metric, displayed as a percentage for the selected period. |
| QPS max | The maximum of the measured calls per second rate for the API platform for the selected period. |
| QPS (95th) | The 95th percentile of the measured calls per second rate for the API platform for the selected period. |
| QPS (99th) | The 99th percentile of the measured calls per second rate for the API platform for the selected period. |
| Data served | The quantity of data served through the API platform in units of bytes for the selected period. |
For example, let us assume that an API Product Manager wants to quickly observe and share the Total Number of API Calls per day over a particular year.
You can observe data for three years: the present year, the past year, and the year before that. For example, 2025, 2024, and 2023.
Legend
The Legend segments depict the metric value using color. A smaller metric value has a grey color and visually blends into the background. The higher metric value is a purple color and is visually easier to detect because it contrasts with the background.
Accessing the Calendar Heat Map
-
Sign in to the Boomi Cloud API Management (Control Center) dashboard.
-
Navigate to Analyze > Executive Summary.
-
Select a metric and a year from the lists at the upper-left corner of the Calendar Heat Map.
The calendar heat map contains all the days and months for the selected metric and year. The metric for each day is color-coded according to the segments of the color legend.
-
Point to a block in the Calendar Heat Map representing a particular day.
A tool tip displays the date, day, and details about the signal on that particular day.
Summary Insight Groups
The following sets of Summary Insight Groups are available:
-
Management Summary: This group of signals provides visibility into key API traffic patterns and an assessment of the API key engagement levels experienced by the API platform.
Management Summary Signals
Management Summary Signals Description Total number of API Calls Total number of API calls for the selected period. Change in API Call Volume The percentage change in the number of API calls comparing the selected period and the previous period. Average Active Keys Per Day Average of the daily number of API keys and the activity performed during the selected period. Total Active Keys Total number of API keys with activity during the selected period. Usage Consistency Ratio of the average active keys per day metric and the total active keys metric for the selected period expressed in percentage, also known as "stickiness." -
Technical Summary: This group of signals provides visibility into key API performance patterns and assessments of API platform health.
Technical Summary Signals
Technical Summary Signals Description API Platform Status Ratio of the summation of API calls with a status code of either 503 or 504 and the total number of API calls for the selected period. Predefined thresholds determine the API platform status either as Healthy (green), Performance Issues (yellow), or Service Disruption (red). Platform availability Defined as one minus the API platform status metric displayed as a percentage for the selected period expressed as a percentage. Platform Latency (95th) Defined as the ninety-fifth percentile of the platform latency for the selected period. Platform QPS (max) Maximum calls per second rate for the API platform for the selected period. Data Served Quantity of data served through the API platform for the selected period. Cache Hit Rate Ratio of the number of API calls served from cache and the total number of API calls for the selected period, expressed as a percentage. -
Development Summary: This group of signals provides visibility into key API partner growth metrics, including API key distribution and application creation.
Development Summary Signals
Developer Summary Signals Description Member registration Total number of new member registrations for the selected period. Application created Total number of new applications created for the selected period. Keys distributed Total number of new API keys distributed for the selected period.
Selecting the period of interest for all Summary Insight Groups
All Summary Insight Groups contain metrics and trends for a selected period of interest. The available periods for selection - Last Week, Last Month, or Last Quarter depend on the time span when you navigate to the feature.
Click Last Week, Last Month, or Last Quarter to view the Executive Summary Insight Groups. When you select a period, the details for the respective date range (start date and end date) display next to the Last Quarter button. The Management Summary, Technical Summary, and Developer Summary populate based on your selected period.
The Executive Summary page and the Heat Map populate only if sufficient data is available. For example, if you are a new customer using the Cloud API Management (Control Center) dashboard for less than a week, the Executive Summary page does not display any data.
View Insight Groups in text-based formats
Each Summary Insight Group contains a Share button that allows you to view the respective insights in a text-based format, facilitating efficient selection and sharing. Each insight contains a description of the period of interest for clarity.
Click Share on the Management Summary Insight Group to view the management insights as text. A window opens displaying the Management Summary in a text-based format.
