Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 3.03 KB

create-a-dashboard.md

File metadata and controls

65 lines (44 loc) · 3.03 KB
Raw
description
Learn how to build your Dashboard and various analytics options for APIs and applications

Dashboards

Overview

The Gravitee Dashboard is an area in the UI where you can create custom dashboards reflecting API performance, status, lifecycle stage, etc. The Dashboard is comprised of 3 modules: Overview, APIs health-check, and My tasks.

Dashboard overview

  • Overview: Shows a summary of API metrics for the selected time interval via configurable charts and information, followed by a paginated list of API events
  • APIs health-check: Shows API status and availability data based on filter criteria and the selected time interval
  • My tasks: Starting with the most recent, shows the list of tasks to be validated

Create a dashboard

You can configure your Gravitee Dashboard by creating dashboard charts for three different categories: Platform, API, and Applications. To create a chart:

  1. Log in to your APIM Console

  2. Click on Settings in the left nav

  3. Click on Analytics in the inner left nav

  4. Choose to ADD A NEW PLATFORM DASHBOARD, ADD A NEW API DASHBOARD, or ADD A NEW APPLICATION DASHBOARD

    Add a dashboard to a category

  5. Define your Dashboard name and Query filter (optional), then click SAVE

    Add a dashboard

  6. Click the plus icon at the bottom of the screen to add a widget

  7. Click the pencil icon to configure the widget:

    Configure your widget

    • Give your widget a Name and (optionally) a Subtitle
    • Select a Widget type from the drop-down menu, e.g., table
    • Select a Field from the drop-down menu, e.g., API, or use a custom field
    • Choose the information to display for your selected field
    • Clice SAVE

  8. (Optional) Click ENABLE PREVIEW to preview your new dashboard and widget

View your dashboard

To view your new dashboard and chart:

  1. Log in to your APIM Console

  2. Click on Analytics in the left nav

  3. Under the Dashboard header, select your dashboard from the Select a dashboard drop-down menu

    View your dashboard

Edit an existing dashboard

To modify existing dashboards:

  1. Log in to your APIM Console
  2. Click on Settings in the left nav
  3. Click on Analytics in the inner left nav
  4. Click on the hyperlink of an existing dashboard
  5. Use the pencil icons to edit widget settings, or the plus icon to add a new widget
  6. Click SAVE