Blog

API GateWay: Dashboard Updates

June 24, 2020 · by Jeff Costa ·
Categories:

The API Gateway dashboard has undergone a big renovation! 

New Dashboard

When you log in to Akamai Control Center and navigate to API Definitions > API Gateway Dashboard, you’ll see a new link at the top of the page: 

Button

This link will take you to the new dashboard where you can begin setting up the reports you would like to see. You can click the “Start Tour” button to familiarize yourself with the new interface.

API Gateway Dashboard

Get Started

Create a Dashboard

First, you’ll need to create a new container dashboard. Here’s how:

  1. Click on the “Add Dashboard” button 

  2. Give your dashboard a unique name

  3. Tick the “Public” checkbox if you want others to be able to see your dashboard.

API Gateway Dashboard

Configure Your Charts

Now that you’ve created a container for your dashboard, you can configure your charts. Here’s how:

  1. Click the “Add chart” button to add the charts you wish to track.

    API Gateway Dashboard

  2. This will open up a configuration window where you can configure what you want to see in a specific chart. In the “Type” field, select the chart type that you want to view. In this example, we’ll select the new “Throttling activity” chart. It will add a default title to the report, but you may change that at your own discretion. 

    • We’ve added 15 new types of charts including origin errors, API key traffic, and cache hits and misses, and more. 
       

      API Gateway Dashboard

       

  3. Next, choose the level of detail you would like to see: Cumulative or Individual. 

    • If you choose “Individual”, you’ll be able to customize the level of detail you would like to see: API, Resource, or HTTP method.

    • If you choose “Cumulative”, you’ll be able to see activity across all APIs. 
       

      API Gateway Dashboard

       

  4. Next, at the bottom of the screen, select the endpoints for which you’d like to monitor throttling behavior. 

  5. When you have completed this configuration, click the “Done” button at the bottom right of the screen. This will save your configuration choices and enable the chart. 

  6. Finally, you’ll need to use the time chart to select a time frame for the data. You can select a custom time period, or any of the pre-defined time periods (ex: Yesterday, Last month) to view your data.
     

    API Gateway Dashboard

    If you followed along, you’ve set up your chart which will automatically refresh and update your chosen data.

Note: You can add more charts to the dashboard by repeating this process.

Summary 

We’ve added a new interface and more types of charts to our API Gateway Dashboard. You can read more about our latest updates in our API Gateway documentation.

API Gateway Dashboard

You can switch between this new version and the existing version at will, but we plan to deprecate the old version in the next couple of months. 

If you have any questions or ideas to help improve the dashboard, you can visit our Developer Community page.