Embedded Dashboards via Usage API

Dashboards using the Kable usage API

The usage API allows you to query real-time data from Kable for display within your developer portal. You can display the API response with any popular frontend charting library.

🚧

You should choose the Usage API option if you want greater control over the look and feel of your dashboard UX.

With this option, you'll query metrics from Kable using the usage API, and then display these metrics within charts or graphs rendered by your own choice of frontend library.

Kable Usage API

See the usage API within the API Reference for details about how to pull metrics from Kable.

  • You can pull individual metrics (like count of transactions or count of distinct users) for a particular aggregation over a particular time interval from Kable.
  • You can also pull time-series data (like transactions per month, webhooks per day, or requests per hour) for a particular aggregation over a particular time interval from Kable. The returned intervals map nicely into many popular frontend chart libraries (more below).

Display Metrics

You can use data from the metrics API for display in your library of choice.

  • Individual numerical metrics are easy to display in whatever format you choose.
  • Time-series data can easily be displayed using any popular frontend library you choose.

The usage API returns time-series data in a format that is easy to use for any frontend use cases. Most of these frontend libraries accept a similar format, which make it super easy to integrate Kable data within your frontend library of choice.

👍

Chart.js, CanvasJS, and Dygraphs are three popular UI libraries available for displaying charts and metrics. There are many other options too, or you can build your own UX.

If you have questions about how to integrate API data into a frontend library, let us know.


Did this page help you?