Using the analytics dashboards

You're viewing Apigee X documentation.
View Apigee Edge documentation.

Analytics dashboards help you see and detect changes in your API ecosystem at a glance. The ability to see what has changed over time helps you identify problems and take corrective action quickly.

For a quick overview of API Analytics, who uses them, and why, see API Analytics overview.

For a quick overview of the analytics dashboards, watch this video.

What can you learn from the dashboards?

Has there been a sudden spike or drop off in API traffic? Which app developers are most successful? What is the adoption rate of your API among developers? Which API methods are most popular? The Analytics dashboards are designed specifically to answer questions like these.

In the background, Apigee collects information as data passes through your APIs. The dashboards provide a powerful way to use this data immediately. If you see something of interest in a graph or chart, an anomaly or sudden change, you can then drill deeper to uncover as much detail as you require. If you notice that a particular developer is experiencing a lot of errors or a sudden drop in traffic, you can contact that developer proactively. Dashboards give you insight into your APIs that allows you to take action.

What's the delay interval for receiving data?

Can I customize the dashboards?

Yes, many dashboards let you select which metrics to analyze, date ranges, data aggregation intervals, and many other variables. If the built-in dashboards do not suit your needs, you can create custom reports, which are dashboards you create by selecting the analytic dimensions and metrics that you wish to analyze. Custom reports let you "drill down" into your API's analytic data until you achieve the granularity you require.

What are the most common features in the dashboards?

Dashboards have a set of common features, including setting time range, click and drag zooming on charts, mouse-over hover for more details on charts and other regions, and selectors for choosing the data to display in a chart. If you understand how to use one kind of dashboard, you'll be comfortable using the others.

The following figure highlights these common feature areas:

A dashboard labeled Proxy Performance shows where you can select environment, set
    time range, export data, hover over data, and refresh data.

  • Environment or Host name - Select the environment or host name in the organization.
  • Set the time range - Set the time range over which the dashboard displays its data.

  • Zoom in - You can zoom in on chart data by clicking and dragging a region of the chart. When you complete the drag, the chart zooms in to the selected region.
  • Export data to file - Download a single CSV file that contains the set of data for the chart.
  • Hover mouse over graphs - You can mouse over any point on a graph for more context about the data at that point.

Reading dispersion box plots

When an analytics report illustrates an average, as well as minimum and maximum values, it display an accompanying dispersion box plot, as shown in the custom report below:

A box plot labeled Dispersion is next to a line graph labeled Average of Target
    Response Time that contains four plotted lines.

At a glance, a dispersion box plot enables you to see the central tendency and dispersion of your data. A dispersion box plot surfaces the five key numbers when it comes to illustrating averaged analytics data:

A closeup of the dispersion box plot shows where to find the minimum value, lower
    quartile, median, upper quartile, and maximum value.

In this example:

  • The area within the box indicates the most typical average target response times experienced by your traffic — 50% of your traffic, to be exact.
  • The line extending from the left side of the box indicates the average target response times experienced by 25% of your traffic.
  • The line extending from the right of the box indicates the average target response times experienced by the remaining 25% of your traffic. The longer these lines, or “whiskers,” the more extreme your outlier values.