The Dashboard

The API Fortress platform has a full featured dashboard built into the platform. The dashboard allows you to:

  • View all test logs across teams
  • Share, download, or print test logs
  • View all performance metrics from tests (latency & fetch)
  • Set performance alerts
  • Filter logs and alerts by time, endpoint, and more

 

There are also some pointers we would like specify:

Easy Monitoring

We always suggest creating comprehensive functional tests, and then scheduling those tests for two reasons. First, it’s a much better monitor of functional uptime. Second, it’s efficient to reuse existing tests. With that said, we understand that some customers just want a simple monitor that validates a 200 is returned, and the performance is acceptable. So, we will show you how here.

For those looking for a written step-by-step guide:

  1. Login to API Fortress
  2. Click Create New Test
  3. Name the test
  4. Click Compose on the far left of the test interstitial page
  5. When in the platform close the tutorial wizard, and then click the HTTP Console button on the left.
  6. Enter the API call and click Send.
  7. Click Generate test.
  8. Click ok on the first two options, but click Skip on the third (create assertions)
  9. The GET call should have been created for you. Now, click Code View at the top right.
  10. Paste this code below the GET call.
    <assert-is expression="payload_response.statusCode=&apos;200&apos;" type="integer"/>
    <assert-less expression="payload_response.metrics.latency" value="350"/> <assert-less expression="payload_response.metrics.fetch" value="300"/> <assert-less expression="payload_response.metrics.overall" value="650"/>
  11. If you look carefully you’ll see that is it straightforward. Confirm the status code is 200, and make sure the latency, fetch (download), and overall timing is below those numbers (in milliseconds). Those are numbers we suggest, but you should adjust as you see fit.
  12. Run the test to confirm it works.
  13. Save and Exit
  14. Click Publish
  15. Click Schedule
  16. Schedule as you see fit. We’d suggest at least the east and west coast every 5mins.

That’s it! Please let us know if you have any questions.

Setup Notifications (Performance Alerts)

Performance is the first thing that people think of when they are concerned about their APIs. By scheduling accuracy tests to run automatically, the data from those executions can then be used for proper insight into how the API is performing globally.

Step 1. Go to the Dashboard

Step 2. Click on Metrics

Step 3. Click on a Footprint

Step 4. Click on the Bell to Add a Monitor

Step 5. Fill in the Information

Enter the name of the alert, select the type of monitor (latency or fetch), and the max value for the trigger. Latency is the time it takes to ping the endpoint and receive a response. Fetch is the time it takes to download the response itself. Large responses will lead to large fetch times, so be aware of this when setting a number. Values are in milliseconds.

Generate a Status Page

This may be the easiest doc of them all. Generating a status page is as simple as clicking the Gear icon in the top right corner of the page, and going to the Status Pages section.

There are two options here. Big Screens automatically refreshes itself, so it works really well for TVs or monitors in a DevOps office, for example. This view is only viewable by users registered to your company. Shareable generates a link that gives a snapshot of the API’s health at the moment the page is loaded. It can be shared publicly without needing an account with API Fortress.

status page
Arrows to the Gear icon and Status Pages section of the Settings page.

Setup Notifications (Email & SMS)

There are many ways to be notified of failures and performances issues with API Fortress. The easiest way to be alerted is through email and text.

You can also receive notifications using third party tools we connect with from our connectors, or any tool that has APIs using our webhooks. Here, we will show you how to set up alerts through email and SMS.

Note

You must have “Manager” access to set the notifications. By default, the user that registers the company is the manager and is automatically added as the one who receives the notifications via email. The manager(s) can add others to the notifications list. 

To Add Others or Edit Your Settings

  1. Go to company settings (gear icon)
  2. Click on Notifications
  3. Click on ‘+email’
  4. Choose the type of report
    reports is default, administrative is for billing purposes
  5. Choose which user in the dropdown
  6. You can add SMS and/or Weekly Reports with the checkboxes.

notifications - email and sms