Accessing analytics

Analytics data is displayed in dashboards in the API Manager UI. Dashboards are scoped at the provider organization, Catalog, and Space level. Analytics are also accessible at the cloud level in the Cloud Manager UI, and using the Toolkit CLI and REST API.

About this task

The ability to access analytics data at a Catalog or Space level depends on your assigned roles and permissions. For more information about Catalogs and Spaces, see Working with Catalogs and Using syndication in API Connect.

Restriction: If the visualizations in your dashboards display no data or show data only for a time period in the past, a possible reason might be that access to analytics data within API Connect is switched off. Contact your administrator for confirmation. (For more information, see Configuring analytics offload for API Connect.)

Procedure

  • To open the analytics dashboard at Catalog scope, complete the following steps:
    1. In the API Manager UI, select Manage Manage Catalogs icon in the navigation pane.
    2. From the list of available Catalogs in the API Manager Dashboard, select the required Catalog.
    3. Click the Analytics tab.
      The analytics dashboard for the Catalog is displayed.
  • To open the analytics dashboard at Space scope, complete the following steps:
    1. In the API Manager UI, select Manage Manage Catalogs icon in the navigation pane.
    2. From the list of available Catalogs in the API Manager Dashboard, select the required Catalog.
    3. Click the Spaces tab.
    4. Select the Space that you want to view.
    5. Click the Analytics tab.
      The default analytics dashboard for the Space is displayed.
  • To view analytics at Provider Organization scope, in the API Manager UI, select the analytics icon Analytics icon from the navigation pane.
  • To view analytics at the Cloud level, in the Cloud Manager UI: Accessing cloud level analytics
  • You can also access Analytics data using the Toolkit CLI or the REST API: Accessing analytics data with the toolkit CLI