Dashboard overview

The dashboard provides an organisation level overview of API requests.

Dashboard information

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

Totals

The top of the dashboard displays the number of, within the selected organisation, 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 API requests for that time.

Map

The map indicates the API requests grouped by location.

Donut chart

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

Logs table

The table lists the incoming requests and their details. The last 100 logs are received.

You can filter the table by Status and Method. Click the filter icon and select how you want to filter. Click OK to apply.

You can sort the table by Date. 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 More 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. 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.
5. Click Submit.

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.

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 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.

Edit filter

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.

To delete a filter, click the bin icon next to the filter.

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.