View api analytics
- 2. • Access the Analytics dashboard on Anypoint Platform to get insight into how your APIs are being used and how they are performing. After logging into Anypoint Platform, click API Manager.
- 3. Accessing the Analytics Dashboards • As an Organization Administrator or API Creator, you have access to the Analytics Dashboards for your organization. Click Analytics from the drop-down menu in the top-right of the window.
- 4. Navigating the Overview Dashboard • When you access the Analytics for your organization, by default you land on your Overview Dashboard. This dashboard 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.
- 5. • All of these charts display, by default, the data for all APIs in your organization for the past day. However, you can use the filters at the top left of the page to change the date range or filter to particular APIs. Note that the time ranges displayed automatically reflect your local time zone.
- 6. • All of the charts on the Overview Dashboard are cross-filtered. This means that if you filter the data on any one of these charts, the same filter is automatically 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.
- 7. • Note that even 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. CSV exports are limited to a maximum of 1 million records.
- 8. Creating Custom Charts • The Anypoint Platform for APIs allows you to create a wide variety of custom charts to display exactly the data that you wish to track for your APIs. You can display these charts on your Creating a 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, then grouped by violated policy type
- 9. Example Custom Chart: Policy Violations Per Application • Click Manage Charts and click New. • Name your chart Policy Violations Per Application. • Specify the Description as Number of violations per subscribed application • Select a Stack chart for its type:
- 10. • Keep the fields Data Source and Metric on their default values. • Since this is a stack chart, there are two levels of grouping that must be selected: the first defines the columns, the second defines the stacks within these columns. In the first grouping pick Application, to display each application in a different column; in the second grouping pick Violated Policy Name to tack these in each column. • Click Save Chart to have your chart created:
- 11. 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. Any other members of the Organization Administrator role do not share your custom charts or custom dashboard – these views are unique to each user. • If you have not created charts yet, see Creating Custom Charts. • To access your custom dashboard, click the Custom Dashboard tab at the top of the window:
- 12. • The first time you open your custom dashboard, it is blank. Click Edit Dashboard in the upper right. • 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. • If you don’t have any charts yet, see Creating Custom Charts. • 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. • Once you are satisfied with your custom dashboard, click Save Dashboard in the upper right. You are redirected to a view of your saved custom dashboard.
- 13. 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 to download a .csv file with the data for that chart.
- 14. • Note that the data that you download reflects the selection of the filtering options offered in the upper left corner of your dashboard. However, if you are exporting chart data from the Overview Dashboard and you have selected one or more subsections of a chart, the export files do not reflect that selection – instead any export always contains the full data for that chart without considering the chart-level filters that you may have applied.