The API Request page provides the call information about each API in an application, which includes the call success rate, responses, and average response time (RT) of successful or failed API calls.

Description

The API Request page of ARMS frontend monitoring shows the following statistics:

  • Call success rate of each API
  • API responses
  • Average RT of successful API calls
  • Average RT of failed API calls

This page also shows the distribution of the preceding statistics in the following dimensions:

  • Geographical location
  • Browser
  • Operating systems
  • Device
  • Resolution
  • Version

Success rate of API calls

The Success Rate tab on the left ranks the success rates of API calls. The API Success Rate section on the right shows the curve of the call volume and call success rate of the API selected on the left within a specified time range. The API Link Trace (TOP 20) section on the right shows the traces of the top 20 failed and successful calls to the API. You can click Link Trace and View Details in the Actions column to check the trace and view details.

Success rate of API calls

API responses

The Message tab on the left ranks API responses. The Message Request Details section on the right shows the API calls of the API response selected on the left. These API calls are listed by call volume in descending order.

Message request details

RT for successful API calls

The Success RT tab on the left shows the average RT for successful API calls. The Success API Response Time section on the right shows two items: the average RT for successful API calls that is indicated by the curve and the number of successful calls that is shown in the bar chart.

RT for successful API calls

RT for failed API calls

The Failure RT tab on the left shows the average RT for failed API calls. The Failure API Response Time section on the right shows two items: the average RT for failed API calls that is indicated by the curve and the number of failed calls that is shown in the bar chart.

RT for failed API calls

Geographical view

In the Geographical View section, you can view the statistics of each geographical location. The Geographical View section consists of the China View and World View tabs. China View shows statistics by province in China, whereas World View shows statistics by country or region worldwide.

API geographical view

Terminal view

In the Terminal View section, you can view the statistics of each terminal. The Terminal View section consists of the Browser, OS, Device, and Resolution tabs.
API terminal view

Version view

In the Version View section, you can view the host version and application version of each application.
API version view

General operations

On the API Request page, you can perform the following general operations:

  • On a left-side tab, click the upward or downward arrow to change the order of the list. The upward arrow indicates the ascending order, whereas the downward arrow indicates the descending order.
  • In a right-side details section, click the list icon in the upper-right corner to switch between chart and table views. List of API success rates
  • In a right-side details section, click the clock icon in the upper-right corner to specify a time range.
    API time range