APIs

Manage APIs

API Control Plane gives a consolidated view of all the APIs that are available across the different runtimes. This helps the API Control Plane users, including API platform providers and API product managers to

• view the APIs.
• view the runtimes and it associated APIs.
• view multiple versions of an API as a single API.
• view the status of the APIs (active or inactive).
• highlight the differences in the same API when deployed across different runtimes.

These insights help the API Control Plane user to manage and monitor the APIs across runtimes efficiently.

As shown in the following figure, the highlighted areas on the Manage APIs page allow you to search APIs, filter APIs, view the runtimes and its associated APIs, customize the rows and columns of the API list, and highlight the API differences.

Filters

Status and published icon conventions

Status icon	Description
	All the APIs in the runtime are active.
	All the APIs in the runtime are inactive.
	The APIs in the runtime are either active or inactive.

Published icon	Description
	The API is not published.
	The API is published to Developer Portal, Service Registry, or Integration Server.

Highlight the differences

The Highlight the differences enables you to highlight the differences among APIs with different colors.

You can enable or disable the Highlight the differences checkbox for the following columns:

• API name
• Version
• Description
• Policies
• Tags

In a column, APIs with identical values appear with the same color. For example, consider an API with the API name as Petstore that is present across different runtimes. If you enable Highlight the differences checkbox for API name, APIs with the same API name are highlighted with the same color. If the same API’s name is changed to Petstore1 in any of the runtimes, the difference is highlighted with a different color.

If the differences exceed 10, meaning that there are 10 APIs with 10 different names across 10 runtimes, an error message is displayed, prompting you to correct the differences in the respective runtimes.

With Highlight the differences, you can easily identify API differences and avoid discrepancies across runtimes.

Monitor APIs

Monitor API enables you to monitor and track the key performance indicators of the APIs. It helps you to make informed business decisions by analyzing the performance metrics of the APIs.

API Control Plane lets you to monitor the APIs in following ways:

• Monitor all APIs lets you to monitor the performance of all the APIs and their business metrics in a single view. It also allows you to infer insights about the performance of the APIs.

• Monitor a specific API lets you to monitor the performance and business metrics of a specific version of an API.

Before you begin

Ensure that you have the API platform providers or the API product managers user group assigned to perform this task.

Monitoring all APIs

API Control Plane provides you with the ability to oversee the performance of all APIs in a unified view. This consolidated perspective allows you to pinpoint the highest and lowest performing APIs, facilitating data-driven business decisions.

To monitor all the APIs in the landscape

1. Click the APIs tab.
   The Manage APIs page appears.

   

2. Click the icon in the top right corner of the page.

   By default, the Monitor APIs page renders the metrics of all the APIs pertaining to last 1 hour. If you want to render the metrics for a different time range, select the predefined or custom time range from the Time Range drop-down menu (that appears in the top right corner of the page) based on your requirement and click the Apply button.

   

Widgets in detail

The widgets in the Monitor APIs page are explained in detail as follows:

Problematic APIs by

This widget helps identify issues across APIs by analyzing total transaction volumes, error rate, response time, and latency of all associated APIs. Choose a business metric to view its corresponding least and most problematic API. The API split and line graph display APIs in a sequence from the most problematic to the least.

For details about how to determine the error rate, response time, latency, and transactions, see Error rate, Response Time, Latency, and Transactions.

Transactions

This widget provides a comprehensive overview of total transaction volumes across all APIs with a trend percentage, along with detailed insights into the top-performing and under-performing APIs to help you make informed business decisions. It presents both pictorial and graphical representations of the APIs based on performance, highlighting maximum and minimum transaction counts for easy comparison. Click Top APIs or All APIs tab to view its respective transactions in the API split and line graph.

You can customize the number of Top APIs to display using Row settings under User preferences - Display. For more details, see Customizing row settings.

The Upward Trending tab displays the list of APIs for which the transaction trend percentage is greater than the set transaction trend threshold in the API: Upward trending/improving section of the User preferences > Threshold page. The Downward trending tab displays the list of APIs for which the transaction trend percentage is lesser than the set transaction trend threshold in the API: Downward trending / deteriorating by section of the User preferences > Threshold page. For more details on how to set the trend threshold, see Change threshold settings.

How to determine the total transactions and trend analysis for all APIs?

$$\text{Total transactions of the API} = {\sum_{i=1}^{n} \left(\text{Total transactions of the API in the time stamp } i\right)}$$

Example:

Let’s determine the total transactions of the API A for 4 hours based on the following metrics. Let’s assume:

$\text{Total transaction of the API A for 4 hours} = {100+200+250+100} = 550$

Similarly, let’s assume, the total transactions of the API B for 4 hours is 450

$$\text{Total transactions of all APIs} = {\displaystyle\sum_{i=A}^{n} \left(\text{Total transactions of API } i\right)}$$

Let’s determine the total transactions of all APIs for 4 hours. Let’s assume:

$\text{Total transaction of all APIs for 4 hours} = {550+450} = 1000$

Transactions trend analysis allows you to compare current and past transactions based on the time range you choose to spot changes, which helps in making informed business decisions and predicting future performance.

$$\text{Transactions trend percentage for all APIs for 24 hours} = (\frac{\text{Total transactions of APIs in last 24 hours} - \text{Total transactions of APIs in previous 24 hours}}{\text{Total transactions of APIs in previous 24 hours}})*100$$

You can replace 24 hours with the time range you select in the time range. If the determined trend percentage of transactions is a

• positive value, it is displayed in green with an upward arrow, indicating that transaction volume is increasing.
• negative value, it is displayed in red with a downward arrow, indicating that transaction volume is decreasing.

Example:
Let’s determine the transactions trend percentage for all APIs for 24 hours:

Let’s assume:

$\text{Transactions trend percentage for 24 hours for all APIs} = (\frac{1000-500}{500} )*100 = 100\%$

The determined transactions trend percentage, 100% (positive), appears in green with an upward arrow indicating increased transactions compared to the previous 24 hours.

Error rate

Error rate indicates the percentage of errors that occurred during API transactions. This widget provides a comprehensive overview of error rate of all APIs along with the details of the API with maximum and minimum error rate to make informed business decisions. Click Top APIs or All APIs tab to view its respective error rate in the API split and line graph.

You can customize the number of Top APIs to display using Row settings under User preferences - Display. For more details, see Customizing row settings.

The Upward Trending tab displays the list of APIs for which the error rate trend percentage is lesser than the set error rate trend threshold in the API: Upward trending/improving section of the User preferences > Threshold page. The Downward trending tab displays the list of APIs for which the error rate trend percentage is greater than the set error rate trend threshold in the API: Downward trending / deteriorating by section of the User preferences > Threshold page. For more details on how to set the trend threshold, see Change threshold settings.

How to determine the error rate and trend analysis for all APIs?

$$\text{Error rate of the API} = \frac{\displaystyle\sum_{i=1}^{n} \left(\text{Error count of the API in the time stamp } i\right)}{\displaystyle\sum_{i=1}^{n} \left(\text{Transactions count of the API in the time stamp } i\right)} \times 100$$

Example:

Let’s determine the error rate of the API A for 4 hours based on the following metrics. Let’s assume:

$\text{Error rate of the API A for 4 hours} = (\frac{150+115+30+100}{300+200+500+300})*100 = 35.90\%$

Similarly, let’s assume, the error rate of the API B for 4 hours is 50%

$$\text{Error rate of all APIs} = \frac{\displaystyle\sum_{i=A}^{n} \left(\text{Error count of the API } i\right)} {\displaystyle\sum_{i=A}^{n} \left(\text{Transactions count of the API } i\right)} \times 100$$

Let’s determine the error rate of all APIs for 4 hours. Let’s assume:

