Metrics of APIs

Monitor key performance metrics such as throughput, response time, latency, and error rate to assess the efficiency of APIs. It helps you to make informed business decisions by analyzing the performance metrics of the APIs.

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

Problematic APIs by

The 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. Click the Show as table icon to view the line graph in table format. Click ellipsis icon to download the table in CSV, PNG, or JPG formats.

Transactions

The widget provides a comprehensive overview of total transaction volumes across all APIs with a trend percentage, along with detailed insights into the most and least-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. Click Top APIs or All APIs tab to view its respective transactions in the API split and line graph.

The Upward Trending tab displays the list of APIs for which the transaction trend percentage is greater than the set transaction trend threshold. The Downward trending tab displays the list of APIs for which the transaction trend percentage is lesser than the set transaction trend threshold. Set your preferences by customizing the display settings of the widgets and threshold values for the parameters that control the monitoring capability of the assets

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

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

Example,

To determine the total transactions of the API A for 4 hours based on the following metrics, assume,

Time stamps	Total transactions
1st one hour	100
2nd one hour	200
3rd one hour	200
4th one hour	50

Total transaction of the API A for 4 hours=100+200+250+100=550

Assume the total transactions of the API B for 4 hours are 450.

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

API	Total transactions
A	550
B	450

Total transaction of all APIs for 4 hours=550+450=1000

With transactions trend analysis, you can compare the current and past transactions based on the time range you choose to spot changes.

\begin{array}{l} Transactions trend (%) for all APIs for 24 hours = \\ (\frac{Total transactions of APIs in last 24h - Total transactions of APIs in previous 24h}{Total transactions of APIs in previous 24h}) \times 100 \end{array}

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

A positive value, it is displayed in green with an upward arrow that indicates that the transaction volume is increased.
A negative value, it is displayed in red with a downward arrow that indicates that the transaction volume is decreased.

Example,

To determine the transactions trend percentage for all APIs for 24 hours,

Total transactions of APIs in the last 24 hours	Total transactions of APIs in the previous 24 hours (that is 24 hours prior to the last 24 hours)
1000	500

Transactions Trend percentage for 24 hours for all APIs =[(1000-500)/500]*100 = 100%

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

Error rate

The 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.

The Upward Trending tab displays the list of APIs forwhich the error rate trend percentage is lesser than the set error rate trend threshold. 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.

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

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

Example,

To determine the error rate of the API A for 4 hours based on the following metrics, assume,

Time Stamps	Error count	Total transactions
1st one hour	150	300
2nd one hour	115	200
3rd one hour	30	500
4th one hour	100	300

Error rate of the API A for 4 hours=[(300+200+500+300)/(150+115+30+100)∗100]=35.90%

Assume the error rate of the API B for 4 hours is 50%

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

To determine the error rate of all APIs for 4 hours, assume,

API	Error count	Total transactions
A	395	1100
B	250	500

Error rate of all APIs for 4 hours=[(395+250)/(1100+500)∗100]=40.31%

With error rate trend analysis, you can compare current and past error rates based on the time range you choose to spot changes.

\begin{array}{l} Error rate trend (%) for all APIs for 24 hours = \\ (\frac{Error rate of all APIs in last 24h - Error rate of all APIs in previous 24h}{Error rate of all APIs in previous 24h}) \times 100 \end{array}

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

A positive value, it is displayed in red with an upward arrow, which indicates that the error rate is increased.
A negative value, it is displayed in green with a downward arrow, which indicates that the error rate is decreased.

Example,

To determine the error rate trend percentage for all APIs for 24 hours, assume,

Error rate of all APIs in the last 24 hours	Error rate of all APIs in the previous 24 hours (that is 24 hours prior to the last 24 hours)
35.90%	50%

Error rate trend percentage for 24 hours filter for all APIs = [(0.35-0.50)/0.50] * 100 = -30%

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

Response time

