Analytics

Analytics gives you three reports in the dashboard, under the Metrics group: Portal Analytics, Product Analytics and Developer Analytics. Each is an AWS QuickSight dashboard embedded in the page. They need usage reporting on your plan and the paid Usage Events add-on.

What reports does Apiable provide?

Three, under the Metrics group: Portal Analytics for your portal's sign-ups, teams and subscriptions, and Product Analytics and Developer Analytics for the API usage your gateway logs. Each opens its own page.

What do you need to see a report?

Usage reporting on your plan, and the Usage Events add-on turned on for your organization. Product Analytics and Developer Analytics also need usage logs from your API gateway. Until the add-on is on, each report shows a placeholder.

1. Usage reporting on your plan. Without it, the add-on toggle is disabled. Contact Apiable to add it to your plan.
2. The Usage Events add-on. Open Settings, Organization, Billing & Subscriptions. In the Usage Events Add-on block, switch the toggle on and choose Confirm. The block then reads Usage Events Enabled.
3. Gateway usage logs, for Product Analytics and Developer Analytics. For Amazon API Gateway, follow Enable usage logs on AWS API Gateway. For other gateways, contact Apiable.

What does the Usage Events add-on cost, and how do you turn it off?

It is paid. The confirmation reads "You will be billed per million usage events", and the block says it is charged per package of 1 million API calls. The dashboard cannot turn it off. To cancel it, contact Apiable support.

Unless your organization is on custom billing, confirming adds the add-on to your Apiable subscription. On custom billing, the block shows your current month charges as custom. While the add-on is on, the block also shows your total usage events this month.

Switching the toggle off does not cancel anything. It opens a message saying the add-on cannot be cancelled automatically yet and asking you to contact the support team. For the rest of the page, see Your Apiable billing.

Where does the usage data come from?

From your API gateway's access logs. For Amazon API Gateway, you stream them to a bucket that Apiable reads, as described in Enable usage logs on AWS API Gateway. Apiable ingests them about once an hour, and only while the add-on is on.

These are the same usage logs that usage-based billing reads, so Product Analytics, Developer Analytics and metered billing start from the same records. Which calls are billed still depends on each plan's pricing. Portal Analytics does not use them. For why usage data matters to how you price your APIs, see API monetization.

What happens right after you turn on the add-on?

Apiable sets up your reports in the background. Until a report is ready, its page shows "You just enabled the usage events addon. Please follow the instructions to enable the api gateway logs in your gateway." The page loads the report by itself once it is ready.

The notice appears on all three reports, and its link opens instructions for Amazon API Gateway. Portal Analytics needs no gateway logs, so on that report you can ignore it.

Why do you see a placeholder instead of a report?

Because 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 reads Please upgrade to access this feature and says your plan does not support advanced reporting, in both cases.

Go to Billing opens Billing & Subscriptions, where you can turn the add-on on if your plan includes it. Close takes you back to the dashboard home.

How fresh is the data?

The reports are not live. Portal Analytics picks up new sign-ups, teams and subscriptions about once an hour, and changes to existing records, such as a subscription's status, once a week, on Mondays (UTC). New usage first waits for log ingestion, about once an hour.

After ingestion, usage reaches Product Analytics and Developer Analytics when their report data is next refreshed. Allow for both delays when you test with a few calls.

How are the reports built?

Each report is an AWS QuickSight dashboard embedded in the page. The dashboard fetches a signed link to your report and renders it. The charts are defined in QuickSight, so they can change without a dashboard release.

These docs describe each report's purpose and data rather than a fixed chart list.

Each embedded session lasts up to 100 minutes. If a report stops responding after the page has been open a long time, reload the page.

Troubleshooting

Where to next