Skip to end of metadata
Go to start of metadata

Introduction

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.

Filter by

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.

  • Environments: The dropdown displays a list of the environments created within the Organization. Select one environment to filter the activity to only APIs created in that environment (URLs contain the environment name) or select multiple environments to view a larger subset. 
  • APIs: The dropdown displays a list of the APIs that are published within the Organization and includes all published versions of each API. Select one API to filter the activity to the specific version of one API or select multiple APIs to view a larger subset.
  • Profiles: The dropdown displays a list of the security profiles created within the Organization. Select one profile (i.e. a user or a group of users) to filter the activity to only users that access an API by authenticating through the selected profile or select multiple profiles to view a larger subset. 
  • 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.

  • Versions: The dropdown displays a list of published version numbers. This allows you to view API data by the individual version of an API. Select one version, multiple versions, or leave the default setting to view activity against all versions.

View Data 

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.

Unit of Time (Granularity)

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.

Period of Time

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. 


  • Last 10 Minutes: Displays API traffic within the past 10 minutes with the option to calculate hits by minutes or seconds.
  • Last 1 Hour: Displays API traffic within the past 1 hour with the option to calculate hits by minutes or seconds.
  • Last 10 Hours: Displays API traffic within the past 10 hours with the option to calculate hits by hours or minutes.
  • Last 24 Hours: Displays API traffic within the past 24 hours with the option to calculate hits by hours or minutes. 
  • Last 7 Days: Displays API traffic within the past 7 days with the option to calculate hits by days or hours.
  • Last 1 Month: Displays API traffic within the past 1 month with the option to calculate hits by days or hours.
  • Custom Period: Displays API traffic within the specified custom time period. When this option is selected, additional dropdowns become available.

    • Click on the calendar icon  in the From field to display the calendar showing the current date and time.
    • Click on the clock icon  to display the current time. Use the plus (+) and minus (-) symbols to set the desired hour and minutes. Then click the Set Time button to return to the calendar.
    • Use the greater than (<) and less than (>) symbols to scroll to the desired month and click on the desired day within the month.
    • Click the dropdown arrow next to the current year to display a list of years and select the desired year. Click Done at the bottom to close the calendar. The new starting date and time display in the From field. 
    • Repeat these steps within the To field to set the ending date and time for your custom time period.
    • The unit of time options available depend on the custom time period you defined. In the example above, the time period is 3 Months, the unit of time options are Days and Months, and Months displays as the default.

Additional Options

The additional options display directly above the first graph displayed on the page.

View Last Refreshed

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).

Refresh

You can manually refresh the analytics data by clicking on the Refresh link. 

Download as CSV 

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.

Hits Per Unit of Time

  • This graph displays the number of API hits per the selected unit of time across the selected period of time. In the example shown below, the unit of time is Days and the period of time is Last 1 Month.
  • The chart on the right side of the graph displays the average, minimum and maximum number of API hits per the selected unit of time.
  • The graph is also interactive. Hover over a data point to display the metrics as shown in the image below.
  • You can download the data displayed within the graph to a CSV file. See Download CSV above.

Response Times Per Unit of Time

  • This graph displays the response times in milliseconds for the API(s) per the selected unit of time across the selected period of time. In the example shown below, the unit of time is Days and the period of time is Last 1 Month
  • The API response times are plotted as three sets of data to ensure accuracy: one for each of the average, minimum, and maximum values. Each set is used for the summary calculations displayed in the chart to the right of the graph.
  • The graph is also interactive. Hover over a data point to display the metrics at that point in time.
  • You can download the data displayed within the graph to a CSV file. See Download a CSV above.

Status Code Per Unit of Time

  • This graph displays the API status codes per the selected unit of time across the selected period of time. In the example shown below the unit of time is Days and the period of time is Last 1 Month.
  • The graph is also interactive. Hover over a data point to display the metrics at that point in time.
  • You can download the data displayed within the graph to a CSV file. See Download a CSV above.

Analytics Dashboard

The Analytics Dashboard displays the top 10 consumption within the selected period of time by these categories:

  • IP addresses
  • Apps/Consumers
  • API Names (URLs)
On This Page

Related Topics

Last updated:  Dec 06, 2019


  • No labels