API Gateway Dashboard

API Dashboard is a standalone application that lets you create dashboards with various charts related to your API traffic. Because API Gateway generates the charts with only a five-minute delay, you can discover issues proactively and come up with solutions before the issues become significant.

You can add dashboards and tailor each of them so that it contains only a specific set of charts. For example, an API traffic dashboard may include the following charts related to API traffic: APIs with the most traffic, API traffic. Another dashboard focused on API keys may include these charts: API key traffic, API keys closest to quota limit.

You can access API Dashboard in ​Akamai Control Center​ after logging in with your user name and password.

Access API Gateway Dashboard

Go to > CDN > API definitions > API Gateway dashboard.

Add a dashboard

  1. Click Add dashboard.

  2. Enter a descriptive name.

  3. If you want the dashboard to be available to all the users of the account, select the Public checkbox.

  4. Click Done.

    You can create multiple dashboards and switch between them. Either select desired dashboard from the menu next to the API Gateway Dashboard, or enter dashboard name in the search field.

Add a chart to a dashboard

  1. Click + Add chart

  2. In the General section:
    a. Select the Type of data from the dropdown list.
    b. You can modify the Title.
    c. For some types of data you can select Cumulative or Individual to view the data as an aggregate of all data points, or by individual elements within each category.

  3. In the Filters section select checkboxes next to chosen endpoints.

  4. Click Done.

Customize a dashboard

On each dashboard you add, you can rearrange the charts with drag & drop, resize the charts, and enable automatic refresh for the data that appears on the charts.

Before you begin, access API Gateway Dashboard and ensure that you have at least one dashboard.

  1. From the dashboard list on the left, select the dashboard that you want to configure additional preferences for.

  2. To enable dragging and dropping, and resizing the charts, select the Customizable check box.
    After you select Customizable, you can freely rearrange the widgets in API Dashboard. For example, you can move the charts you consider the most important to the top and keep the ones you rarely use at the bottom.
    You can also change the size of each widget by using .
    Your browser will remember any preferences that you set and automatically apply them next time you open API Dashboard.

  3. To refresh data in the dashboard's widgets automatically every minute, select the Auto refresh check box.

  4. Click the calendar field to select the time period for which you want to display data in the charts.
    If you set the end date to the current time, charts will display data starting from the current time minus five minutes and counting backwards.

Access old API Gateway Dashboard

You can return to the old dashboard by clicking Back to old Dashboard App link under the API Gateway Dashboard.

When you first open API Dashboard, an empty dashboard appears without any charts.

You can also add additional dashboards and tailor each dashboard so that it contains only a specific set of charts. For example, an API traffic dashboard may include the following charts related to API traffic: APIs with the most traffic, API traffic. Another dashboard focused on API keys may include these charts: API key traffic, API keys closest to quota limit.

Each chart that you add to a dashboard requires additional filters to be configured. Depending on the chart type, you can filter by one of the following criteria:

  • Registered API. Choose the registered APIs for which you want to display the data. The filter lets you select from all APIs associated with your current account context.

📘

If you select only one API, the Cache hits and misses and Authentication denials charts will include links to relevant configuration pages in API Definitions. By following these links, you can go straight to your API settings and adjust them as appropriate.

  • API key. Choose the API keys for which you want to display the data in
    the API key traffic chart. The filter lets you select from all API keys
    associated with the APIs you selected in the registered API filter.

You can select the time period for which you want to display data in charts added to your dashboard. If you set the end date to the current time, charts will display data starting from the current time minus five minutes and counting backwards.

You can rearrange charts on a dashboard by enabling drag & drop. You can also configure the data in the charts to refresh automatically. Your browser will remember any preferences that you set and automatically apply them next time you open API Dashboard.

Filter old API Dashboard

You can filter the data that appears in API Dashboard by registered APIs and selected time periods.

  1. In API Dashboard, expand the node associated with Settings.

  2. In the Filters section, place your cursor in the text field and select the APIs by which you want to filter the charts.

📘

In the text field, you can start typing the name of the API by which you want to filter to narrow down the list of results. The box has type-ahead capability. The list that appears after you place the cursor in the text field contains all registered APIs associated with your current account context.

  1. Select the time period for which you want to display data in the charts.

  2. Click Filter.


Did this page help you?