API Analytics Dashboards

The API analytics dashboards provide charts to monitor API usage, which gives you insight into how your APIs are used and how they are performing.

If you have enabled API auto-discovery, your API metrics are available in the API analytics dashboards in Anypoint Monitoring.

The API analytics dashboard includes two views: enhanced metrics and basic metrics. The enhanced metrics view includes detailed information about your APIs, and charts are sorted into dashboards based on the type of data displayed. To get the most out of Anypoint Monitoring, use the enhanced metrics view to see information related to your APIs.

By default, the enhanced metrics view is selected. To switch views, select Switch to classic metrics. From the classic metrics view, select Show new metrics view.

Charts displaying the Last 1 hour label show data that has been collected during the past 60 minutes, starting with the current time.

For Gold and Platinum subscriptions, Anypoint Monitoring retains API analytics metrics data for 90 days. API Manager retains API analytics metrics data for 30 days.

Supported Versions of Mule Runtime Engine

Use the following Mule runtime engine versions with Anypoint Monitoring:

  • Mule 3 versions 3.8.7 and later
    Versions 3.8.6 and earlier are not supported. Additionally, all runtime versions that have the -AM suffix are deprecated.

  • Mule 4
    To use enhanced metrics for API Analytics, use Mule runtime engine version 4.1.6 or later.

View the API Analytics Dashboard

  1. Log in to Anypoint Platform.

  2. In the navigation bar or the main Anypoint Platform screen, click Monitoring.

  3. Select the Environment, Resource name, and Version/Instance for the API to view.

  4. Click View.
    On the API analytics page, you can view information about a running, managed API.

  5. Select the date and time range you want to view statistics for and click Confirm.
    The details panel at the top of the page displays information about the API.

    api analytics detail panel
  6. If you want to view API analytics metrics in API Manager, click the View API in API Manager link.

Enhanced Metrics View for API Analytics Dashboards

API analytics dashboards provide you with various pages from which you can view different types of charts.

The following charts are available in the enhanced metrics view for API analytics:

API Analytics Dashboards Charts

Overview Charts

  • Request Volume

  • Failed Requests

  • Total 4xx Errors

  • Total 5xx Errors

  • Policy Violations

  • Average Response Time

Requests Charts

  • Requests

  • Requests by Method

  • Requests by Response Code

  • Requests by Request Size

  • Requests by Response Size

Failures Charts

  • Failures

  • Failures by Method

  • Requests by Response Code

  • Requests by Request Size

  • Requests by Response Size

Performance Charts

  • Requests by Performance (line chart)

  • Requests by Performance (table)

  • Slow Requests (requires Titanium)

Client Applications Charts

  • Requests by Client ID

  • Requests by Client IP

  • Requests by Location

Overview Charts

The following charts appear on the Overview dashboard:

Request Volume

The sum of requests in the selected time period for the given API. Data is aggregated in one minute increments.

Failed Requests

The sum of failed requests in the selected time period for the given API. Data is aggregated in one minute increments.

Total 4xx Errors

The sum of 400 errors (such as 404, 408, and so on) in the selected time period for the given API.

Total 5xx Errors

The sum of 500 errors (such as 500, 502, and so on) in the selected time period for the given API.

Policy Violations

The sum of requests for policy violations in the selected time period, grouped by policy violation ID. Data is aggregated in one minute increments.

Average Response Time

The average response time of requests in the selected time period for the given API. Data is aggregated in one minute increments.

Requests Charts

The following charts appear on the Requests dashboard:

Requests

The sum of requests in the selected time period, grouped by the top N paths. By default, N is 100.

  • If you select a time range within the last hour, data is aggregated in one minute increments.

  • If you select a time range within the last day, data is aggregated in ten minute increments.

  • If you select a time range that is larger than one day, data is aggregated in one hour increments.

Requests by Method

The sum of requests in the selected time period, grouped by method. Data is aggregated in one minute increments.

Requests by Response Code

The sum of requests in the selected time period, grouped by response code. Data is aggregated in one minute increments.

Requests by Request Size

The sum of requests in the selected time period, grouped by request size. Data is aggregated in one minute increments.

Requests by Response Size

The sum of requests in the selected time period, grouped by response size. Data is aggregated in one minute increments.

Failures Charts

The following charts appear on the Failures dashboard:

Failures

The sum of failed requests in the selected time period, grouped by the top N paths. By default, N is 100.

  • If you select a time range within the last hour, data is aggregated in one minute increments.

  • If you select a time range within the last day, data is aggregated in ten minute increments.

  • If you select a time range that is larger than one day, data is aggregated in one hour increments.

Failures by Method

The sum of failed requests in the selected time period, grouped by method. Data is aggregated in one minute increments.

