Frequently Asked Questions

Analytics in IBM® API Connect provides visibility into API usage, performance, and consumer behavior. This topic answers common questions to help you understand and use analytics effectively.

Analytics

What is API Analytics in IBM API Connect?

API analytics provides insights into API usage, performance, and consumer behavior across the API Connect platform. For more information, see Key concepts of API Connect analytics.

How do I access analytics dashboards?

1. Log in to the API Manager user interface.
2. Verify that you have the required permissions.
3. Click Analytics icon in the navigation pane. For more information, see Analytics dashboards.

Can I export analytics data?

Yes, you can export analytics data using either the toolkit CLI or the REST API. The analytics export function in the UIs only exports the data displayed in the UI and is limited to 200 API events per page. For more extensive exports, use the toolkit CLI to export up to 10,000 API event records or the REST API to export all your analytics data. For more information, see Export your analytics data.

Can I filter analytics by time range?

Yes, dashboards support filtering by predefined or custom time ranges. For more information, see Filtering displayed data.

Can I view analytics by consumer organization?

Yes, you can filter analytics by consumer organization to understand usage patterns. For more information, see Filtering displayed data.

How do I interpret latency metrics?

Latency metrics in the API Manager UI indicate how long APIs take to return a response, and how this latency changes over time. You can view these metrics in the 'Latency' dashboard. The data is presented alongside a breakdown of HTTP response codes to give a comprehensive view of API performance. To interpret these metrics, look for trends in latency over time. An increasing latency could suggest a performance issue, while stable or decreasing latency indicates efficient API operation. Additionally, comparing current latency values to historical data can help identify if recent changes have negatively impacted API response times. For more information, see Analytics dashboards.

Is analytics data available via CLI?

Yes, analytics data is available via the API Connect toolkit CLI. For more information, see Analytics CLI.

Can I view analytics for GraphQL APIs?

Yes, GraphQL APIs are included in analytics with metrics similar to REST APIs.

How do I enable analytics in a Catalog?

To enable Analytics, enable a gateway. When the gateway is enabled, Analytics is automatically enabled. For more information, see Creating and configuring catalogs.