---
schema_version: "1"
id: c955107a7f6397074181eb529840977f42086737a465b0bd6016d0e8acad6cef
title: Reviewing Mule API Analytics Usage
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/api-manager/latest/viewing-api-analytics.md
canonical_url: https://docs.mulesoft.com/api-manager/latest/viewing-api-analytics
source_site: docs.mulesoft.com
content_type: documentation
content_hash: c80db4560fc133672a5227aba4a76af12a9449ad5edeabf17af4ff08574a0fc9
description: MuleSoft Documentation Site
release: 2.x
latest: true
---
---
product: API Manager
version: 2.x
is-latest-version: true
keywords: analytics, dashboard
---

# Reviewing Mule API Analytics Usage

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can view your Mule API Analytics data from both API Manager and Anypoint Monitoring. API Manager
retains the Mule API Analytics data for up to 30 days. However, Anypoint Monitoring provides more
robust API usage data with a retention period of 30 days.

To view Mule API Analytics Data in API Manager:

1.  Navigate to **Anypoint Platform** > **API Manager**.

2.  Click **Mule API Analytics**.

From the dashboard, you can navigate to the analytics about your APIs gathered by Anypoint Platform.

For more information about how you can view your data in Anypoint Monitoring, see
[Monitoring Metrics from Anypoint Insights](https://docs.mulesoft.com/monitoring/anypoint-insights).

When you access the analytics for your Mule APIs, by default you land on your Overview Dashboard
that displays these charts:

- **Requests by Date**: Line chart that shows the number of requests for all APIs in your
  organization.

- **Requests by Location**: Map chart that shows the number of requests for each country of origin.

- **Requests by Application**: Bar chart that shows the number of requests from each of the top five
  registered applications.

- **Requests by Platform**: Ring chart that shows the number of requests broken down by platform.

![The API Manager Analytics dashboard.](/mulesoft/current/en-us/api-manager/latest/_images/overviewdash1.png)

By default, these charts display the data for APIs in your organization for the past day. You can
use the filters at the top left of the page to change the date range or filter to particular APIs.
The time ranges reflect your local time zone.

![The Date Range filter drop-down menu showing available date range selections.](/mulesoft/current/en-us/api-manager/latest/_images/filters.png)

When selecting a custom time interval, the numbers of request of your requests by day line chart are
not normalized. For example, monthly chart will show number of requests per 4 hours. For two months,
the same chart shows requests per 8 hours. If you are using a line chart in a custom dashboard and
need to define a custom interval, you need to explicitly set an aggregation interval.

All of the charts on the Overview Dashboard are cross-filtered. If you filter the data on any one of
these charts, the same filter is applied to the other charts on the page. Clicking an individual
application in the bar chart, for example, displays all of the requests from that application and
the locations for those requests on the map. Here’s how to filter data on individual charts.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Chart</th><th>How to filter data</th><th>How to clear your filter</th></tr></thead><tbody><tr><td><div><div><p><strong>Requests by Date</strong></p></div></div></td><td><div><div><p>Click and drag an area of the chart to filter to just that time period. Once you have the slider filter applied, you can drag the ends to adjust them as needed.</p></div></div></td><td><div><div><p>Click outside the area of the filtered portion.</p></div></div></td></tr><tr><td><div><div><p><strong>Requests by Location</strong></p></div></div></td><td><div><div><p>Click one or more countries to filter to just those results. Hover over a country for a tooltip displaying the name of the country and the total number of API requests received from that country for the selected time period.</p></div></div></td><td><div><div><p>Click the country or countries again to reset the map.</p></div></div></td></tr><tr><td><div><div><p><strong>Requests by Application</strong></p></div></div></td><td><div><div><p>Click one or more application bars to filter to just those results. Hover over an application’s data bar for a tooltip displaying the name of the application and the total number of requests from that application for that time period.</p></div></div></td><td><div><div><p>Click the application(s) again to reset the chart.</p></div></div></td></tr><tr><td><div><div><p><strong>Requests by Platform</strong></p></div></div></td><td><div><div><p>Click one or more segments to filter to just those results. Hover over a segment for a tooltip displaying the name of the application and the total number of requests from that application for that time period.</p></div></div></td><td><div><div><p>Click the segment(s) again to reset the chart.</p></div></div></td></tr></tbody></table>

To export the data for any of these charts, click the Export icon
(![Curved arrow](/mulesoft/current/en-us/api-manager/latest/_images/export.png)).

If you have filtered data on one of the charts to show only selected data, the export icon triggers
an export of a .csv file of the full data for that chart, filtered by whatever date range and API
selection you have made using the filters in the upper left of the page. Exported files are limited
to a maximum of 1 million records.

## Including Policy Violations on the Dashboard

**Note:** Users must have the `View Policies` permission set to view policies or edit a Policy
Violation alert. For more information, see [Setting permissions](https://docs.mulesoft.com/api-manager/latest/environment-permission-task).

Enable or disable the tracking of policy violations by checking the Include Policy Violations
checkbox on the dashboard. The dashboard will show traffic rejected, or not rejected, by a policy.

![The API Manager policy violations chart with the Include Policy Violations checkbox selected.](/mulesoft/current/en-us/api-manager/latest/_images/policy-violations-chart.png)

## Creating Custom Charts

You can create a wide variety of custom charts to display specific data on your custom dashboard.

For example, you can create custom charts that show:

- Hourly transactions per second between first day of the month and today, filtered by client ID,
  API version, or SLA tier.

- Per minute latency average in the last 24 hours, filtered by API or grouped by client geolocation.

- Number of policy violations grouped per subscribed application, per violated policy name

  Only charts that group by Violated Policy Name include events that triggered a policy violation.
  All other charts exclude these events. For example, an API gets 100 requests, 90 succeed, and 10
  are rejected by the rate-limiting policy. Charts that do not group by Violated Policy Name compute
  aggregates based on only the 90 requests that were not rate limited. Charts that group by Violated
  Policy Name, however, include all 100 requests in their computations.

To create a custom chart, click Manage Charts:

1.  Navigate to **API Manager** > **Mule API Analytics** > **Manage Charts** and click **New**.

    Create Chart appears.

    ![The create chart page.](/mulesoft/current/en-us/api-manager/latest/_images/createchart.png)

2.  Fill in a **Title**, and, optionally, a **Description**.

3.  Click a chart type graphic:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Icon</th><th>Chart Type</th><th>Chart Options</th></tr></thead><tbody><tr><td><div><div><p><span><img src="https://docs.mulesoft.com/api-manager/latest/_images/line-chart-icon.png" alt="Thumbnail graphic of a line chart."></span></p></div></div></td><td><div><div><p>Line chart</p></div></div></td><td><div><div><p>Data Source, Metric: <em>metrics</em> and Total, Data Interval: <em>durations</em></p></div></div></td></tr><tr><td><div><div><p><span><img src="https://docs.mulesoft.com/api-manager/latest/_images/bar-chart-icon.png" alt="Thumbnail graphic of a bar chart."></span></p></div></div></td><td><div><div><p>Bar chart</p></div></div></td><td><div><div><p>Data Source, Metric: <em>metrics</em> and Total, Group By: <em>categories</em></p></div></div></td></tr><tr><td><div><div><p><span><img src="https://docs.mulesoft.com/api-manager/latest/_images/stack-chart-icon.png" alt="Thumbnail graphic of a stack chart."></span></p></div></div></td><td><div><div><p>Stack chart</p></div></div></td><td><div><div><p>Data Source, Metric: <em>metrics</em> and Total, Group By: <em>categories</em>, Then By: <em>categories</em></p></div></div></td></tr><tr><td><div><div><p><span><img src="https://docs.mulesoft.com/api-manager/latest/_images/ring-chart-icon.png" alt="Thumbnail graphic of a ring chart."></span></p></div></div></td><td><div><div><p>Ring chart</p></div></div></td><td><div><div><p>Data Source, Metric: <em>metrics</em> and Total, Group By: <em>categories</em></p></div></div></td></tr><tr><td><div><div><p><span><img src="https://docs.mulesoft.com/api-manager/latest/_images/map-chart-icon.png" alt="Thumbnail graphic of a map chart."></span></p></div></div></td><td><div><div><p>Map chart</p></div></div></td><td><div><div><p>Data Source, Metric: <em>metrics</em> and Total</p></div></div></td></tr></tbody></table>

4.  Select a Data Source value:

    - All APIs in your organization

    - A specific API

5.  Select from one of the Metrics _metrics_ value and a Total:

    - Request Size (in bytes)

    - Requests

    - Response Size (in bytes)

    - Response Time (in milliseconds)

6.  For a Line Chart, select a Data Interval _durations_ value:

    - Minutes

    - Hours

    - Days

7.  For a Bar Chart or Stack Chart, select a category for Group By, and if your chart supports it, a
    category for Then By:

    - API Name

    - API Version

    - Application

    - Browser

    - City

    - Client IP

    - Continent

    - Country

    - Hardware Platform

    - OS Family

    - OS Major Version

    - OS Minor Version

    - OS Version

    - Postal Code

    - Resource Path

    - Status Code

    - Timezone

    - User Agent Type

    - User Agent Version

    - Verb

    - Violated Policy Name

      For Stack chart, you can group your data in two different dimensions. The first defines the
      distinct columns, the second defines the stacks within these columns. The same options are
      available on the second grouping dimension as on the first.

8.  Save the chart.

    The custom chart appears.

### Example Custom Chart: Policy Violations Per Application

1.  Navigate to **API Manager** > **Mule API Analytics** > **Manage Charts** and click **New**.

2.  In Title, type **Policy Violations Per Application**.

3.  In Description, type **Number of violations per subscribed application**

4.  Select a stack chart.

5.  In Data Source and Metric, accept the default values.

6.  Select two levels of grouping for the stack chart:

    - Select Application to display each application in a different column.

    - Select Violated Policy Name as the stack within each column.

      ![The bottom part of the create chart page showing Application selected for Group By and Violated Policy Name selected for Then By.](/mulesoft/current/en-us/api-manager/latest/_images/create-chart-2.png)

7.  Save the chart.

    The chart appears:

    ![A chart that shows policy violations grouped by application.](/mulesoft/current/en-us/api-manager/latest/_images/analytics-violated-policies-2.png)

## Creating a Custom Dashboard

After you create custom charts, you can display them side by side on a custom dashboard that is
unique to you.

To access your custom dashboard, click the Custom Dashboard. The first time you open your custom
dashboard, it is blank.

1.  Navigate to **API Manager** > **Mule API Analytics** > **Custom Dashboard** and click **Edit
    Dashboard**.

2.  Assuming you created custom charts, drag and drop charts from the drawer on the left of the
    screen onto your dashboard, rearranging them as needed into the order that you want.

3.  After you add a chart to your dashboard, you have the option to open it for editing or click the
    X to remove it from your dashboard.

4.  When you are satisfied with your custom dashboard, save it.

    The custom dashboard appears.

![A custom dashboard with several custom charts.](/mulesoft/current/en-us/api-manager/latest/_images/custom-dashboard.png)

Use the date range picker to adjust the time period for all the charts on your dashboard.

## Exporting Analytics Data

You can export your analytics data from the charts displayed on your Overview Dashboard or your
Custom Dashboard. On either dashboard, click the Export icon (![Curved arrow](/mulesoft/current/en-us/api-manager/latest/_images/export.png))
to download a CSV file with the data for that chart.

The data you download reflects filtering options you selected. However, if you are exporting chart
data from the Overview Dashboard and you have selected one or more subsections of a chart, the
exported files do not include filtering options. Exported files contain the full data for that
chart.

## See Also

- [Generate Mule API Analytics Reports with the Event API](https://docs.mulesoft.com/api-manager/latest/analytics-event-api)