After reading this topic, you'll know how to:
- Use the Management UI to create custom reports using metrics and "drilldown" dimensions that you supply.
- Edit and save custom reports.
- Delete custom reports.
- Use the out-of-the-box custom reports.
Check out this short video to learn about creating and using custom reports.
By adding custom reports, you can create a set of charts that provide insight into every aspect of your API program.
To add a custom report:
- Select Custom Reports from the Analytics menu.
- Click + Custom Report.
- Enter the name and description for your report.
- Select a chart type, column or line. This is the style of chart that will be used to present your custom analytic data.
- Select a data aggregation interval for the report. Note that the Hourly aggregation is the least costly choice in terms of system resources. Per Minute is the most costly.
- Hourly shows data aggregated every hour.
- Daily shows data aggregated every 24 hours.
- Per Minute shows data aggregated every minute.
- Click the Environment menu and choose the environment in your organization from which you want data to be collected.
- In the Measure sections, choose the metric that you wish to analyze. See "Custom metrics" for a description of each metric.
- Select an aggregation function that you want applied to the data for the first metric. You can select an aggregation function to display the Sum, Average, Min, or Max values.
- Click + Measure to add additional measures.
- Choose your drilldown dimensions, such as an Edge API Proxy. Every dimension you add (by clicking + Drilldown) constrains the data set used to generate the reports. In effect, you're presenting more and more specific data with each drilldown.
- You can further narrow the data displayed by adding filters to your report definition. In the Filter section of the page, click + Filter Condition. Select the entity you want to filter on, and construct an expression with the Operator and Value to include or exclude data in the report. For example, you could add a filter that excludes data for the weather API proxy or developer firstname.lastname@example.org.
Select an AND or OR connector for multiple filters, and click the check mark icon to save each filter.
- Click Save.
The Analytics tab provides access to the reports in your org.
When building a custom report, you can choose from these metrics:
|Average transactions per second||The number of API requests and resulting responses per second.|
|Cache hit||The number of API requests that are serviced from the Apigee cache. The request for the cached data is not forwarded to the backend target.|
|Policy errors||The request is marked as is_Error when it cannot be serviced successfully by a policy.|
|Proxy errors||The request is marked as is_Error when it cannot be serviced successfully by the proxy.|
|Request processing latency||The length of time it takes the proxy to complete an end-to-end transaction.|
|Request size||The size of the request in kilobytes.|
|Response processing latency||The time it takes for the proxy to process a request measured in milliseconds.|
|Response size||The size of the response in kilobytes.|
|Target errors||The request is marked as is_Error when it cannot be serviced successfully by the backend target.|
|Target response time||The time it takes from when a request is sent from to the backend target and when it is received from the backend.|
|Total response time||The total time for an app to receive a response from an API request. This is the sum of the request processing latency of the proxy, request processing latency of the customer endpoint, response generation latency of the customer end point, and the response processing latency of the proxy. It also includes the latency introduced by the network layer as the request and response can go through multiple networks before it reaches its destination.|
|Traffic||Also known as throughput. The number of API requests and resulting responses seen by the organization.|
You can select from a large number of custom drilldown dimensions. Drilldown dimensions let you specify which dimensions to measure in your custom report. Apigee Edge Analytics collects data on a wide range of dimensions. And, you can also select any custom dimensions that have been created in your organization. See Analytics reference.
When you've completed building your custom report, the data is populated immediately. The graph is defaulted to plot the first metric you chose for the tab in your custom report. If you want to see different metrics, or compare them against each other, follow these steps:
- Click the report name to view the graphs of the selected report.
- Click the Edit button to edit the display name, dimensions, and measures.
- Click Save.
You also have the option to delete a report by clicking the Delete button.
You can export a saved custom report to CSV format. Each report includes an export menu where you can select a format for the export.
Apigee Edge provides a set of predefined custom reports, informally called "custom report packs".
Custom report packs are available to paid Apigee Edge customers only.
There are two custom report packs: operational reports and hackathon reports. The operational report pack provides more than 15 reports that are designed to help you analyze your API traffic from multiple angles. For example, one operational report tracks the most common errors by error type, another tracks the most error-prone resources.
The hackathon report pack comprises a collection of reports that can help you analyze and track the quality of your hackathons. For example, one report tracks the traffic from developers participating in a hackathon, another shows the API latency times during a hackathon.
The operational report pack appears automatically in the list of your custom reports — you do not have to do anything to request these reports. However, to receive the hackathon report pack, you need to first provide Apigee with some details about the hackathon, such as its name and date. Apigee Edge can then provision the the pertinent hackathon reports with the correct filters and time ranges. You can contact Apigee, through the Apigee Support Portal.
Help or comments?
- Something's not working: See Apigee Support.
- Something's wrong with the docs: Click Send Feedback in the lower right.
(Incorrect? Unclear? Broken link? Typo?)