Analytics¶

Introduction¶

The Analytics page within the API Manager allows you to review the consumption and performance metrics for Custom APIs, OData Services, and Proxy APIs. The data is displayed within multiple graphs and correlated charts.

For more information on configuring and executing an API, see these resources:

• Custom APIs
• OData Services
• Proxy APIs

Accessing the Analytics Page¶

The Analytics page can be accessed from the Harmony Portal menu, or from other pages within API Manager:

• From the Home or Downloads pages, or from the Cloud Studio, Vinyl, Marketplace, Management Console, EDI, or Citizen Integrator applications, use the Harmony Portal menu in the top left to go to API Manager > Analytics:

  

• From the My APIs, Portal Manager, API Logs, Security Profiles, Trusted IP Groups or API Groups pages, use the API Manager navigation menu to select Analytics:

  

Analytics Page Header¶

The header along the top of the Analytics page includes the API Manager navigation menu and filters:

You can adjust the data each graph displays, as well as the time frame and scale of the graph, using the Filter by and View Data dropdowns.

Filter By¶

The Filter by dropdowns allow you to display 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.

These are the available criteria to filter by:

• Environments: Use the dropdown to select environments where the APIs are located. When all filters are unselected, environments for all APIs in the organization to which you have access are displayed.

• APIs: Use the dropdown to select published APIs within the organization. When all filters are unselected, all APIs in the organization to which you have access are displayed.

  Note

  Previously published APIs that become unpublished will not appear in the APIs dropdown. API logs for these APIs will be present on the API Logs page, but cannot be filtered.

• Profiles: Select the security profiles to filter the logs by. The dropdown displays security profiles created within the organization.

• Status Codes: Use the dropdown to select the HTTP response status code groups, selecting from Success (2xx), Redirections (3xx), Client Errors (4xx), and Server Errors (5xx). When all filters are unselected, all HTTP response status codes for APIs in the organizations to which you have access are displayed. For more information on status codes, see w3.org status code definitions.

• Versions: Use the dropdown to select the version number of the APIs. When all filters are unselected, all versions of the APIs in the organization to which you have access are displayed.

View Data¶

The View Data dropdowns allow you to filter the analytics data within a specific period of time:

The first dropdown allows you to select the unit of time. Select one of Days, Hours, Minutes, or Seconds. The default setting for the unit of time is Days.

The second dropdown allows you to select the period of time. Select one of Last 10 Minutes, Last 1 Hour, Last 10 Hours, Last 24 Hours, Last 7 Days, Last 1 Month, or Custom Period. The default setting for the period of time is Last 7 Days.

Selecting Custom Period allows you to filter the traffic by a specified time period. When this option is selected, additional From and To calendar fields display:

• From: Click to adjust the starting date and time for the analytics data.
• To: Click to adjust the ending date and time for the analytics data.

After clicking the From or To calendar fields, a calendar dialog is displayed where you select the date and time:

Additional Options¶

Additional options display directly above the first graph:

• View Last Refreshed: Displays the last time the data was refreshed either dynamically or manually. The time is displayed in the format h:mm:ss.

• Refresh: Click to refresh the analytics data based on the applied filters and search criteria.

• Download as CSV: Click to download the current analytics data based on the applied filters and search criteria.

  Note

  The date field within the CSV file is a UNIX timestamp that will require conversion if you want to use a different date and time format.

Hits¶

The Hits graph displays the number of API hits per the selected unit of time across the selected period of time. In this example, the unit of time is Days and the period of time is Last 1 Month:

The API hits are graphed as three sets of data: average, minimum, and maximum values. Each set is used for the summary calculations displayed in the chart to the right of the graph.

Hover over any data point to display the metrics:

You can download the data displayed within the graph to a CSV file. For more information, see Additional Options above.

Response Times¶

The Response Times graph displays the response times in milliseconds for the API(s) per the selected unit of time across the selected period of time. In this example, the unit of time is Days and the period of time is Last 1 Month:

The API response times are graphed as three sets of data: average, minimum, and maximum values. Each set is used for the summary calculations displayed in the chart to the right of the graph.

Hover over any data point to display the metrics:

You can download the data displayed within the graph to a CSV file. For more information, see Additional Options above.

Status Code¶

The Status Code graph displays the API status codes per the selected unit of time across the selected period of time. In this example, the unit of time is Days and the period of time is Last 1 Month:

Hover over any data point to display the metrics:

You can download the data displayed within the graph to a CSV file. For more information, see Additional Options above.

API Health Monitoring¶

The API Health Monitoring table shows a list of slow-running or active Custom API calls (occurring within a set timeframe) and their response times:

• Last: Enter a timeframe (in hours) to display Custom API calls that occurred within the configured timeframe. The default value is 24 hours. The minimum value allowed is 1 hour and maximum value allowed is 48 hours.

• Response threshold: Enter the response threshold (in seconds) to display Custom API calls with a response time equal to or greater than the provided threshold. The default value is 5 seconds and the minimum value allowed is 1 second. The number provided must be an integer.

• All Active APIs: Click to toggle the table between showing only Custom APIs whose Response Time is equal to or greater than the provided Response threshold (toggled off) or showing all active Custom APIs (toggled on) within the provided timeframe. When toggled on, the Response threshold field is disabled.

• API Name: The Custom API name. To change the sort order from descending (default) to ascending, click the arrows next to the column name.

• Version: The version of the Custom API (if provided).

• API Service URL: The API service URL.

• API Calls: The total number of calls to the Custom API within the provided timeframe.

• Average Response Time (sec): The average response time (in seconds) for the Custom API call.

Consumption Chart¶

The consumption chart displays the top 10 consumption metrics within the selected period:

• Top 10 IP Addresses: The top 10 IP addresses accessing the APIs created within API Manager.
• Top 10 Apps or Consumers: The top 10 consumers accessing the APIs created within API Manager.
• Top 10 APIs: The top 10 APIs being consumed by the IP addresses and API consumers.