Dashboard

Dashboard at a Glance

The dashboard serves the purpose of monitoring and tracking various key performance indicators (KPIs) and business metrics, including:

• Total number of transactions. This metric counts the total number of transactions managed by runtimes within the landscape.
• Average response time. This metric calculates the average time needed to process an incoming API request and deliver the response to the client. This includes both the API Gateway and backend service processing times.
• Average latency. This metric measures the average time taken by the API Gateway to process an API request, excluding the time spent by the backend service.
• Error rate. This metric quantifies the error rate for failed transactions within the landscape.
• Status. This metric indicates the availability status of runtimes and data planes within the landscape.
• Capacity. This metric calculates the total number of transactions that a runtime and data plane can handle per second.

The widgets in the dashboard are rendered based on these KPIs. The dashboard retrieves and presents comprehensive analytics for the selected period. It renders differently depending on the user group, which includes:

• API platform provider
• API product manager

The following table displays the default view of the two user groups:

API Platform Provider	API Product Manager

The following figure displays the various sections and corresponding widgets that appear on the dashboard for each user group.

The entire dashboard’s content is determined by the chosen time frame. You have the option to select from a set of predefined time ranges using the drop-down menu located at the top-right corner of the dashboard. Additionally, you can tailor the time range to your specific needs. By default, Last 1 Hour time range is selected.

Widgets in detail

The widgets in the Dashboard page are explained in detail as follows:

Geographic visualization

This widget showcases a world map with distinct color pins that visually represents the data planes and runtimes within the landscape. The location of a runtime refers to a city or region for which the latitude and longitude coordinates can be determined by the pin on the map. If the runtimes associated with a data plane are situated in different regions, the data plane is marked at the midpoint of those runtimes on the map. You can utilize the Search text area to look up a specific data plane and runtime by name.

Upon hovering over the data planes and runtimes pins, the information displayed is determined by the selected parameter from the View Settings drop-down menu. By default, status and capacity details are shown.

The Location not assigned widget displays

• Data planes where none of the runtimes within a data plane is assigned to any location.
• Runtimes that are not associated with any data plane and have not been assigned to any location.

• For more information about how to determine the status, capacity, transaction, latency, error rate, and response time of the data plane, see Data plane - Widgets in detail.

• For more information about how to determine the status, capacity, transaction, latency, error rate, and response time of the runtime, see Runtime - Widgets in detail.

Count

This widget displays total number of data planes, runtimes, and APIs within the landscape.

• In the API platform provider view, the widget displays the overall count of data planes, runtimes, and APIs in their landscape. In addition it displays the counts for in-use and unused data planes, as well as active and inactive runtimes and APIs within their landscape

• In the API platform manager view, the widget provides details on the total number of APIs present in the landscape, along with the count of active and inactive APIs.

The following table displays the default view of the two user groups:

API Platform Provider	API Product Manager

Overall view

This widget displays the consolidated transaction count, average response time, average latency, and error rate count of all the data planes and runtimes within the landscape. It also displays the activity that are performed in the landscape.

• Total transactions displays the total number of API transactions performed during the selected period. It also displays the transaction rate by comparing the transactions of the selected period with respect to the previous period.
  For example, if you have selected the time range as 24 hours. The transaction rate is calculated by comparing the transaction number of the last 24 hours with the previous 24 hours.
  If the transaction rate for the selected period is increased when compared to the previous period, then it is denoted by upward arrow else by downward arrow.

Click the total transaction count, the Total transactions pop-up window displays the absolute transactions performed by each of the data plane, runtime, or API. Click the respective toggle button to view its absolute transaction value.

• Average response time displays the average response time of the transactions for the selected period. It also displays the average response rate by comparing the average response time for the selected period with respect to the previous period. If the response rate is increased, then it is denoted by upward arrow else by downward arrow.

To view the absolute average response rate of the data plane, runtime, or API, click the average response time, the Total average response time pop-up window appears. Click the respective tab to view its absolute response rate.

• Average latency displays the time taken by the runtime to process the request of the transactions made for the selected period. It also displays the latency rate by comparing the average latency time for the selected period with respect to the previous period. If the latency rate is increased, then it is denoted by upward arrow else by downward arrow.

To view the absolute average latency rate of the data plane, runtime, or API, click the average latency, the Total average latency pop-up window appears. Click the respective tab to view its absolute latency rate.

• Error rate displays the error rate of the failed transactions for the selected period. It also displays the error rate by comparing the error rate for the selected period with respect to the previous period. If the error rate is increased, then it is denoted by upward arrow else by downward arrow.

To view the absolute error rate of the data plane, runtime, or API, click the overall error rate, the Error rate pop-up window appears. Click the respective tab to view its absolute error rate.

• Activities displays the most recent activities performed in API Control Plane for the selected period. Click View all to view all the activities performed in API Control Plane.

Status, performance & used capacity

This widget displays the following:

