Accessing and configuring analytics

Monitor the usage and performance of API calls by using the analytics feature to view, filter, sort, and aggregate your API event data.

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 on your gateways. The captured event data can be viewed and exported from the Cloud Manager UI, API Manager UI, toolkit CLI or REST API. The API event data can also be offloaded to third-party systems as it is generated.

API event records

An API event is logged each time an API operation is invoked on the Gateway server. The API event record contains information about the API call. When an analytics service is associated with a gateway, all API invocations on that gateway are captured as API event records and sent to the analytics service. 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 they are 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. Some options are configured during installation, while other options are easily changed after your Analytics subsystem is in service.