When you start your free API Science 30-day trial, you are immediately provided with an API Dashboard that has been preconfigured with API monitors that let you explore the capabilities the API Science platform provides. Your dashboard provides an overview of present and recent statuses for all of your API monitors.
The columns for each monitor provide links that provide you with a more detailed view. The “NAME” column highlights the name of your current monitors (those provided with your free trial, or the monitors you’ve added yourself).
Clicking on the monitor’s NAME column brings you to the summary page for that specific monitor. This page provides:
- An overview of the structure of the monitor (its Name, Status, Method, URL, Location, Frequency, and (optionally) the details of the API call:
- A view of the results of the last 10 monitor timing checks for the API, including time to resolve, time to connect, processing time, and transfer time (all in milliseconds); this view illustrates the stability of the APIs you rely on, in terms of the wait time experienced by your users:
- Tabulated results of the most recent checks on the API, including the date/time of the check, the HTTP response status, whether the API check succeeded, the location from which the API call was made, and the total time occupied by the monitor test:
- Tabulated uptime history. This table shows you how frequently the API you depend on experienced outages based on your monitoring frequency; that is, is this API usually up for days and months on end, or does it experience outages fairly regularly over the short term (meaning that your own users will see your service as experiencing frequent outages):
- Alerts Rules. This lets you select the conditions upon which an alert should be sent based on the results of an API monitor test:
Here, you will always hope to see a green upward-pointing arrow, indicating that the API has responded correctly during the latest monitor test. If you don’t see this, then your customers may not be receiving the products you promise to provide, and immediate action may be required.
The PERFORMANCE column is a thumbnail plot of the API’s recent performance with respect to temporal response. Clicking on this plot brings you to a page that provides graphical and tabulated details, including check time, average response time, average connect time, average transfer time, average closing time, and average total time.
UPTIME 24 HOURS Column
The UPTIME 24 HOURS column is a thumbnail plot indicating the uptime of the monitored API over the past 24 hours. The ideal situation is that this plot shows 100% uptime over the past 24 hours. Clicking on the thumbnail plot will show you the current uptime duration for the API based on your monitoring.
LAST RUN Column
The LAST RUN column states the latest time when your API monitor tested the API using your configured tests.
The ACTIONS column provides a link to the API Reports page for the monitor, and a link for deleting the monitor.
Here, I’ve described the beginning of what you get when you sign up for your free API Science 30-day trial. In my next post, I’ll talk about how you can use your free API Science trial to monitor the status of APIs that are critical to the work you’re doing today.