Skip to end of metadata
Go to start of metadata

The AMPLIFY Visibility dashboards provide a way to visualize the data that is ingested from various products. These dashboards are identified by AMPLIFY Visibility site name on the page. The AMPLIFY Visibility dashboards comprise API Dashboard, Event Viewer, and Search Audit. Each dashboard is customized to provide relevant details about the product's data. Depending on the product, you can use the dashboards to:

  • Filter a large amount of data
  • Display a subset of data using graphs
  • Display a summary of information

Access to the AMPLIFY Visibility dashboards is based on AMPLIFY Platform roles and capabilities, where you will see one or more of the dashboards. Since the Platform roles are mutually exclusive, not all combinations of dashboards will be visible.

Icon

If you do not have a valid role, an error page displays describing the situation and to contact your organization's administrator. You are presented with links to view your account or return to the Platform home.

AMPLIFY Visibility Dashboard roles

The AMPLIFY Visibility dashboards meet the needs of different users and therefore are linked to one or more AMPLIFY Platform user roles. You can be assigned different AMPLIFY Platform roles that grant you the rights to the AMPLIFY Visibility dashboards associated with your assigned roles. The dashboards are available to you with the following Platform roles.

DashboardRole
API DashboardVisibility Role: Analytics Specialist
Event ViewerPlatform Role: Developer (and part of the Axway org)
Search AuditVisibility Role: Auditor

AMPLIFY Visibility Dashboard left navigation

The AMPLIFY Visibility dashboards left navigation includes the following tabs:

Icon

The available tabs on the AMPLFY Visibility Dashboard may vary based on your role and your organization's subscriptions. The menu can be collapsed or expanded.

  • API Dashboard
  • Event Viewer dashboard
  • APP Builder link
  • API Observer link
  • Documentation link

And another left navigation for the Search Audit dashboard.

API Dashboard

Click the API Dashboard tab to access the API Report - InsightsAPI Report - Health and Usage, and API Report - API Traffic AMPLIFY Visibility dashboards. You must be assigned the Analytics Specialist Role to access the API Dashboard tab.

API Report - Insights dashboard

The API Report - Insights dashboard shows a summary of the API metrics ingested inside the platform.

The  API Report - Insights displays the API, the environment, and a consumers count (a distinct count of applications through which each API was called) for the following 10 performant values:

  • 10 most performant APIs - by processing time - The results include the API Name with the Min (ms)Max (ms), and Average (ms) processing times
  • 10 least performant APIs - by processing time - The results include the API Name with the Min (ms)Max (ms), and Average (ms) processing times
  • 10 most requested APIs - by number of calls - The results include the API Name with the Number of calls and Number of failures
  • 10 least requested APIs - by number of calls - The results include the API Name with the Number of calls and Number of failures

Filter the data by using the pre-defined time intervals. The data results displayed are counted:

  • Today - from the start of day until current date and time

  • This week - from Monday until the current date and time 
  • This month - from the first of the month until the current date and time 

Click the refresh button next to the filter to refresh the data displayed. 

API Report - Health and Usage dashboard

The API Report - Health and Usage dashboard shows the API metrics ingested inside the platform. 

The  API Report - Health and Usage displays the following values for all APIs:

  • API Name (by default, the values in the table are sorted alphabetically by API name).
  • Environment name 
  • Consumers count (a distinct count of applications through which each API was called)
  • Min response time (ms)
  • Max response time (ms)
  • Average response time (ms)
  • Number of calls
  • Number of errors

Search, filter, and refresh the API data using the options located at the top of the dashboard:

  • Type a keyword in the search field or complete a wildcard search (using an *) to search for alternate spellings and variations on a root word.
  • Filter the data by using the pre-defined time intervals. The data results displayed are counted:
    • Today - from the start of day until current date and time.

    • This week - from Monday until the current date and time.
    • This month - from the first of the month until the current date and time. 
  • Filter the data by the API name and environment.

You can do the following with the displayed results:

  • Click the Name column to sort the data by the API name.
  • Scroll down the page to dynamically load more data.
  • Click the refresh button next to the filter to refresh the data displayed.

API Report - API Traffic dashboard

The  API Report - API Traffic displays an evolution of the number of API calls to an application, in a given period.

  • Hours - Compares the number of calls per minute from the current hour with the data from 1 and 2 hours prior.
  • Days -  Compares the number of calls per hour from the current day with the data from 1 and 2 days prior.
  • Weeks - Compares the number of calls per day from the current week with the data from 1 and 2 weeks prior.
  • Months - Compares the number of calls per day from the current month with the data from 1 and 2 months prior.
  • Years - Compares the number of calls per month from the current year with the data from 1 and 2 years prior.

Filter the data by the application name, or you can select All Applications to get an overview. Click the refresh button next to the filter to refresh the data displayed. 

Event Viewer dashboard

Click the Event Viewer tab to access the Event Viewer AMPLIFY Visibility dashboard. You must be assigned the Developer Role and be a part of the Axway org to access the Event Viewer tab. The Event Viewer dashboard is used to display a large number of events that displays the Event Time and Event Message

Filter and search the event data using the options located at the top of the dashboard.

  • Filter the data by any of the fields contained in the event:
    • Body
    • Header
    • Metadata
    • System (@index and @knowledge_time)
  • Narrow event search results by using the pre-defined time intervals or adding a custom time filter: 
    • 5 minutes
    • 30 minutes
    • 1 hour
    • 6 hours
    • 1 day
    • 1 week
    • Custom time
  • Search events by a keyword

You can do the following with the displayed results:

  • Click Display metadata to display event metadata
  • Click Auto-refresh to refresh the results and load the newest events every five seconds
  • Scroll down the page to dynamically load more events
  • Click the refresh button next to the filter to refresh the data displayed

Search Audit dashboard

Click the Search Audit tab to view the Search Audit AMPLIFY Visibility dashboard. You must be assigned the Auditor Role to access the Search Audit tab. The Search Audit dashboard is used to display audit events showing sensitive data that is most relevant to an auditor.

The following event audit details are displayed:

  • Event time
  • Knowledge time
  • Id
  • User
  • Capability name
  • Operation
  • Resource type
  • Resource name
  • Initial value
  • New value
  • IP address
  • Comment

Filter and search the event data using the options located at the top of the dashboard.

  • Filter the data by any of the fields displayed in the table.
  • Narrow event search results by using the pre-defined time intervals or adding a custom time filter:
    • 5 minutes
    • 30 minutes
    • 1 hour
    • 6 hours
    • 1 day
    • 1 week
    • Custom time
  • Click a column to sort the data by the Event time or Knowledge time

You can do the following with the displayed results:

  • Scroll down the page to dynamically load more events
  • Click the refresh button next to the filter to refresh the data displayed

APP Builder and API Observer tabs

Click the APP Builder   or API Observer   tabs to redirect you into the product specific dashboard. You must be assigned the Analytics Specialist Role to access the API Observer tab. You will see these tabs unless you are an Axway administrator, and then when selected, you will be redirected away from the AMPLIFY Visibility dashboard and into the product specific dashboard.

  • No labels