API Dashboard

Owned by Al Lusher (Unlicensed)
Last updated: Aug 16, 2023 by Jessica Tomkins
2 min read

 

The Profound API framework automatically measures several key indicators of your APIs and your system.

To access the Dashboard for your system:

  1. Navigate to the Profound.js IDE

  2. On the Home Ribbon, Click API Options and choose API Dashboard

 

This will open a new browser tab with the correct URL for your system, where you will be prompted to Login with your API Dashboard credentials.  See below for more information about Securing the API Dashboard.

The initial view is an overall summary of your API running under the Profound.js service.

 

 

For developers, the most beneficial tabs are:

  • Summary - Shows general server statistical graphs: such as CPU, Memory, Request counts (shown above)

  • Last Errors - Shows the last 100 error requests, either from the server or from the API logic.  You can drill down and see the request details.

  • Longest Requests - Shows the slowest 100 requests sorted by response time.  You can drill down and see the request details.

  • API Calls - Shows detailed information about all APIs (example shown below)

Securing the API Dashboard

The API Dashboard is locked down to only credentials you authorize to access this content.

To administer the credentials authorized to access the Dashboard for your system:

  1. Navigate to the Profound.js IDE

  2. On the Home Ribbon, Click API Options and choose User Authentication, then Dashboard Users

 

From here you can add, remove, and change credentials. 

** These credentials are only used for API Dashboard access. **

Â