Requests by Response Code

The sum of failed requests in the selected time period, grouped by response code. Data is aggregated in one minute increments.

Requests by Request Size

The sum of failed requests in the selected time period, grouped by request size. Data is aggregated in one minute increments.

Requests by Response Size

The sum of failed requests in the selected time period, grouped by response size. Data is aggregated in one minute increments.

Performance Charts

The following charts appear on the Performance dashboard:

Requests by Performance (line chart)

The average request response times, grouped by path.

  • If you select a time range within the last hour, data is aggregated in one minute increments.

  • If you select a time range within the last day, data is aggregated in ten minute increments.

  • If you select a time range that is larger than one day, data is aggregated in one hour increments.

Requests by Performance (table)

The average request response times, grouped by path.

  • If you select a time range within the last hour, data is aggregated in one minute increments.

  • If you select a time range within the last day, data is aggregated in ten minute increments.

  • If you select a time range that is larger than one day, data is aggregated in one hour increments.

Slow Requests

The average response times that are greater than one second, grouped by path. This chart is available only for Titanium users.

  • If you select a time range within the last hour, data is aggregated in one minute increments.

  • If you select a time range within the last day, data is aggregated in ten minute increments.

  • If you select a time range that is larger than one day, data is aggregated in one hour increments.

Client Applications Charts

The following charts appear on the Client Applications dashboards:

Requests by Client ID

The sum of requests in the period, grouped by client ID. Data is aggregated in one minute increments.

Requests by Client IP

The sum of requests in the period, grouped by client IP address.

  • If you select a time range within the last hour, data is aggregated in one minute increments.

  • If you select a time range within the last day, data is aggregated in ten minute increments.

  • If you select a time range that is larger than one day, data is aggregated in one hour increments.

Requests by Location

The sum of requests during the time period specified, grouped by country. Data retention for the Requests by Location chart is one hour.

Basic Metrics View

The following charts are available in the Overview section of built-in dashboards for APIs:

  • Requests

  • Requests by HTTP response code

  • Requests by method

  • Requests (Avg), Average Size of Requests, and Average Size of Responses

  • Requests by HTTP policy violation

  • Requests by failure

Requests

You can view the metrics for how many times the particular instance of this API was requested over the specified period of time. Hover over the graph to display data in a more granular view.

api request by instance

Requests by HTTP Response Code

Displays data about the API instance’s total number of requests by HTTP response code for the time period you specified, including:

Status Code

HTTP response code for the API call.

Sum

Total number of requests with the corresponding response code.

Click the column header to sort data for that column.

api requests by http response

Requests by Method

Displays metrics about the API’s requests by method, including:

Method

The method used to call the API.

Avg

The average of all the non-null values in the series.

Min

The smallest value in the series.

Max

The largest value in the series.

Total

The sum of all values in the series.

Click the column header to sort data for that column.

api request by method

Requests, Average Size of Requests, and Average Size of Responses

Displays metrics according to the API’s request and response sizes, including:

Requests (Avg)

Average number of requests per minute.

Average Size of Requests

Average size of requests per minute (bytes).

Average Size of Responses

Average size of responses per minute (bytes).

api request by request and response size

Requests by HTTP Policy Violation

Displays metrics for traffic that was rejected or not rejected for the specified policy, including:

Policy

The name of the policy applied to the API instance.

Avg

The average of all the non-null values in the series.

Min

The smallest value in the series.

Max

The largest value in the series.

Total

The sum of all values in the series.

Click the column header to sort data for that column.

api request by http policy violation

Requests by Failures

Displays information about failed requests to the API, including:

Error code

The HTTP error code corresponding the failure type.

Avg

The average of all the non-null values in the series.

Min

The smallest value in the series.

Max

The largest value in the series.

Total

The sum of all values in the series.

Click the column header to sort data for that column.

api request by failure

Anypoint Monitoring Archive API

Titanium users can also access API analytics metrics data directly via the Anypoint Monitoring Archive API. Using this API, you can navigate and discover your API metrics data using a directory hierarchy.

The Anypoint Monitoring Archive API enables you to download files that contain JSON objects that represent one or more metric events. You can also write an application to navigate the data collected by the API and integrate it into your own system.

Titanium users can also enable non-aggregated API events by setting this property: anypoint.platform.config.analytics.agent.api_raw_metrics.enabled=true. These events contain more detailed information about each API invocation and can be accessed using the Anypoint Monitoring Archive API under the raw file type.

For more information about this API, see the Anypoint Monitoring Archive API page in Anypoint Exchange.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Give us your feedback!
We want to build the best documentation experience for you!
Help us improve with your feedback.
Take the survey!