Skip to end of metadata
Go to start of metadata

The AMPLIFY Visibility dashboards

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 - 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 - Health and Usage dashboard

The API Report - Health and Usage dashboard shows a summary of the data ingested inside the platform.

The  API Report - Health and Usage displays the top 10 performant values:

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

The data can be filtered by the following time options:

  • Last day

  • Last week
  • Last month
Icon

The displayed values do not include the data ingested during the current day. For example, when choosing 'Last day', the data is based on the events received starting with the previous day at the start of day (00:00) until yesterday at end of day (23:59), given your time zone.

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:

  • Last week - Each bar represents a full day, and each group shows the evolution of the value for that same day of the week compared to two and three weeks ago.
  • Last month - Each bar represents a full week, and each group shows the evolution of the value for a week compared to 4 and 8 weeks prior.
  • Last year - Each bar represents a full month, and each group shows the evolution of the value for that same month of the year compared to two and three years ago.

The data can be filtered by the application name, or you can select 'All Applications' to get an overview.

Icon

The displayed values do not include the data ingested during the current day, week, or month. For example, when choosing 'Last week', the last bar displayed in the chart represents the number of calls received starting with the previous day at the start of day (00:00) until yesterday at end of day (23:59), given your time zone. The behavior is similar for the month and year.

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

Scroll down the page to dynamically load more events.

Filter and search the event data using the options located at the top of the dashboard. You can filter the data by any of the fields contained in the event:

  • Body
  • Header
  • Metadata
  • System (@index and @knowledge_time)

You can also 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

You can search events by a keyword. Finally, you can use the available options to display event metadata and auto refresh the results to load the newest events every five seconds.

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:

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

Scroll down the page to dynamically load more events.

Filter and search the event data using the options located at the top of the dashboard. You can filter the data by any of the fields displayed in the table.

You can also 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

Finally, you can use the available option to auto refresh the results to load the newest events every five seconds.

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