Dashboard guide 📊

Now that your API has been integrated with our middleware, the requests from your API will start appearing in your dashboard.

You can track business-critical metrics like amount of requests to your different endpoints, response times, HTTP methods, status codes etc.

The dashboard is quite self-explanatory, but the visualization is divided into three categories:

Time frame metrics

The requests time frame allows you to visualize the API requests to your origin over a specified time frame. In addition to the total amount of requests and the historical view, you can also see the growth from the previous time frame that you've selected. So if you've for instance selected 24 hours as the time frame, the growth will be calculated from the previous 24 hours that is not shown on the graph.

The errors time frame allows you to visualize the errors that have occurred in your API over a specified time frame. You can monitor the total amount of the errors over the time frame as well as the growth from the previous time frame. So if you've for instance selected 24 hours as the time frame, the growth will be calculated from the previous 24 hours that is not shown on the graph.

Endpoint metrics

The endpoint requests bar chart breaks down your requests to their corresponding endpoints. From the right-hand side you can see the amount of requests to each endpoint. You can use the endpoints as filters by clicking them.

The endpoint-specific response time visualization gives you a similar overview than the endpoint requests visualization, except that the endpoints have been sorted by the average response times that it took for the endpoints to respond.

You may combine your dynamic endpoints into one by navigating to the "Dynamic routes" settings from the top-right menu. Yuu may also exclude specific routes or routes having a certain patter from the "Excluded routes" section from the same menu.

Geolocation metrics

All geolocation metrics are aggregated from IP addressed that we never store or expose to 3rd parties.

The country bar chart shows the amount of requests to your API from each country.

The region bar chart shows the amount of requests to your API from each region.

The city bar chart shows the amount of requests to your API from each city.

Performance metrics

The percentile thresholds tell you the exact thresholds that the specified values are within. So for instance the p75 threshold for the response times means that 75% of the requests made to the endpoint have a response time under the specified value for the given p75 value.

The response time tab shows you average and percentile values for response times of your endpoints.

The request size tab shows you average and percentile values for request sizes of your endpoints. The request size indicates the size of the body of the requests logged by your APIs.

The response size tab shows you average and percentile values for response sizes of all of your endpoints. The response size indicates the size of the body of the request responses logged by your APIs.

The CPU usage tab shows you average and percentile values for CPU usage of your endpoints. The CPU usage is calculated for each request logged by your API separately and the data you see in the dashboard is aggrated from the logged requests.

The memory usage tab shows you average and percentile values for memory usage of your endpoints. The memory usage is absolute and calculated for each request logged by your API separately and the data you see in the dashboard is aggrated from the logged requests.

The total memory tab shows you average and percentile values for the total memory of your endpoints. The values indicate the total available memory in your API and the data you see in the dashboard is aggrated from individual requests.

Status code metrics

The status code metrics show you how many times your API has responded with the shown status codes. You can use the status codes as filters by clicking them.

User agent metrics

The browser metrics show you which browser have been used to make requests to your APIs. You can use the browsers as filters by clicking them.

The operating system metrics show you which operating systems have been used to make requests to your APIs. You can use the browsers a filters by clicking them.

The device metrics show you which type of devices have been used to make requests to your APIs. You can use the devices as filters by clicking them.

How to spot bottlenecks?

With the combination of response times, percentile thresholds and the amount of requests to each endpoint, you can spot bottlenecks in your API. E.g. having large percentile thresholds means that your endpoint is probably slow.

The endpoint metrics charts give you a nice breakdown of your different endpoints and allow you to do comparisons between your endpoints. The time frame gives you an overview about the trends of your API and prepares you for e.g. peak hours.