Configure API insights

This pageapplies toApigee andApigee hybrid.

This page describes how to configure API insights in API hub to view and analyze API data from your attached gateways. Depending on the type of gateway you want to monitor, you can configure API insights in API hub by either attaching a runtime project or by creating a plugin instance.

Note: When you provision API hub as part of Apigee provisioning, it automatically identifies and attaches any associated Apigee runtime projects. API traffic for such attached projects is collected and analyzed automatically.

Before you begin

Configure API insights for Apigee and Apigee hybrid

Note: API insights is supported only for Apigee hybrid versions1.14.0 and later.

To configure API insights to ingest API data fromApigee andApigee hybrid gateways, attach a runtime project to API hub. For more information, seeattach a runtime project.

If you have an existing runtime project attached, but are unable to see any API data in API insights, then you may need to edit the project settings to import the necessary API assets into API hub. For more information, seeEdit project association settings.

Configure API insights for Apigee Edge Public Cloud

To configure API insights to ingest API data fromApigee Edge Public Cloud gateway, perform the following steps:

  1. Create a plugin instance for your Apigee Edge Public Cloud gateway. For more information, seecreate a plugin instance.
  2. Set up the Apigee Edge API hub connector for your Apigee Edge organization. For more information, seeApigee Edge API hub connector setup.

Configure API insights for Apigee Edge Private Cloud (OPDK)

Note: API insights is supported only for OPDK versions4.52.02.xx and4.53.00.xx.

To configure API insights to ingest API data fromApigee Edge Private Cloud (OPDK) gateway, perform the following steps:

  1. Create a plugin instance for your Apigee Edge Private Cloud (OPDK) gateway. For more information, seecreate a plugin instance.
  2. Install the Apigee API hub for private cloud connector RPM package on your Apigee OPDK environment. For more information, seeInstall Apigee API Hub for Private Cloud connector.
  3. Configure the network, authentication, and organization-specific settings for the Apigee API hub for private cloud connector. For more information, seeConfigure Apigee API Hub for Private Cloud connector.
  4. Configure the message processor (MP) configuration for the Apigee API hub for private cloud connector. For more information, seeConfigure runtime.

Considerations

  • Plugin instances recreated using the same plugin instance ID as a previously deleted plugin instance will inherit the insights of the previous plugin instance.
  • Creating plugin instances with acustom curation logic might result in runtime data sync issues. It is recommended to use the default curation logic while creating a plugin instance.
  • It is recommended to use unique display names for your APIs. API insights uses the display name of an API to identify the API in the API inventory.
  • API insights presents empty API data values asNot set.

What's next

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 2026-02-18 UTC.