Access API monitoring

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

You can access API Monitoring using the UI and API, as described below. To access API Monitoring, your Edge user must be assigned to one of the roles described below in API Monitoring roles.

API Monitoring roles

All Edge users must be assigned to a role, where the user's role determines the actions that the user is allowed to perform in Edge. Edge organizations come with built-in roles that predefine permissions based on different user types. Alternatively, you can assign a user to a custom role that you define.

Several predefined roles allow the user access to API monitoring features, as shown in the following table. Edge also defines two built-in roles, API Monitoring Administrator and API Monitoring User, that define the permissions required to access API monitoring only. The advantage to using these roles is that they restrict the user to being able to use API monitoring, but not to perform other actions such as creating, updating, or deleting API proxies.

Assign users to one of the following roles to access API Monitoring. For information about assigning roles, see Assigning roles.

Role Description
API Monitoring Administrator Full CRUD access to only the resources required to use API monitoring. For API monitoring this role includes permissions to:
  • View metrics, logs, collections, alerts, and custom reports
  • Create, update, and delete alerts and collections
  • Create, update, and delete custom reports
API Monitoring User Read-only access to only the resources required to use API monitoring. For API monitoring this role includes permissions to:
  • View metrics, logs, collections, alerts, custom reports

Note: Users assigned this role will not be able to set up alerts and notifications or create and edit custom reports.
Organization Administrator Full CRUD access to all the resources in the organization. For API monitoring this role includes permissions to:
  • View metrics, logs, collections, alerts, and custom reports
  • Create, update, and delete alerts and collections
  • Create, update, and delete custom reports
Read-only Organization Administrator Read-only access to all the resources in the organization. For API monitoring this role includes permissions to:
  • View metrics, logs, collections, alerts, and custom reports

Note: Users assigned this role will not be able to set up alerts and notifications or create custom reports.
Operations Administrator Full CRUD access to resources required to deploy and test APIs, and read-only access to other resources. For API monitoring this role includes permissions to:
  • View metrics, logs, collections, alerts, and custom reports
  • Create, update, and delete alerts and collections

Note: Users assigned this role will not be able to create custom reports.

Access the UI

  1. Log in to https://apigee.com/edge as a user with an appropriate role.

  2. Switch to the organization that you want to monitor.

    Switch to your organization.

  3. Select Analyze > API Monitoring. The API Monitoring submenu displays:

    API Monitoring submen

  4. Select Overview in the submenu. The API Monitoring dashboard displays. See Exploring the API Monitoring dashboard.

Access the API

See Use the API Monitoring Management API.