The Analytics page within the API Manager allows you to review the consumption and performance metrics for all your APIs and to facilitate decision-making, troubleshoot issues, promote consumption, monitor performance and security, and prevent misuse or abuse. The data displays within multiple graphs and correlated charts. You can adjust what data each graph displays, as well as the time frame and scale of the graph, using the Filter by and View Data dropdowns located along the top of the page.
You must have already published an API and executed at least one API request in order to see API analytic data.
To access the Analytics page, log in to the Harmony portal and select the API Manager card. Click on the My APIs dropdown menu and select Analytics from the list.
The top of the Analytics page should display as shown in the image below.
The Filter by dropdowns allow you to interactively drill down into each section for more detailed views into specific target criteria across any combination of environments, APIs, profiles, status codes, and versions as needed.
Each filter displays a dropdown list of criteria from which you can select one or multiple criteria. The default value for each filter is All.
The filters display along the top of the page to the right of the My APIs dropdown menu. Each filter is described below.
Status Codes: The dropdown displays HTTP response status codes by group (i.e. Success (2xx), Redirections (3xx), Client Errors (4xx), Server Errors (5xx)). For reference see w3.org status code definitions. Select one status code group to filter the activity to API requests that are assigned a status code within the selected group or select multiple status codes to view a larger subset.
The View Data options allow you to select the granularity (unit of time) against which the traffic is calculated and the period of time to display within each of the three graphs. The View Data menus display to the right of the filters at the top of the page. The first dropdown menu allows you to select the unit of time and the second dropdown allows you to select the period of time. The default setting for the period of time is Last 7 Days and the default setting for unit of time is Days.
The granularity options correlate directly to the time period selected. For that reason, it is best to select the time period first. Two units of time are available for each selected period of time. The larger of the two units of time is automatically set as the default. In the image below, the period of time selected is Last 24 Hours, the units of time available are Days and Hours, and Hours displays as the default.
Select the period of time to display within the graph from the six distinct options as shown in the image below. You also have the option to select Custom Period in the list and define the period of time by entering the date and time to start and end.
The additional options display directly above the first graph displayed on the page.
The analytics data presented within the graphs and charts refreshes dynamically as you select filter options and drill down to specific target criteria. You can also manually refresh the displayed analytics data by clicking on the Refresh link. View Last Refreshed displays the last time the data was refreshed either dynamically or manually (time format: h:mm:ss AM/PM).
You can manually refresh the analytics data by clicking on the Refresh link.
You can download all the data presented within the graphs on the page by selecting the Download as CSV link. Three files are created: hits.csv, response-time.csv, and status-code.csv.
The date field within the CSV files is a UNIX timestamp that will require conversion if you want to use a different date and time format.
The Analytics Dashboard displays the top 10 consumption within the selected period of time by these categories: