Dashboard overview

The dashboard provides an organization level overview of API requests.

Dashboard information

The information displayed in the dashboard is impacted by any filters you select. Learn more about filters later in this article.

Totals

The top of the dashboard displays the number of, within the selected organization, for each of the following:

• Apps
• APIs
• API endpoints
• Detected PII
• Requests

Graph

The graph displays the aggregate of API requests grouped by apps. Hover over the graph to get a breakdown of the API requests for that time.

Map

The map displays the API requests grouped by the top 1000 locations.

Donut chart

The donut chart in the dashboard displays the total number of API requests. These API requests are grouped by status codes. Hover over the chart to get the API request total of a particular status code.

Findings overview

The findings overview displays the number of findings that have been discovered. These are broken down by severity. Click View findings to be directed to the Findings page on the platform. Learn more about Findings here.

Requests table

The table lists the incoming requests and their details.

• Filter the table by Status and Method. Click the filter icon and select how your filters. Click OK to apply.
• Sort the table by Date created. To sort by ascending, click the up arrow icon, to sort by descending, click the down arrow icon.
• Sort the table by Execution time To sort by ascending, click the up arrow icon, to sort by descending, click the down arrow icon.

To expand on individual requests, go to the Action heading, and click View details. This displays more information about the request including the response and request body.

Dashboard filters

You can filter what information is displayed on the dashboard. A filter group can contain a single condition or multiple conditions. There are various options you can select to filter by, such as response status codes, request path, tags and so on. Multiple filter groups can be added. 

The following filter types are available:

Resource

• API
• APP

Request

• IP Address
• Execution time
• Path 
• Resource Path
• Tags
• Method
• URI
• Schema
• Domain name
• Header
• Path Parameter
• Query String
• OAuth Sub ID

Response

• Status code
• Header

User agent

• Browser Name
• Browser Version
• Device Name
• Operating System Name 
• Operating System Version

IP details

• AS
• AS Full Name
• City
• Continent
• Continent Code
• Country
• Country Code
• Country Currency
• District
• Is Hosting Provider
• Is Proxy IP
• Is Mobile ISP
• Latitude
• Longitude
• Timezone
• ASN Organization
• ZIP Code

On the dashboard:

1. Click Add Filter Group.
2. Select the required element from the Type dropdown.
3. Choose the appropriate Operator.
4. Enter a Value, or select a value from the dropdown.
5. Click Submit.

‍

Note: If you select the Type as request.headers, request.pathParameters or request.query.Strings you will need to select the corresponding request header, request path parameters before you select the value.

Select Include or Exclude (Include is selected by default) to determine if the requests displayed in the dashboard must include or exclude the conditions defined in the filter.

To add any further conditions to this filter, click Add condition. To add any additional filters click Add filter group and enter the values for the condition.

Edit filters

You can edit the condition within a filter, to do this:

1. Click the condition you want to edit.
2. Make changes to the Type, Operator and Value as required.
3. Click Submit.

To delete a condition from a filter:

1. Click the condition you want to delete
2. Click Delete.
3. Click Yes to confirm.

To delete all filter groups and conditions:

1. Click Reset.
2. Click Yes to confirm.

Save filters

You can save filters that you create to use again. When you have a filter created:

1. Click Save Filter.

2. Enter a name in the Filter name field.

3. Click Save.

To load a previously saved filter:

1. Click Load/Delete filter.

2. Select the filter you want to apply.

3. Click Load.

Note: Select My Filters to only see filters you have created. Click All Filters to view filters all users in the organiztaion have created.

Filter examples

Example 1: Create a filter that excludes 404 response codes on the dashboard.

1. Click Add filter group.
2. Select response.status.Code from the Type dropdown.
3. Choose is not one of from the Operator dropdown.
4. Select 404 as the Value.
5. Click Submit.

Example 2: Create a filter to only display requests with a 200 response code but exclude any of those responses that have a request path of /health.

1. Click Add filter group.
2. Select response.status.Code from the Type dropdown.
3. Choose is from the Operator dropdown.
4. Select 200 as the Value.
5. Click Submit.
6. Click Add condition.
7. Select request.path from the Type dropdown.
8. Choose is not from the Operator dropdown.
9. Enter /health as the Value.
10. Click Submit.

‍

Filter by time

The dashboard can be filtered by a timeframe selected from the Duration selector dropdown:

• Last hour
• Last day
• Last month
• Last 3 months

Select Custom and enter a Start date and an End date to filter by a specific timeframe.

The Polling interval indicates how often the page data reloads from the API, in minutes. Select the polling interval from the dropdown.

Create an Alert

Alerts can be created to notify you when the specified threshold has been reached. To receive an alert, first create a notification integration. Click Create Alert on the Dashboard to create a static alert. Follow the prompts to set up an alert. Learn more about how to create an alert.

‍