Analytics
Usage Report
The Usage Report is an embedded AWS QuickSight dashboard for developer and API usage. It opens from Metrics, Usage Report at /developer-report and needs usage reporting enabled.
The Usage Report shows developer and API usage. It is an embedded AWS QuickSight dashboard, so it renders a QuickSight dashboard inside the page rather than charts built into the dashboard itself. In the navigation it is labelled Usage Report, and its route is /developer-report.
What is the Usage Report?
An embedded AWS QuickSight dashboard for developer and API usage. Apiable fetches a signed QuickSight embed URL and renders that dashboard in the page. The report draws on the usage events Apiable collects from your API gateway, so the data depends on those logs being connected.
How do you open the Usage Report?
Open the Metrics group in the left navigation and choose Usage Report. The page is at /developer-report. With usage reporting enabled and your gateway logs connected, it loads the embedded QuickSight dashboard.
- In the dashboard, expand the Metrics group.
- Choose Usage Report.
- With usage reporting on, the embedded QuickSight dashboard loads in the page.
Why is the Usage Report empty after you enable it?
Because no usage events have arrived yet. Apiable counts usage from your API gateway logs. After you turn on the usage add-on in Billing, you connect the gateway logs so events start flowing. Until the gateway is sending events, the report has nothing to show.
When you first enable the add-on, the page shows a short notice linking the instructions to turn on gateway logs. Follow those, then return to the report once events are arriving.
Why does the Usage Report show a placeholder?
Because usage reporting is off. If your plan does not include it, or it is not enabled yet, the page shows an example report image instead of live data, with a message that your plan does not support advanced reporting and a Go to Billing button. Enable the usage add-on to switch from the placeholder to the live report.
Does the Usage Report share data with billing?
Yes. The usage events the Usage Report draws on are the same events that drive metered billing and the per-subscription consumption developers see. One usage add-on feeds both the report and your metered plans, so the numbers come from a single source.
What charts are in the Usage Report?
The charts are defined in AWS QuickSight, not in the Apiable dashboard. This page describes the report's purpose, developer and API usage, rather than a fixed chart list, because the embedded QuickSight dashboard owns the specific visuals and can change them independently.