To configure an API, view details about its usage, and see any recent activity, select the API on the main APIs screen and you'll be taken to the API Details screen.
An API's overview is made up of three core sections:
In the left column, you can adjust the business impact level, view which applications and environments are using the API, and adjust the log levels for each application an environment.
Business Impact is a rating used to designate how vital this API is to your business. We use this rating to more accurately relay the overall health score of an application. All APIs default to "Medium."
While all APIs are important, we recommend setting a "High" impact for mission-critical APIs.
This section provides a heads-up view of every application an environment the API has been detected in. If you're just getting started, you may only see one or two applications listed.
You can manage payload logging from the API details screen on an environment and app specific basis. When payload logging is active Bearer will log full request and response payloads, minus any sanitized data that has been configured at the agent level.
When we calculate error rates, we take into account all error status codes. If you'd like to exclude specific HTTP status codes from the error rate calculation, add them to the exclusion list for each API.
Tags allow you to group APIs into categories that make the most sense for your business. You can then use these tags throughout the dashboard to filter by specific API tag taxonomies.
If you no longer want Bearer to monitor a specific API, you can select the Ignore this API link from the API details page. Any ignored API will be added to the Ignored section of the main API section of the dashboard.
In the event you would like to delete all log data related to the API, you can do so by choosing to Clean-Up Data Storage. Select the Clean button and all data will be removed. If you wish to ensure that no further data is logged for the current API, make sure to also ignore the API.
As anomalies and remediations occur that relate to the selected API, they will display in the activity feed.
Selecting an anomaly or remediation in the feed will take you to the anomalies or remediations collection that contains the event. You can also filter the types of events shown by using the selector located at the top of the feed.
The API metrics column contains an overview of the consumption, error rate, and response time for the selected API.
API Calls displays the usage of the API for the current period, as well as a percentage increase or decrease over the previous period (if available).
Error rate displays the percentage of errors for API calls in the current period, excluding any error codes in the error exclusion list. If the rate is higher or lower than the previous period, a percentage of change will display to the right.
Response time shows the average response time for API calls made in the current period, as well a percentage of change over the previous period.
A green change indicator signifies an improvement, while a red change indicator signifies a decrease in performance.