After you build and launch your APIs on Apigee, you need
to ensure that they are available and performing as expected in order to
maintain uninterrupted service. Apigee's API Monitoring enables you to
track your APIs to make sure they are up and running correctly.
API Monitoring provides near real-time insights into API traffic and performance, to
help 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 can
take appropriate action before customers are affected.
Increase API availability and reduce the mean-time-to-diagnosis (MTTD) by
quickly investigating issues with your APIs.
Leverage fault codes to speed diagnosis.
Isolate problem areas quickly to diagnose errors, performance, and latency
issues and their source.
As an Apigee customer, you can also use
Cloud Monitoring
tools to support API Monitoring.
API Monitoring roles
To access API Monitoring, you need to be assigned the following roles:
roles/apigee.readOnlyAdmin
roles/monitoring.viewer
See Apigee roles for more
information about what roles are appropriate for using API Monitoring.
Accessing API Monitoring
You can access API Monitoring through the Apigee UI by doing the following
steps:
Apigee in Cloud console
In the Google Cloud console, go to the Proxy Development > API monitoring page.
This displays the main API Monitoring view. In the View menu, you can
select 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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis page covers API Monitoring for both Apigee and Apigee hybrid, enabling users to track API performance and availability.\u003c/p\u003e\n"],["\u003cp\u003eAPI Monitoring provides near real-time insights into API traffic and performance, allowing users to diagnose and resolve issues promptly, create alerts, and reduce mean-time-to-diagnosis.\u003c/p\u003e\n"],["\u003cp\u003eAPI Monitoring data, including query parameters and user agent information, is retained for six weeks before being deleted in accordance with Google's Privacy Policy.\u003c/p\u003e\n"],["\u003cp\u003eAccessing API Monitoring is available through either the Apigee UI in Cloud console or the classic Apigee UI, providing options to view timelines, investigate issues, or examine recent data.\u003c/p\u003e\n"],["\u003cp\u003eTo use API Monitoring, users need the \u003ccode\u003eroles/apigee.readOnlyAdmin\u003c/code\u003e and \u003ccode\u003eroles/monitoring.viewer\u003c/code\u003e roles, and Apigee hybrid users must have metrics enabled in their hybrid configuration.\u003c/p\u003e\n"]]],[],null,["*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\u003cbr /\u003e\n\nAfter you build and launch your APIs on Apigee, you need\nto ensure that they are available and performing as expected in order to\nmaintain uninterrupted service. Apigee's API Monitoring enables you to\ntrack your APIs to make sure they are up and running correctly.\nAPI Monitoring provides near real-time insights into API traffic and performance, to\nhelp you quickly diagnose and solve issues as they arise.\n\nAPI Monitoring enables you to:\n\n- Create alerts to notify you of changes in API traffic so you can take appropriate action before customers are affected.\n- Increase API availability and reduce the mean-time-to-diagnosis (MTTD) by quickly investigating issues with your APIs.\n- Leverage fault codes to speed diagnosis.\n- Isolate problem areas quickly to diagnose errors, performance, and latency issues and their source.\n\nAs an Apigee customer, you can also use\n[Cloud Monitoring](https://cloud.google.com/monitoring/docs)\ntools to support API Monitoring.\n| **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 for **6 weeks** , then deleted per the [Google Privacy Policy](https://www.google.com/policies/privacy). For more details, see [Data retention](https://cloud.google.com/monitoring/quotas#data_retention_policy).\n| **Apigee hybrid users** : Do not disable metrics in your hybrid configuration if you intend to view API Monitoring data. [Metrics](/apigee/docs/hybrid/latest/metrics-enable) must be enabled in your hybrid configuration for API Monitoring data to show up. Metrics is enabled for hybrid by default.\n\nAPI Monitoring roles\n\nTo access API Monitoring, you need to be assigned the following roles:\n\n- `roles/apigee.readOnlyAdmin`\n- `roles/monitoring.viewer`\n\nSee [Apigee roles](https://cloud.google.com/iam/docs/understanding-roles#apigee-roles) for more\ninformation about what roles are appropriate for using API Monitoring.\n\nAccessing API Monitoring\n\nYou can access API Monitoring through the Apigee UI by doing the following\nsteps:\n\n\u003cbr /\u003e\n\nApigee in Cloud console\n\n1. In the Google Cloud console, go to the **Proxy Development \\\u003e API monitoring** page.\n2. [Go to API monitoring](https://console.cloud.google.com/apigee/apimonitoring)\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nClassic Apigee\n\n\u003cbr /\u003e\n\n1. Sign in to [Apigee UI](https://apigee.google.com).\n2. Select one of the following views:\n\n - **Analyze \\\u003e API Monitoring \\\u003e Timeline**\n - **Analyze \\\u003e API Monitoring \\\u003e Investigate**\n - **Analyze \\\u003e API Monitoring \\\u003e Recent**\n\nThis displays the main API Monitoring view. In the **View** menu, you can\nselect one of the following views:\n\n\u003cbr /\u003e\n\n- **Timeline**: Displays timelines of recent API traffic data.\n- **Investigate**: Displays tables of API traffic data, such as fault code by region.\n- **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.\n\nThe following sections describe these views in detail:\n\n\u003c!-- --\u003e\n\n- [Timeline](/apigee/docs/api-monitoring/timeline)\n- [Investigate](/apigee/docs/api-monitoring/investigate)\n- [Recent](/apigee/docs/api-monitoring/recent)\n\n\u003cbr /\u003e"]]
