API Usage Dashboard

Component Overview

Enable your users to monitor and understand their usage of your API. The Usage Dashboard provides a set of filterable charts to help your users understand which APIs and endpoints they are using the most, and where they are encountering the most errors.

Using API Usage Dashboard

Visualize API Traffic

The Usage Dashboard shows various charts depicting the traffic your user is sending to your API.

Break Down API Traffic

The Usage Dashboard offers various ways of getting deeper insights into your API traffic. You can filter by API, Status, and Customer as well as predefined time ranges. These filters are synced with the page URL, enabling link sharing. You can also break down calls and errors by API/Endpoint/Customer/Status in order to better understand where traffic and errors are coming from.

When embedded, your customers will be able to do the same, though certain filters will be unavailable to them, such as Customer.