Analytics
Product Analytics
Product Analytics is the dashboard report for product-level insight into API usage. It joins your subscriptions with the usage logs from your API gateway, and needs usage reporting on your plan, the Usage Events add-on and gateway usage logs.
Product Analytics is the dashboard report for product-level insight into 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 Product Analytics, at /product-report.
What is Product Analytics built from?
From your subscriptions joined with the usage logs from your API gateway. Each logged call is matched to its subscription, which brings in the plan, product, team and company. Without gateway logs, the report has subscriptions but no usage.
| Data | What it holds |
|---|---|
| Subscriptions | Each subscription's creation date, name, status, team, company, owner, plan and product. |
| Usage logs | Each call's API, method, path, response status, response size, latency and time, the caller's IP address, and the subscription and plan it was attributed to. |
The usage logs are the same records 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.
How do you get usage into Product Analytics?
Turn on the Usage Events add-on, then send your gateway's access logs to Apiable. Apiable ingests them about once an hour, and only while the add-on is on.
- Check that the Usage Events add-on reads Usage Events Enabled in Settings, Organization, Billing & Subscriptions.
- For Amazon API Gateway, set up the log stream in Enable usage logs on AWS API Gateway. For other gateways, contact Apiable.
- Make a few calls with a subscription's API key, then check the report later. Usage appears after ingestion and the next refresh of the report's data.
How do you open Product Analytics?
Open the Metrics group in the left navigation and choose Product Analytics. The page is at /product-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 Product Analytics.
- The report loads. Right after you turn on the add-on, a setup notice shows instead until the report is ready.
How does Product Analytics differ from Developer Analytics?
They are built from the same data: your subscriptions joined with your gateway usage logs. Product Analytics presents it at product level, and Developer Analytics has its own set of charts. Each opens its own page under Metrics.
Why does Product 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 Product 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.