API insights

This page applies to Apigee and Apigee hybrid.

API insights offers a unified view of your API traffic and performance across all connected gateways (or plugin instances) in API hub. You can use this view to gain a holistic understanding of your API ecosystem health and quickly analyze areas for optimization. Expanding on API analytics in Apigee, API insights enables proactive identification and mitigation of any issues across your API ecosystem.

Enable API insights

API insights collects and analyzes API data from your attached gateways in API hub. To start viewing your API data in API insights, depending on your gateway type, you must first either attach a runtime project or create a plugin instance in API hub.

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, see Edit project association settings.

For more information about configuring API insights in API hub, see Configure API insights.

View API insights

To view API insights, go to the API hub page in the Google Cloud console and click API insights from the left navigation menu. The API insights page appears, displaying the following dashboards:

  • Gateway performance: provides insights into the traffic and performance of your gateways.
  • API performance: provides insights into the traffic and performance of your APIs.
  • API error analysis: provides insights about the errors encountered while using your APIs.
  • Latency analysis: provides insights into the latency of your APIs across multiple percentiles.
  • Target performance: provides insights into the traffic and performance of your targets.

For detailed information about each dashboard, see API insights dashboards.

IAM roles and permissions

To view API insights in API hub, you need the following IAM roles and permissions:

IAM role Permissions
API hub API Insights Viewer (roles/apihub.apiInsightsViewer)
  • apihub.locations.getApiInsights
  • apihub.apis.list
  • apihub.apis.get
  • apihub.plugininstances.list
  • apihub.plugininstances.get
  • apihub.deployments.list
  • apihub.deployments.get
  • apihub.apiHubInstances.get
  • apihub.apiHubInstances.list
  • monitoring.dashboards.get
  • monitoring.dashboards.list
  • monitoring.monitoredResourceDescriptors.list
  • monitoring.monitoredResourceDescriptors.get
  • monitoring.metricDescriptors.list
  • monitoring.metricDescriptors.get
  • apigee.projectorganizations.get

For information on granting roles to principals, see Granting, changing, and revoking access.

Limitations

  • API insights doesn't support data ingestion for custom plugins and API observations.
  • API insights is supported only for Apigee, Apigee hybrid, Apigee Edge Public Cloud, and Apigee Edge Private Cloud (OPDK).
  • API insights data is not accessible through API calls.
  • API insights doesn't support exporting metric data to other Google Cloud services such as BigQuery, Cloud Storage, or Looker Studio.

What's next