Overview of API Monitoring

This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

After you build and launch your APIs on Apigee, you needto ensure that they are available and performing as expected in order tomaintain uninterrupted service. Apigee's API Monitoring enables you totrack your APIs to make sure they are up and running correctly.API Monitoring provides near real-time insights into API traffic and performance, tohelp you quickly diagnose and solve issues as they arise.

API Monitoring enables you to:

  • Create alerts to notify you of changes in API traffic so you cantake appropriate action before customers are affected.
  • Increase API availability and reduce the mean-time-to-diagnosis (MTTD) byquickly investigating issues with your APIs.
  • Leverage fault codes to speed diagnosis.
  • Isolate problem areas quickly to diagnose errors, performance, and latencyissues and their source.

As an Apigee customer, you can also useCloud Monitoringtools to support API Monitoring.

About data retention: API Monitoring logs capture query parameter and user agent data. Since this data may contain personally identifiable information (PII), it is retained for6 weeks, then deleted per the Google Privacy Policy. For more details, see Data retention.Apigee hybrid users: Do notdisable metrics in your hybrid configuration if you intend to view API Monitoring data.Metrics must be enabled inyour hybrid configuration for API Monitoring data to show up. Metrics is enabled for hybrid by default.

API Monitoring roles

To access API Monitoring, you need to be assigned the following roles:

  • roles/apigee.readOnlyAdmin
  • roles/monitoring.viewer

SeeApigee roles for moreinformation about what roles are appropriate for using API Monitoring.

Accessing API Monitoring

You can access API Monitoring through the Apigee UI by doing the followingsteps:

In the Google Cloud console, go to theProxy Development> API monitoring page.

Go to API monitoring

This displays the main API Monitoring view. In theView menu, you canselect one of the following views:

  • Timeline: Displays timelines of recent API traffic data.
  • Investigate: Displays tables of API traffic data, such as fault code by region.
  • Recent: Displays treemaps of data in which each proxy is represented by a rectangle, whose size is proportional to the amount of API traffic for the proxy, and whose color denotes the relative size of related metrics.
The following sections describe these views in detail:

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.