Status displays the current and previous health status of the runtime or data plane. It is determined based on the availability of the runtime. Click the respective toggle button to view the status details. Click the View all to view status of all the runtime or data plane in the landscape.

Performance displays the performance of the runtime and data plane. The performance is determined by latency and error rate. The threshold for the latency and error rate is set based on the user preference. For details about how to set the performance threshold, see Change threshold settings. Click the respective toggle button to view the performance details. Click View all to view details of all the runtime or data plane in the landscape.

Capacity displays the capacity rate of the runtime and data plane. Capacity is the number of transactions that a runtime can handle. Click the respective toggle button to view the respective capacity rates. Click the View all to view capacity rate of all the runtime or data plane in the landscape.

• For more information about how to determine the status, performance, and capacity for the data plane, see Data plane - Status and Capacity.

• For more information about how to determine the status, performance, and capacity for the runtime, see Runtime - Status and Capacity.

Trending runtimes and APIs or Trending APIs

This widget provides insights into the performance trends of runtimes and APIs, whether they are on an upward or downward trajectory. This trend analysis enables you to compare current and past key performance indicators (KPIs) such as transactions, error rates, response times, and latency, based on the chosen filter criteria. This helps in identifying changes and making well-informed business decisions, as well as predicting future performance. This widget highlights the runtimes or APIs based on the actual Trend% value and the trend thresholds that are defined in the user preference.

• For details about how to set trend thresholds for upward and downward trending, see Change threshold settings.
• For more information about how to calculate the actual trend% for the runtimes, see Runtime monitoring. Similarly, calculate the actual trend% for the APIs.

The following table displays how this widget appears for the two user groups:

API Platform Provider	API Product Manager

The Upward trending / improving by widgets comprise of the following tabs, each displaying the defined upward trending threshold on the right side:

• No.of transaction. Lists the runtimes or APIs when the actual Trend% value is greater than the set trend threshold.

• Error rate. Lists the runtimes or APIs when the actual Trend% value is lesser than the set trend threshold.

• Response time. Lists the runtimes or APIs when the actual Trend% value is lesser than the set trend threshold.

• Latency. Lists the runtimes or APIs when the actual Trend% value is lesser than the set trend threshold.

Similarly, the Downward trending / deteriorating by widgets comprise of the following tabs, each displaying the defined downward trending threshold on the right side:

• No.of transaction. Lists the runtimes or APIs when the actual Trend% value is lesser than the set trend threshold.

• Error rate. Lists the runtimes or APIs when the actual Trend% value is greater than the set trend threshold.

• Response time. Lists the runtimes or APIs when the actual Trend% value is greater than the set trend threshold.

• Latency. Lists the runtimes or APIs when the actual Trend% value is greater than the set trend threshold.

Example

As an example, assume that the upward trending threshold and downward trending threshold are both set to 10% for all parameters in the User preferences > Threshold page. In the case of upward trending, the set trend threshold is interpreted as a +ve 10% for transactions, while it is -ve 10% for error rate, response time, and latency. The following scenarios apply in the Upward trending / improving by widgets:

• No.of transaction tab highlights runtimes or APIs when the actual Trend% is greater than 10%. The actual trend% value is displayed in green with an upward arrow.

• Error rate tab highlights runtimes or APIs when the actual Trend% is lesser than -10%. The actual trend% value is displayed in green with an upward arrow.

• Response time tab highlights runtimes or APIs when the actual Trend% is lesser than -10%. The actual trend% value is displayed in green with an upward arrow.

• Latency tab highlights runtimes or APIs when the actual Trend% is lesser than -10%. The actual trend% value is displayed in green with an upward arrow.

In the case of downward trending, the set trend threshold is interpreted as a -ve 10% for transactions and +ve 10% for error rate, response time, and latency. The following scenarios apply in the downward trending widget:

• No.of transaction tab highlights runtimes or APIs when the actual trend % is lesser than -10%. The actual trend% value is displayed in red with a downward arrow.

• Error rate tab highlights runtimes or APIs when the actual trend % is greater than 10%. The Trend% value is displayed in red with a downward arrow.

• Response time tab highlights runtimes or APIs when the actual trend % is greater than 10%. The Trend% value is displayed in red with a downward arrow.

• Latency tab highlights runtimes or APIs when the actual trend % is greater than 10%. The Trend% value is displayed in red with a downward arrow.

API activity

This widget displays the most used and least used APIs in the landscape. Here, as an API product manager you can analyse the APIs that are least used and make informed business decisions to increase consumption of the APIs.

Top APIs, runtimes, and data planes

This widget displays the top trending items based on your user group. For API product manager user group, it displays the top trending transactions at API level. For API platform provider user group, it displays the top trending transactions at API, runtime, and data plane levels.

Here, you can analyse the most problematic and performing APIs. Based on the analysis, you can derive new business strategies.

API Platform Provider	API Product Manager

You can customize the number of top APIs, runtimes, and data planes to display using Row settings under User preferences. For more details, see Customizing Row settings.