Response time indicates the total time that is taken to process an incoming API request and send the response to the client during API transactions. It includes the time that is taken by the runtime 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 APIs with maximum and minimum latency 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.

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. The Downward trending tab displays the list of APIs for which the response time trend percentage is greater than the set response time trend threshold.

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

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

Example,

To determine the response time of the API A for 4 hours based on the following metrics, assume,

Time Stamps	Response time	Total transactions
1st one hour	1.05 ms	10
2nd one hour	2.07 ms	15
3rd one hour	0.08 ms	20
4th one hour	1.07 ms	30

Response time of the API A for 4 hours=[((1.05∗10)+(2.07∗15)+(0.08∗20)+(1.07∗30))/75]=1.00 ms

Assume the response time of the API B for 4 hours is 0.05 ms.

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

To determine the response time of all APIs for 4 hours, assume,

API	Response time	Total transactions
A	1.00 ms	75
B	0.05 ms	60

Response time of all APIs=[((1.00∗75)+(0.05∗60))/135]=0.57 ms

With response time trend analysis, you can compare the current and past response time based on the time range you choose to spot changes.

\begin{array}{l} Response time trend (%) for all APIs for 24 hours = \\ (\frac{Response Time of all APIs in last 24h - Response Time of all APIs in previous 24h}{Response Time of all APIs in previous 24h}) \times 100 \end{array}

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

A positive value, it is displayed in red with an upward arrow that indicates the response time is increased.
A negative value, it is displayed in green with a downward arrow that indicates the response time is increased.

Example,

To determine the response time trend percentage for all APIs for 24 hours, assume,

Response time of all APIs in the last 24 hours	Response time of all APIs in the previous 24 hours (that is 24 hours prior to the last 24 hours)
0.57 ms	3.41 ms

Response time trend percentage for APIs for 24 hours time range= [(0.57-3.41)/3.41] * 100 = -83.28%

The determined response time trend percentage, -83.28% (negative), appears in green with a downward arrow that indicates the error rate is decreased compared to the previous 24 hours.

Latency

Latency indicates the time that is taken by the runtime to process an API request during API transactions. It does not include the time that is 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.

The Upward Trending tab displays the list of APIs for which the latency trend percentage is lesser than the set latency trend threshold. The Downward trending tab displays the list of APIs for which the latency trend percentage is greater than the set latency trend threshold.

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

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

Example,

To determine the latency of the API A for 4 hours based on the following metrics, assume,

Time Stamps	Latency	Total transactions
1st one hour	0.05 ms	10
2nd one hour	0.07 ms	15
3rd one hour	0.08 ms	20
4th one hour	0.07 ms	30

Response time of the API A for 4 hours=[((0.05∗10)+(0.07∗15)+(0.08∗20)+(0.07∗30))/75]=0.04 ms

Assume the latency of the API B for 4 hours is 0.05 ms

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

To determine the latency of all APIs for 4 hours, assume,

API	Response time	Total transactions
A	0.04 ms	75
B	0.05 ms	60

The latency of all APIs=[((0.04∗75)+(0.05∗60))/135]=0.04 ms

With the latency trend analysis, you can compare the current and past latency based on the time range you choose to spot changes.

\begin{array}{l} Latency trend (%) for all APIs for 24 hours = \\ (\frac{Latency of all APIs in last 24h - Latency of all APIs in previous 24h}{Latency of all APIs in previous 24h}) \times 100 \end{array}

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

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

Example,

To determine the latency trend percentage for all APIs for 24 hours, assume,

Latency of all APIs in the last 24 hours	Latency of all APIs in the previous 24 hours
0.04 ms	3.41 ms

Response time trend percentage for APIs for 24 hours time range= [(0.04-3.41)/3.41] * 100 = -98.82%

The determined response time trend percentage, -98.82% (negative), appears in green with a downward arrow that indicates the error rate is decreased compared to the previous 24 hours.