Analytics
Portal Analytics
Portal Analytics is the dashboard report on your API Portal's sign-ups, teams and subscriptions. It opens from Metrics, Portal Analytics, needs usage reporting on your plan and the Usage Events add-on, and does not need gateway logs.
Portal Analytics is the dashboard report on your API Portal's sign-ups, teams and subscriptions. It is an AWS QuickSight dashboard embedded in the page, so its charts come from QuickSight rather than from the dashboard itself.
What is Portal Analytics built from?
From your portal's own records, not from API traffic. It has three sets of data: the people who signed up, the teams they formed, and the subscriptions those teams hold. It uses no gateway usage logs.
| Data | What it holds |
|---|---|
| Users | Each portal user's sign-up date, name and email. |
| Teams | Each team's creation date, name and company. |
| Subscriptions | Each subscription's creation date, name, status, team, company, owner, plan and product. |
For API usage, such as calls per plan or per developer, see Product Analytics and Developer Analytics.
How do you open Portal Analytics?
Open the Metrics group in the left navigation and choose Portal Analytics. The page is at /portal-report. With usage reporting on your plan and the add-on on, the embedded report loads in the page.
- In the dashboard, expand the Metrics group.
- Choose Portal Analytics.
- The report loads. Right after you turn on the add-on, a setup notice shows instead until the report is ready.
The setup notice asks you to enable gateway logs. Portal Analytics does not need them, so you only need to wait.
How up to date is Portal Analytics?
It is not live. New sign-ups, teams and subscriptions appear within about an hour. Changes to records that already exist, such as a change to a subscription's status, appear after the weekly full refresh on Mondays (UTC).
Why does Portal 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 Portal 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.