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.

You can use two types of the dashboards:

User dashboards
Present the data for all APIs defined on an account.

📘
You can have multiple private or public dashboards and customize each dashboard separately.

API Overview
Present the data for one API with a quick glimpse into specific endpoints' data.

📘
All changes you introduce to any of the API Overview dashboard appear in all API Overview dashboards.

Add a dashboard

📘
You can add only a user dashboard.

Click button.
Click Add dashboard.
Enter a descriptive name.
If you want the dashboard to be available to all the users of the account, enable the Public toggle.
Click Create.

You can create multiple dashboards and switch between them. To do it, either select the desired dashboard from the drop-down menu in the search field or enter the dashboard name in the search field.

Clone a dashboard

To clone the current dashboard:

Click button.
Click Clone dashboard.
Edit the name of the new dashboard.
If you want the dashboard to be available to all the users of the account, enable the Public toggle.
Click Clone.

Make a dashboard public

📘
All API Overview dashboards are public and cannot be private. All user dashboards are private by default but you can make them public.

To make a dashboard available to all the users of the account:

Click button.
Enable the Public toggle.
Optionally: If needed, change the name of the dashboard.
Click Update.

Add a chart to a dashboard

📘
When you add or remove a chart to any of the API Overview dashboard, the changes appear in all API Overview dashboards.

Click button.
Click Add chart.
In the General section:
a. Select the Type of data from the dropdown list.
b. Modify the title of the chart.
c. For some types of data you can define data aggregation. Select Cumulative or Individual to view the data as an aggregate of all data points, or by individual elements within each category.
Optionally for some widget types: In the Filters section select checkboxes to filter the content of the charts.
Click Save.

Types of charts

You can add the following types of charts to your dashboard:

📘
You can view your data as an aggregate of all data points or by individual elements: per API, resource, or method.

API traffic – To view the number of API hits in a given period. For example, you can use this filter to verify traffic on your endpoints. If you notice any overloaded endpoints, you can create new endpoints to balance out the traffic.
APIs with the most traffic – To view the APIs that gather the most traffic.
Hostnames API traffic – You can define your API for many different hostnames. Use this chart to view the number of API hits for every hostname.
Authentication denials – If you protect your API using JWT tokens or API keys, you can view a table showing how many authentication attempts were denied because of invalid, expired, or missing JWT tokens or API keys.
Authentication denials in time – If you protect your API using JWT tokens or API keys, you can view how many authentication attempts were denied because of invalid, expired, or missing JWT tokens or API keys in a given period.
Cache hits and misses – If you defined caching in API definitions, you can view a table showing how many requests hit the cache, and how many were missed and directed to your origin.
Cache hits and misses in time – If you defined caching in API definitions, you can view how many requests hit the cache, and how many were missed and directed to your origin in a given period.
Origin errors – To monitor errors reported by the origin. You can view the amount of 5XX and 4XX HTTP response code errors.
Origin errors in time – To monitor errors reported by the origin. You can view the amount of 5XX and 4XX HTTP response code errors in a given period.
Throttling activity – If you defined throttling counters to limit incoming API traffic on a per-second basis, you can view the number of successful and denied hits for a chosen endpoint.
Throttling counter activity – If you defined throttling counters, you can view the number of hits for a chosen counter.
Throttling active counter – If you defined throttling counters, you can view the number of counters with at least one hit during the defined period.
API key traffic – If you defined your key collection and have a key connected to your API definition, you can view a table showing the number of hits using a given key. You can also see the number of denied hits.
API key traffic in time – If you defined your key collection and have a key connected to your API definition, you can view the number of hits using a given key in a given period. You can also see the number of denied hits.
API keys closest to quota limit – If you defined quota on the key collection level (you specified the number of hits per period when the key can be used, for example, 100 hits per hour), you can view which of your API keys is the closest to reach that limit.

Data averaging in time-series charts

There are three time-series charts you can add to your dashboard:

Cache hits and misses over time
Origin errors over time
API key traffic over time

Depending on the selected time range, all time-series graphs average the values presented dynamically into at least five-minute intervals.

The following is the time range and its presented average:

Time range	Presented average
≤ 24 hours	one-minute average
24 hours – one week	one-hour average
Longer than one week	one-day average

📘
The graphs may not show important traffic spikes. For example, a 10-second spike is averaged over a five-minute interval, so it is not visible in the graph.

Customize a dashboard

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

📘
When you edit any of the API Overview dashboard, the changes appear in all API Overview dashboards.

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

From the drop-down list under the search field select the dashboard that you want to configure additional preferences for.
To enable dragging and dropping, and resizing the charts click the Customizable button . It turns blue when enabled.
Now you can freely rearrange the widgets in the 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 remembers any preferences that you set and automatically applies them next time you open the dashboard.
To refresh data in the dashboard's widgets automatically every minute, click the Auto-refresh button . It turns blue when enabled.
To specify a time period for which you want to display data in the charts click the Calendar button or the already set dates.
If you set the end date to the current time, the charts display the dates moved by five minutes backwards.
After choosing dates click the Calendar button to close the calendar panel.