$\text{Error rate of all APIs for 4 hours} =(\frac{395 + 250}{1100 + 500})*100 = 40.31\%$

Error rate trend analysis allows you to compare current and past error rates based on the time range you choose to spot changes, which helps in making informed business decisions and predicting future performance.

$$\text{Error rate trend percentage for all APIs for 24 hours time range} = (\frac{\text{Error rate of all APIs in last 24 hours} -\text{Error rate of all APIs in previous 24 hours}}{\text{Error rate of all APIs in previous 24 hours}})*100$$

You can replace 24 hours with the time range that you select. If the determined error rate trend percentage is a

• positive value, it is displayed in red with an upward arrow, indicating that the error rate is increasing.
• negative value, it is displayed in green with a downward arrow, indicating that the error rate is decreasing.

Example:

Let’s determine the error rate trend percentage for all APIs for 24 hours. Let’s assume:

$\text{Error rate trend percentage for 24 hours time range for all APIs} = (\frac{0.35-0.50}{0.50})*100 = -30\%$

The determined error rate trend percentage, -30% (negative), appears in green with an downward arrow indicating that the error rate has decreased compared to the previous 24 hours.

Response time

Response time indicates total time taken to process an incoming API request and send the response to the client during API transactions. This includes the time taken by API Gateway and the backend service to process the request. This widget provides a comprehensive overview of response time of all APIs along with the details of the API with maximum and minimum response time to make informed business decisions. Click Top APIs or All APIs tab to view its respective response time in the API split and line graph.

You can customize the number of Top APIs to display using Row settings under User preferences - Display. For more details, see Customizing row settings.

The Upward Trending tab displays the list of APIs for which the response time trend percentage is lesser than the set response time trend threshold in the API: Upward trending/improving section of the User preferences > Threshold page. The Downward trending tab displays the list of APIs for which the response time trend% is greater than the set response time trend threshold in the API: Downward trending / deteriorating by section of the User preferences > Threshold page. For more details on how to set the trend threshold, see Change threshold settings.

How to determine the response time and trend analysis for all APIs?

$$\text{Response time of a API} = \frac{\displaystyle\sum_{i=1}^{n} \left(\text{Response time of the API in time stamp } i \times \text{Total transaction count of the API in time stamp } i\right)}{\displaystyle\sum_{i=A}^{n} \left(\text{Transaction count of API } i\right)}$$

Example:

Let’s determine the response time of the API A for 4 hours based on the following metrics. Let’s assume:

$\text{Response time of the API A for 4 hours} = (\frac{(1.05*10)+(2.07*15)+(0.08*20)+(1.07*30)}{75}) =1.00ms$

Similarly, let’s assume, the response time of the API B for 4 hours is 0.05ms

$$\text{Response time of all APIs} = \frac{\displaystyle\sum_{i=A}^{n} (\text{Response time of API } i \times \text{Total transaction count of API } i)}{\displaystyle\sum_{i=A}^{n} \text{Transaction count of API } i}$$

Let’s assume:

$\text{Response time of all APIs} = (\frac{(1.00*75)+(0.05*60)}{135}) = 0.57ms$

Response time trend analysis allows you to compare current and past response time based on the time range you choose to spot changes, which helps in making informed business decisions and predicting future performance.

$$\text{Response time trend percentage for all APIs for 24 hours time range} = (\frac{\text{Response time of all APIs in last 24 hours} - \text{Response time of all APIs in previous 24 hours}}{\text{Response time of all APIs in previous 24 hours}})*100$$

You can replace 24 hours with the time range that you select. If the determined trend percentage of response time is

• positive value, it is displayed in red with an upward arrow, indicating that response time is increasing.
• negative value, it is displayed in green with a downward arrow, indicating that response time is decreasing.

Example:

Let’s determine the response time trend percentage for all APIs for 24 hours. Let’s assume:

$\text{Response time Trend percentage for APIs for 24 hours time range} = (\frac{0.57-3.41}{3.41})*100 = -83.28\%$

