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:
- Summary
- View high-level metrics, including call volumes, latency, and time-based trends.
- Consumption
- Track the total number of API calls processed by gateways over time. Use this data for consumption-based licensing.
- APIs
- Identify which APIs are being called and which are not.
- Products
- See which products are most popular overall and how their usage changes over time.
- Consumers
- Determine which consumer organizations make the most API calls, both in total and over time.
- Applications
- Analyze which applications generate the highest number of API calls, overall and over time.
- AI Usage
- Monitor usage of your AI services. Track token counts and AI model usage by consumer.
- 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 Transfer
- Analyze request and response payload sizes. Identify APIs, consumers, and applications responsible for the largest payloads.
- 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.
- Gateway Operations
- View call volume and latency for each gateway in each gateway service. Use this data to check load distribution and identify underperforming gateways.
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:
It is also possible to enlarge the chart to full-screen by clicking 
. To see the source
data in tabular form click 
.
Discover view
By default the Dashboards tab is displayed. To view your API event data in
tabular form, select Discover:
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: 
Reports view
By default, the Dashboards tab is displayed. To access reports, select Reports. The reports view is designed for long-term data retention and analysis. Reports focus on historical trends and storage efficiency, making them ideal for strategic insights. Filtering options are optimized for extended time ranges, such as last 30 days, last 90 days, or more.
- Call volume trend
- Analyze long-term trends in API call volume across APIs, products, and plans.
- Consumer trend
- Track long-term trends in application counts, subscription counts, and API call volumes for consumer organizations and applications.
- Consumption report
- Review long-term trends in API calls processed by gateways at this scope. Use this data for consumption-based licensing.
- Inactive products
- Identify products without subscriptions or traffic that may require promotion or deprecation.
- Inactive consumer organizations
- Discover which consumer organizations are not actively consuming APIs.
- Deprecated products
- Identify deprecated products that still receive traffic. Consider migrating these consumers to a replacement plan.
To download an API call volume leaderboard, scroll down the page and click the Download icon for the leaderboard that you want. The leaderboard provides a ranked overview of the most frequently accessed APIs, products, plans, applications, consumer organizations, gateway services, config-sync data and Breakdown by catalog. If space is enabled at the catalog, the leaderboard includes a space leaderboard.
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:
- 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=last30daysSet a default query in analytics
- 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.