Introduction: Javascript and Custom API Dashboards

Javascript provides the capability for a company whose product is based on APIs to create custom dashboards that show their team the current status of the APIs that are critical for their product. If certain APIs are down, then their product is either down or partially down from the point of view of their customers. Executing a Javascript test can determine the present state of the product.

If the testing is automated using the API Science platform, then a second dimension is added: an historical view of the uptime and availability of all APIs that affect the product’s performance. If you have configured automated API monitoring using your API Science account, and you’ve created an API Science API key, then you can access the historical data for any of your API monitors and create whatever view you require of the status of the APIs that affect your product’s viability.

Javascript provides the opportunity to query an Internet resource, receive a response, then produce an output as a web page or as a component of a web page. This capability provides companies with the ability to create customized web dashboards that provide an overall view of the status of their product as viewed by their customers. API Science adds the capability to view the status of company products as viewed by customers from different locations around the globe, because users can define the query location from which an Internet resource is accessed.

The effect of distance from the queried resource is often underestimated by start-up companies. A study of performance timings for a simple query to the World Bank’s Countries API revealed that a request for a small set of data from different locations around the globe produces very different results.

The effect of distance between the client and the server that is providing the response is far greater than a developer or start-up manager might think. For example, the response time for someone in Tokyo querying a Washington DC API is about 10 times the response time for someone in DC querying that same API. This is why the major Internet companies create data centers across the globe that replicate (though with some delay) what’s happening at their central Silicon Valley data centers.

Using Javascript, a company can attain data from the Internet that is needed for its product, and customize the presentation of that data for its customers.

The API Science API can be utilized, via Javascript, to provide a company’s quality assurance and developer teams the ability to better serve their customers by providing in-depth present-moment and historical API uptime and performance information in whatever format most benefits your company’s needs.

The upcoming sequence of blog posts will illustrate how you can implement this.

–Kevin Farnham