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 settings icon Analytics icon in the navigation pane:

Analytics home page

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

Analytics tab

Seven dashboards are available:
  • API Dashboard- contains charts that summarize total API calls, response codes, and response times.
  • Product Dashboard - contains charts that show total API calls and application subscriptions per plan.
  • Monitoring Latency Dashboard - contains charts that provide response time statistics and data usage.
  • Monitoring Status Dashboard - contains charts that show the response codes and success/failure rates of API calls.
  • Usage Dashboard - contains charts that show the top five APIs, products, and apps.
  • Consumption Dashboard - contains charts that show total API consumption in your cloud.
  • Gateway Operations Dashboard - contains charts that show API usage and latency by gateway.

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:Status chart

It is also possible to enlarge the chart to full-screen by clicking Analytic full screen. 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

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 csv

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.

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:

Filters

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:

Edit 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.
  1. Ensure that the query you want to set as default is saved.
  2. To share the saved query, complete the following steps.
    • Click Saved tab.
    • From the options menu, click Share.
    • In Share query window, click Share.
  3. Click Shared tab.
  4. From the options menu, click Set as default query.Editanalytics_copy_query.png
  5. In Default query window, click Default.
  6. 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.