Editing dashboards

You cannot edit the IBM® API Connect preconfigured dashboards, but you can clone it to create a custom dashboard to add, edit, or remove visualizations, and to resize or rearrange visualizations. You can also use the Time Picker to change the time range of the data shown in the visualizations.

Before you begin

To edit dashboards, you must either be the owner of the API provider organization, or be assigned a role that has the Analytics > Manage permission for the selected Catalog or Space. For information about enabling Spaces in a new or existing Catalog, see Creating and configuring Catalogs and Enabling Spaces in a Catalog. For more information about assigning Catalog or Space permissions to a role, see Managing Catalog membership and Managing Space membership.

About this task

If Spaces are enabled in the selected Catalog, when you edit the dashboard at the Catalog level, your changes are reflected in the Catalog, and are also propagated to the corresponding inherited dashboard in each Space provided the dashboard has not been edited in the Space. However, changes that you make to a dashboard in a Space will apply only within that Space. For more information, see the Dashboards and visualizations: Understanding the inheritance flow across Catalogs and Spaces section in Catalogs, Spaces, and Analytics.

Any visualizations that you want to add to the dashboard must already be in the list of saved visualizations. If you want to add a new visualization that does not yet exist, you must first create the visualization to make it available for selection from the list of saved visualizations. For more information, see Creating visualizations.


To edit a dashboard, complete the following steps:

Remember: You cannot directly edit a default dashboard that is provided with IBM API Connect. See Cloning a dashboard for information about how to clone the dashboard and modify it.

  1. Access the dashboard that you want to edit:
    1. If you are not already in the Dashboard application, select Dashboard to view the list of available dashboards. The list of saved dashboards is displayed.
    2. Select the dashboard that you want to edit to open it.
      If you have a large set of saved dashboards, you can either browse through the list or use the filter to locate the dashboard.
    3. Select Edit in the menu bar of the dashboard. The dashboard opens in edit mode.
  2. Modify the contents as required:
    • Add an existing visualization to the dashboard:
      1. Select Add to add a visualization. The list of saved visualizations is displayed.
      2. Select the visualization you want to add.
        Tip: If you have a large set of saved visualizations, you can either browse through the list or use the visualization filter to locate the visualization.

        The visualization is added to the dashboard, within a container (but might be obscured by the saved list). You can resize or reposition the visualization as described later.

      3. Close the list of saved visualizations by clicking Save.
    • Edit a visualization in the dashboard.
      Important: When you edit a visualization in this way, you must overwrite the original visualization in the saved list when prompted, in order to have the changes reflected in the dashboard you are editing. Be aware however, that your changes will also be reflected in any other dashboards that contain this visualization. (This might be undesired.)
      1. Hover over the visualization and then click the Edit icon The Edit icon that is displayed in the upper right-hand corner of the visualization container. The visualization builder page opens.
      2. Update and save the visualization configuration as described in Configuring visualizations.

        When you close the visualization builder page, you return to the dashboard being edited.

    • Remove a visualization from the dashboard by hovering over the visualization and then clicking the Delete icon The Delete icon that is displayed in the upper right-hand corner of the visualization container.

      The action only removes the visualization container from the dashboard; it does not delete the visualization itself from the saved list.

    • Resize a visualization container from its lower right-hand corner by dragging inwards or upwards to decrease the size, or dragging outwards or downwards to increase the size.
    • Rearrange the visualizations by using the move icon Move visualization icon to drag and drop the visualizations in the required location in the dashboard. You can see this icon in the upper right-hand corner when you hover over a container.
    • Change the time period against which the data in the visualizations is scoped. You can specify a different filter by using the Time Picker icon (The Time Picker icon).
  3. When your changes are complete, save the dashboard as follows:
    1. Click Save in the menu bar.
    2. If you specified a time period as described in step 2, and you want to save the dashboard with that time filter, select the Store time with dashboard check box.
    3. Click the Save button and then confirm that you want to overwrite the current dashboard.
      Your changes are reflected in the saved dashboard.