Analytics
Developer Analytics
Developer Analytics is the dashboard report on developer and API usage. It is built from your subscriptions joined with the usage logs from your API gateway, the same logs metered billing reads, and needs the Usage Events add-on and gateway usage logs.
Developer Analytics is the dashboard report on developer and API usage. It is an AWS QuickSight dashboard embedded in the page, so its charts come from QuickSight rather than from the dashboard itself. In the navigation it is Developer Analytics, at /developer-report.
What is Developer Analytics built from?
From your subscriptions joined with the usage logs from your API gateway, the same data as Product Analytics. Each logged call is matched to its subscription, which brings in the team, company, plan and product.
The usage logs carry each call's API, method, path, response status, response size, latency and time, and the caller's IP address. Without gateway logs, the report has subscriptions but no usage.
How do you open Developer Analytics?
Open the Metrics group in the left navigation and choose Developer Analytics. The page is at /developer-report. With usage reporting on your plan, the add-on on and your gateway logs connected, the embedded report shows your usage.
- In the dashboard, expand the Metrics group.
- Choose Developer Analytics.
- The report loads. Right after you turn on the add-on, a setup notice shows instead until the report is ready.
Why is Developer Analytics empty after you enable it?
Because no usage has arrived yet. Apiable counts usage from your API gateway's logs, ingests them about once an hour while the add-on is on, and the report shows them after its data is next refreshed.
While your reports are being set up, each report page shows "You just enabled the usage events addon. Please follow the instructions to enable the api gateway logs in your gateway." For Amazon API Gateway, follow Enable usage logs on AWS API Gateway. For other gateways, contact Apiable.
Does Developer Analytics share data with billing?
Yes. It reads the same gateway usage logs that usage-based billing reads, so the report and metered billing start from the same records. Which calls are billed still depends on each plan's pricing.
Why does Developer Analytics show a placeholder?
Your plan does not include usage reporting, or the Usage Events add-on is off. The page shows an example report under a dialog that says your plan does not support advanced reporting, in both cases.
Choose Go to Billing and turn the add-on on in Billing & Subscriptions. If the toggle is disabled, usage reporting is not on your plan, so contact Apiable. Close takes you back to the dashboard home.
What charts are in Developer Analytics?
The charts are defined in AWS QuickSight, not in the Apiable dashboard, and can change there without a dashboard release. This page describes the report's data rather than a fixed chart list.