Configuring Analytics to collect API event data

Configure the collection of API event data so it can be filtered, sorted, and aggregated to help you review usage and performance.

Use the API Connect Analytics service to monitor API usage and performance. API analytics provide data to help you manage service levels, set quotas, establish controls, set up security policies, manage communities, and analyze trends. The data for Analytics is collated from API events that are logged when API operations are invoked. The captured event data can be forwarded to the Analytics user interface in the API Connect API Manager or offloaded to third-party systems.

API event records

An API event is logged each time an API operation is invoked, and an event record is generated for each API event on the Gateway server. The API event record contains information about the API call. When an analytics service is associated with a gateway, it will capture API events. The content of the record depends on the logging policy that is set for the operation. For more information about the fields that are displayed in an API event record, see API event record fields.

Analytics configuration options

API Connect offers several configuration options to customize data collection, storage, and retention. For example, you can define filters that refine data to add or remove fields before it is stored. You can choose to offload some, or all, of the data to a third-party storage system. You can choose whether to store any Analytics data in API Connect. If you offload all of your Analytics data, you can disable the Analytics UI in API Connect. Some options are configured during installation, while other options are easily changed even after your Analytics subsystem is in service.