API Health

Key metrics


Response time – Total processing time from the receipt of an API call by a front-end (proxy) API Gateway to the response being returned to the caller.

Responsiveness of service is a key metric for assessing service performance.
Failure rate – Percent of transactions completed with a "failure" status during the selected observation period.  Failures can occur in normal situations, however a high failure rate could signal that a service is not working properly.

Exception rate – raw count of transactions completed with an "exception" status.

Exception-prone API services can be related to a code defect in the application.

TPS – number of transactions per second.

A TPS much higher than expected is likely to negatively impact the overall service performance.

Each one of those metrics is evaluated against its corresponding threshold value, which a functional admistrator can modify at any time (see Configure thresholds for more information).

Observation periods / rhythms

The observation periods are:

  • The last 1 hour
  • The last 24 hours

Dashboards are refreshed every 5 minutes.


API health cockpit

This home dashboard provides:

  • An overview of the current activity and performance of both the API method and the Remote host level.
  • A list of the API methods at risk considering their response time, failure rate, and exception count. 

API method health

This dashboard presents the API method activity over the last observation period and enables you to get more accurate insights about the risks detected and their potential impact on consumer activity.

API methods list

This dashboard presents an exhaustive list of the existing API methods. Use the Global performance filter to retrieve the API methods for which at least one risk has been detected over the latest observation period.

APIs list

This dashboard presents the exhaustive list of the existing APIs.

Remote hosts list

 This dashboard presents the exhaustive list of the remote hosts called by the APIs and their activity and performance observed over the latest observation period.

Related Links