Analytics dashboards

IBM® API Connect analytics provides dashboards for viewing your analytics data.

Analytics dashboards

The analytics dashboards in the API Manager UI show the API event data at the scopes of provider organization, catalog, and space. The scope of the analytics data shown depends on how you access the analytics dashboards, see: Accessing analytics.

The provider organization scoped dashboards are accessed from the Analytics icon in the navigation pane:

The space scoped dashboards are accessed from the Analytics tab when viewing the space:

12 dashboards are available:

Summary: View high-level metrics, including call volumes, latency, and time-based trends.
API: Identify which APIs are being called and which are not.
Product: See which products are most popular overall and how their usage changes over time.
Consumer: Determine which consumer organizations make the most API calls, both in total and over time.
Application: Analyze which applications generate the highest number of API calls, overall and over time.
Client Information: See who is calling your APIs and from which devices.
Note: Only internet-accessible IP addresses can be resolved to a geographic location. Internal IP addresses are ignored. The GeoIP database is updated with each API Connect fix pack. Apply the latest fix pack to maintain accuracy.
Status: Review API call success and failure rates over time. Includes an HTTP response code breakdown.
Latency: Measure API response times. Identify the fastest and slowest APIs and track changes in response time over time.
Data: Analyze request and response payload sizes. Identify APIs, consumers, and applications responsible for the largest payloads.
Consumption: Track the total number of API calls processed by gateways over time. Use this data for consumption-based licensing.
Gateway: View call volume and latency for each gateway in each gateway service. Use this data to check load distribution and identify underperforming gateways.
AI: Monitor usage of your AI services. Track token counts and AI model usage by consumer.

Each chart in the dashboards can be exported as a PNG or JPG image. The source data for each chart can be exported as a JSON or CSV file. To export a chart, click Actions at the upper right: Analytics pie chart

It is also possible to enlarge the chart to full-screen by clicking Full screen icon . To see the source data in tabular form click Tabular icon .

Discover view

By default the Dashboards tab is displayed. To view your API event data in tabular form, select Discover: Analytics discover view

The maximum number of API events that can be accessed from the UI is 10,000. The maximum number of event records that can be displayed per page on the Discover view is 200.

You can export the API event data from this view by clicking Actions at the upper right: Export menu option

Note: When you export from the Discover view, only the data displayed on the current page of results is exported. If you want to export the data from all pages, you must export separately from each page.

Reports view

The reports view displays long-term summary data rather than individual API events. Analytics reports view

Note: The reports view was introduced in v10.0.6, and does not include data that was generated before upgrade to v10.0.6.

Call volume trends shows your most and least active APIs, total successful and failed API calls, total bytes sent and received, and totals based on scope. Analytics call volume trends tile

Consumer trends shows the number of consumers and subscription and applications counts over time: Analytics consumer trends tile

Consumption report shows long-term trends for API calls processed by gateways, which are essential for consumption-based licensing insights. consumption_report

Inactive products shows products that have no subscriptions, and products that have no traffic. Analytics inactive products tile

Inactive consumer organizations shows consumer organizations that have no applications, subscriptions, recent traffic, or no traffic at all. Analytics inactive consumer organizations tile

Deprecated products shows products that are deprecated but are still receiving traffic. Deprecated products report

The API leaderboard ranks all published APIs by the total number of calls. Analytics call volume leaderboard table

The Products leaderboard ranks all published products by the total number of API calls. Analytics call volume leaderboard table

The Plans leaderboard ranks all published plans by the total number of API calls. Analytics call volume leaderboard table

The Applications leaderboard ranks all published applications by the total number of API calls. Analytics call volume leaderboard table

The Consumer organizations leaderboard ranks all consumer organizations by the total number of API calls. Analytics call volume leaderboard table

The Gateway service leaderboard ranks all gateway services by the total number of API calls. Analytics call volume leaderboard table

Filtering displayed data

You can filter the data that is displayed in the Dashboards and Discover view by defining queries. Expand the Filters section to view, define, and apply analytics queries to your displayed data:

Analytics filter window

You can save and share the queries that you define:

Shared queries are visible to all users at the same scope. They are not visible to users in a different scope. For example, a query that is shared by a Cloud Manager UI user is not visible to an API Manager UI user. Within the API Manager UI, a query that is created at catalog scope is not visible to users viewing analytics data at provider organization scope.
Other users cannot edit or delete queries that you share, but they can create a duplicate query, which they can edit and share.
All queries have a name and an optional description. The name does not need to be unique.

Saved queries can be exported as strings for use in REST API and toolkit CLI queries, for example:

copies the following string to the clipboard:

api_name=equals:boo&timeframe=last30days

Set a default query in analytics

You can now set a default query that is automatically applied when you visit the Dashboard or Discover pages in Analytics. The default query is configured per user and per scope (organization, catalog, or space).

Note:

Only shared queries can be set as default queries.
Each scope can have one default query per user. A different default query can be set for each catalog and space.

Ensure that the query you want to set as default is saved.
To share the saved query, complete the following steps.
- Click Saved tab.
- From the options menu, click Share.
- In Share query window, click Share.
Click Shared tab.
From the options menu, click Set as default query.
In Default query window, click Default.
To apply the default query immediately. Click Apply. The default query is applied immediately for all users in that scope. If you do not click Apply after setting the default query, it is automatically applied the next time you visit the Dashboard or Discover tabs.