Catalogs, Spaces, and Analytics

Understand how syndication and the use of Catalogs and Spaces affects the use of the features in API Connect Analytics.

The data for Analytics is collated from API events that are logged when API operations are invoked. Analytics data for an API is scoped to the Catalog or Space where that API resides, and is only included in search results (and thus, visualizations and dashboards) for the owning Catalog or Space.

Access to the analytics data, and to the analytics functions in the API Manager user interface, can be managed through the use of Catalogs and Spaces, and the roles and permissions that are assigned to the users (or members) of the provider organization.

The cloud admin user can view aggregated analytics data for all catalogs, spaces, in all provider organizations, in the admin UI.

Catalogs, Spaces, and permissions

Catalogs act as deployment targets through which APIs (in their containing Plans and Products) are staged and published to consumer organizations. API Manager users in the provider organization can be assigned the following access to the Analytics component for a Catalog:
  • A role that has the Analytics > View permission for a Catalog: These users can view the analytics data generated for the APIs in the Catalog within dashboards, export dashboard data in its raw format or as event records, and apply filters to the data shown within the dashboards.
  • A role that has the Analytics > Manage permission for a Catalog: This is a legacy permission and has the same permissions as the View permission.
The IBM® API Connect syndication feature provides a way for you to partition a Catalog into multiple deployment targets (or Spaces) through which separate groupings of APIs (in their containing Plans and Products) can be staged and published. Each Space can be allocated to a separate group of users who need to manage their Products independently, and the analytics data in each Space is scoped to those Products only. API Manager users in the provider organization can be assigned the following access to the Analytics component for a Space:
  • A role that has the Analytics > View permission for a Space: These users can view the analytics data generated for the APIs in the Space within dashboards, export dashboard data in its raw format, and apply filters to the data shown within the dashboards.
  • A role that has the Analytics > Manage permission for a Catalog: This is a legacy permission and has the same permissions as the View permission.

For more information about assigning Catalog or Space permissions to a role, see Managing Catalog membership and Managing Space membership.

For more information about the default API Manager roles and permissions, see API Connect user roles.