Send Docs Feedback

Part 4: Monitor your API's performance

This is a legacy tutorial and is being rewritten to match the new API proxy sample shown in Create your first API proxy.

About API monitoring

Apigee Edge collects information as data passes through it. The data includes API call information (URL, IP, and user ID) latency, errors, and so on. This data is gathered into trend charts and tables throughout the management UI. You can use this data to both monitor the overall health of your API program and the health of individual APIs.

See Analytics Services overview for more information.

Prerequisites for this tutorial

This tutorial assumes that you have competed the first tutorial, where you create an API proxy to access the Yahoo weather API. If you have not yet completed the first tutorial, see Create your first API proxy.

While it is not required, Apigee recommends that you also complete the policies tutorial. See Part 2: Add policies to your API.

Step 1: Monitor your API's performance

Use the data charts to see metrics about your APIs:

  1. Select Analytics > Proxy Performance in the main menu. If the API Platform page is not open, click here.
  2. If not already selected, select test in the Environment drop-down list at the top of the page. Multiple charts appear with data about all of your API proxies in the test environment:
    You can select different time periods, different API proxies, and you can move your mouse pointer over the chart to see details about specific data points.
  3. Now look at metrics for only your weather API. In the main menu of the management UI, click APIs to display the API Proxies page. 
  4. Click weather in the API Proxies table. This is the API proxy that you created in the tutorial Create your first API proxy.
  5. On the upper-right side of the weather detail page, click the Performance tab.

  6. The chart displaying metrics for the API appears. There may be a few minutes of lag time between when you send requests and when the metrics are available in the charts.

    You can show or hide metrics for APIs by clicking the Metrics drop down in the upper-left. You probably won't have much data yet. But select a Time Period of one hour to see information about the weather API.
  7. For a comprehensive, multi-dimensional view of your entire API program, click Dashboard in the management UI menu. The dashboard provides views of traffic, partner and developer engagement, and top performing APIs, products, apps, and developers. You can view different date ranges and drill down into API traffic details.

    Analytics charts can also be exported to various file formats.


Learn more

Analytics Services overview

Step 2: Where to next?

Now that you have created your first API, and learned more about policies and APigee tools, it is time to secure your API. It's important to protect your API from unauthorized access. One way to do that is to validate API keys (also called "public keys", "consumer keys" or "app keys").

Continue on to Part 1: Create a secure API to learn about using API keys.

Help or comments?