APImetrics

The APImetrics Developer Hub

Welcome to the APImetrics developer hub. You'll find comprehensive guides and documentation to help you start working with APImetrics as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

What is APImetrics?

APImetrics is an API performance and quality monitoring system. It allows you to understand how the APIs you care about are actually behaving from the end user's perspective in the real world beyond the data center. For instance, with APImetrics, you can see exactly what is in the payload that is being sent back by an API or whether an API is meeting its Service Level Objectives.

Key Concepts

APImetrics is an API performance and quality monitoring system. It allows you to understand how the APIs you care about are actually behaving from the end user's perspective in the real world beyond the data center. For instance, with APImetrics, you can see exactly what is in the payload that is being sent back by an API or whether an API is meeting its Service Level Objectives.

Setting up and making API test calls

At the core of APImetrics are the API test calls that you define. These tests are usually deployed to some or all of the commercial cloud service locations that APImetrics supports on five continents. The APImetrics software agent running at a cloud location is periodically instructed to make make a test call to the defined API endpoint. It is also possible to deploy tests to be run from APImetrics agents located on physical or virtual servers within your own internal network behind the corporate firewall.

A wizard guides you through creating an API test call. When you first log into APImetrics, you will find that we have already predefined a first test call for you so that you can get started straightaway by editing or copying that call as an example. You can also look at the results and insights associated with the call.

What your dashboard will look like when you first log in

What your dashboard will look like when you first log in

What the Edit screen for your predefined call looks like

What the Edit screen for your predefined call looks like

A typical example of a first result with the predefined API call

A typical example of a first result with the predefined API call

We also provide help setting up and managing authentications and tokens, which makes handling these potentially tricky issues straightforward. Getting API authorization to function smoothly and reliably can be one of the most difficult aspects of working with APIs. Amongst other types of authorizations, APImetrics handles API key in request, Basic Auth, industry standard OAuth2 (and several variants of OAuth2), as well as manual setup for non-standard scenarios.

Workflows allow you to test business processes. They are back-to-back tests in each part of the output of one call is used in the input to the next call.

Working with results

Once you have deployed some tests, you will very soon have accumulated a collection of data that you can use the built-in statistical analysis in APImetrics to drill down into. You can create reports and use a range of visualisations on your homepage dashboard to allow you to see at a glance how your APIs are behaving.

APImetrics can send you an alert if there is a problem with one of your APIs. You can set conditions on a call so that a user-defined warning or error is generated if, for instance, the latency of a call is more than a certain limit or there are empty fields in the returned JSON payload. Webhooks can be used to raise tickets in your higher level management system. APImetrics supports a range of API definition languages, including Postman and Swagger, for bulk import of APIs. Naturally enough, APImetrics supports its own rich API that allows you to integrate it with your business critical systems.

Understanding Insights

The CASC (Cloud API Service Consistency) score is a credit score-like rating that blends together a number of key metrics associated with each API, benchmarked against our unrivalled collection of historical API test data, to give a single number that allows you at a glance to see what the quality of an API is, whether it is getting better or worse over and how it compares to any other API, whether your own API or a third party one. Insights also also you to understand how the behaviour of APIs differs between cloud service and regions allowing you, for instance, to choose the best locations to host your services.

What is APImetrics?

APImetrics is an API performance and quality monitoring system. It allows you to understand how the APIs you care about are actually behaving from the end user's perspective in the real world beyond the data center. For instance, with APImetrics, you can see exactly what is in the payload that is being sent back by an API or whether an API is meeting its Service Level Objectives.