Customizing the Analytics Dashboards

WSO2 API Manager Analytics has five different dashboards that are namely, API Analytics, Application Analytics, Business Analytics, Monitoring, and Reports.

The users are not allowed to modify the default dashboards - i.e modify the layout of the widget or add custom widgets to a particular dashboard. If you need to modify one of the default dashboards, you need to make a copy of the dashboard and do modifications to the copy of the dashboard as described in steps 1 to 5.

In order to make it possible for other users to create dashboards, you need to append _<tenant domain> to existing scopes in the deployment.yaml file which resides in <Analytics_HOME>/conf/dashboard directory.

Example

apim_analytics:admin_<tenant-domain>
wso2.dashboard:
  roles:
    creators:
      - apim_analytics:admin_carbon.super 
      - apim_analytics:admin_abc.com

  1. Click on the dashboard customization icon in the dashboard card as shown below.

    API Manager default dashboards

  2. Click Duplicate.

    APIM Analytics dashboard dropdown

    A form will be displayed as shown below.

  3. Enter a valid Name and URL for the dashboard based on your preference and click OK.

    Dashboard duplication form

    A copy of the dashboard is created with the provided Name as shown below.

    Duplicated dashboard

  4. Click the dashboard customization icon that corresponds to the created dashboard card and click Design as shown below.

    Dashboard dropdown

    Now, you will be directed to the Design Portal.

  5. Do the required customization on the selected dashboard.

Top