The determined response time trend percentage, -83.28% (negative), appears in green with an downward arrow indicating that the response time has decreased compared to the previous 24 hours.

Latency

Latency indicates time taken by API Gateway to process an API request during API transactions. This does not include the time taken by the backend service to process the request. This widget provides a comprehensive overview of latency of all APIs along with the details of the API with maximum and minimum latency to make informed business decisions. Click Top APIs or All APIs tab to view its respective latency in the API split and line graph.

You can customize the number of Top APIs to display using Row settings under User preferences > Display. For more details, see Customizing row settings.

The Upward Trending tab displays the list of APIs for which the latency trend percentage is lesser than the set latency trend threshold in the API: Upward trending/improving section of the User preferences > Threshold page. The Downward trending tab displays the list of APIs for which the latency trend% is greater than the set latency trend threshold in the API: Downward trending / deteriorating by section of the User preferences > Threshold page. For more details on how to set the trend threshold, see Change threshold settings.

How to determine the latency and trend analysis for all APIs?

$$\text{Latency of a API} = \frac{\displaystyle\sum_{i=1}^{n} \left(\text{Latency of the API in time stamp } i \times \text{Total transaction count of the API in time stamp } i\right)}{\displaystyle\sum_{i=A}^{n} \left(\text{Transaction count of API } i\right)}$$

Example:

Let’s determine the latency of the API A for 4 hours based on the following metrics. Let’s assume:

$\text{Latency of the API A for 4 hours} = (\frac{(0.05*10)+(0.07*15)+(0.08*20)+(0.07*30)}{75}) = 0.04ms$

Similarly, let’s assume, the latency of the API B for 4 hours is 0.05ms

$$\text{Latency of all APIs} = \frac{\displaystyle\sum_{i=A}^{n} \left(\text{Latency of API } i \times \text{Total transaction count of API } i\right)}{\displaystyle\sum_{i=A}^{n} \left(\text{Transaction count of API } i\right)}$$

Let’s assume:

$\text{Latency of all APIs} = (\frac{(0.04*75)+(0.05*60)}{135}) = 0.04ms$

Latency trend analysis allows you to compare current and past latency based on the time range you choose to spot changes, which helps in making informed business decisions and predicting future performance.

$$\text{Latency trend percentage for all APIs for 24 hours time range} = (\frac{\text{Latency of all APIs in last 24 hours} - \text{Latency of all APIs in previous 24 hours}}{\text{Latency of all APIs in previous 24 hours}})*100$$

You can replace 24 hours with the time range that you select. If the determined trend percentage of latency is

• positive value, it is displayed in red with an upward arrow, indicating that latency is increasing.
• negative value, it is displayed in green with a downward arrow, indicating that latency is decreasing.

Example:

Let’s determine the latency trend percentage for all APIs for 24 hours. Let’s assume:

$\text{Latency trend percentage for APIs for 24 hours time range} = (\frac{0.04-3.41}{3.41})*100 = -98.82\%$

The determined latency trend percentage, -98.82% (negative), appears in green with an downward arrow indicating that the latency has decreased compared to the previous 24 hours.

Monitoring a specific API

API Control Plane allows you to monitor the performance of a particular version of an API. This monitoring capability helps you pinpoint the highest and lowest performance of an API across runtimes, empowering you to make well-informed business decisions.

To monitor a specific API

1. Click the APIs tab.
   The Manage APIs page appears.

   

2. Expand and click the icon under the Action column corresponding to the API for which you want view the performance metrics.

   By default, the API specific monitoring page renders the metrics pertaining to last 1 hour. If you want to render the metrics for a different time range, select the predefined or custom time range from the Time Range drop-down menu (that appears in the top right corner of the page) based on your requirement and click the Apply button.

   

For more details on how each widget is represented, see Widgets in detail section under Monitoring all APIs

API specific Monitoring: Activities