This page applies to Apigee and Apigee hybrid.
View
Apigee Edge documentation.
What does this dashboard tell me?
The Developer Engagement dashboard tells you which of your registered app developers are generating the most API traffic. For each of your developers, you can find out who is generating the most API traffic and the most errors. For example, if a particular developer's app is generating a lot of errors relative to other developers, you can proactively address the problem with that developer.
The Developer Engagement dashboard
Apigee in Cloud console
Access the Developer engagement dashboard, as described below.
- Open the Apigee UI in Cloud console in a browser.
- In the left navigation pane, click Analytics > Developer analysis.
- Click the Developer engagement tab.
The Cloud console dashboard has these sections:
The Cloud console version of the dashboard is shown below.
Overview tab
The Overview tab shows the following information:
| Metric | Description |
|---|---|
| Top 10 developer apps by traffic | A ranking of the number of API proxy calls associated with individual developer apps. |
| Top 10 developers by traffic | A ranking of developers based on the number of API proxy calls associated with them. |
The Engagement details table in the Overview tab shows the following information:
| Detail | Description |
|---|---|
| Developer app | The name of the app. |
| Proxy | The name of the API proxy associated with the app. |
| Developer | The email address of the developer who registered the app or the AppGroup Id in the case of an AppGroup. |
| API product | The product name associated with the app. |
| Traffic | The amount of traffic generated by the app for the selected time period. |
| Errors | The total number of errors generated by the app for the selected time period. |
| Error Rate | The error percentage calculated by dividing total errors by total traffic for the selected time period. |
Sum of traffic tab
The Sum of traffic tab shows API proxy traffic details for the filtered items. It includes:
| Metric | Description |
|---|---|
| Traffic by proxy | API calls recorded for the selected API proxies. |
| Traffic by developer | API calls recorded for API proxies associated with selected developers. |
| Traffic by products | API calls recorded for API proxies associated with selected API products. |
| Traffic by app | API calls recorded for API proxies associated with selected developer apps. |
Sum of error count
The Sum of error count tab shows API proxy traffic error counts for the filtered items. It includes:
| Metric | Description |
|---|---|
| Errors by proxy | API errors recorded for the selected API proxies. |
| Errors by developers | API errors recorded for API proxies associated with selected developers. |
| Errors by products | API errors recorded for API proxies associated with selected API products. |
| Errors by app | API errors recorded for API proxies associated with selected developer apps. |
Average of total response time
The Average of total response time tab shows response time or latency information for the filtered items. It includes:
| Metric | Description |
|---|---|
| Average of total response time by proxy | Average of total response time for the selected API proxies. |
| Average of total response time by developer | Average of total response time recorded for API proxies associated with selected developers. |
| Average of total response time by products | Average of total response time recorded for API proxies associated with selected API products. |
| Average of total response time by app | Average of total response time recorded for API proxies associated with selected developer apps. |
Using the Cloud Console version of the dashboard
The dashboard has a set of dropdown menus that you can use to filter the information shown in the dashboard. The filter dropdown menus are dynamic. For example, if you select a developer from the Developers dropdown, then any proxies, apps, and API products associated with that developer are automatically selected in the other dropdown menus, charts, and tables . For more information, see About filter properties in the Looker Studio documentation.
Use the date selector to pick a start and end date to measure. The date selector only lets you select dates in day increments. You can't select a time range increment that is smaller than a day.
Classic Apigee UI
Access the Developer Engagement dashboard, as described below.
To access the Developer Engagement dashboard:
- Sign in to the Apigee UI.
- Select Analyze > Developers > Developer Engagement.
The dashboard opens as shown below. For details on the types of information shown in the dashboard, see What does this dashboard measure?
What does this dashboard measure?
Developer engagement
| Metric | Description |
|---|---|
| Total developers | The total number of developers associated with APIs deployed to an organization. |
| Developers with Apps | The total number of developers associated with apps in an organization. |
| Active developers | The number of developers generating any amount of API traffic. Developers may exist in the organization and have apps, but if their apps aren't making any API calls, they're not active. |
| Highly active developers | The number of developers generating API traffic that exceeds 50 transactions per hour. |
Active developers
"Active developers" means the number of developers generating any amount of API traffic. Developers may exist in the organization and have apps, but if their apps aren't making any API calls, they're not active.
| Metric | Description |
|---|---|
| App Name | The name of the app. |
| Proxy Name | The name of the API proxy associated with the app. |
| Developer Email | The email address of the developer who registered the app or the AppGroup Id in the case of an AppGroup. |
| Product Name | The product name associated with the app. |
| Traffic | The amount of traffic generated by the app for the selected time period. |
| TPH | The transactions per hour generated by the app for the selected time period. |
| Errors | The total number of errors generated by the app for the selected time period. |
| Error Rate | The error percentage calculated by dividing total errors by total traffic for the selected time period. |
| Analyze | Click the Analyze button to see more details about an app. See Analyze developer engagement for details. |
Analyze developer engagement
In the main view, if it is enabled, select the Analyze button under the Actions column for the app to view details about that app and the app developer. The following chart appears:
| Metric | Description |
|---|---|
| Proxies used by app | Measures all APIs that have traffic generated by the selected app. |
| Other Apps by developer | Measures other apps generating traffic registered by the same developer as the developer of the selected app. |
| Other Apps using the same proxies | Measures other apps, from the same developer or not, that use the same set of APIs used by the selected app. |
What else do I need to know about the Classic UI dashboard?
You can view metrics for all proxies or drill into specific proxies using the Metric dropdown menu at the top of the dashboard.
This dashboard uses standard controls, like the date and data aggregation selectors, hovering over graphs for more context, exporting data to CSV, and so on. To learn more, see Using the analytics dashboards.
Make a copy in Looker Studio
If you are using this dashboard in Google Cloud console, you can edit, save, and share a copy of the dashboard in Looker Studio. To get started:
- Click Make a copy in Looker Studio.
- From the dropdown menu, select the report you wish to copy.
- In Looker Studio, click Save and share.
- Click Acknowledge and save.
You can now edit the copy saved in your user account. For details on using Looker Studio to edit and create reports, see the Looker Studio documentation.