Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

The Usage section gives you a client-wide view of every aggregator, with a chart per aggregator covering all customers and all subscriptions. From there, you can drill into any aggregator to see which customers are driving its consumption. Access it from the sidebar under Usages > Usage.

​
Aggregator cards

Each aggregator is displayed as a card showing:
  • Aggregator name and unit (e.g. API calls, GB)
  • Total aggregated value for the selected period across all customers
  • Area chart of the value evolution over time, with one line per aggregator filter when filters are defined
  • Threshold lines as dashed horizontal references when thresholds are set on the aggregator
Numbers are rendered with a compact format (e.g. 1.2M instead of 1,200,000) so cards stay readable at a glance.

​
Period and grouping

Use the date range picker at the top of the page to select a custom period. You can also choose how data is grouped:
Group byBest for
MonthlyLong-term trends (presets: last 3/6/12 months, current/past year)
DailyWeekly or monthly analysis (presets: this/last week, current/past month)
HourlyIntraday monitoring (presets: today, yesterday, this/last week)
Presets adapt to the selected grouping. Filter values are persisted in the URL, so a view can be shared by copying the link. Sort cards alphabetically by name, ascending or descending. Use the search box to narrow the list when you have many aggregators.

​
Group by customer

Click Explore consumption on any usage card to open a side panel. It ranks customers by their contribution to the aggregator over the selected period. The panel shows:
  • Customer — name and link to the customer’s profile
  • Value — that customer’s aggregated total for the period (compact format)
Rows are ordered by total descending (top consumers first) and paginated 20 at a time. The date range and grouping are inherited from the parent page; you can refine the breakdown to a single aggregator filter using the filter selector.
The explore panel allows to compare contributions across multiple filters, switch the selected filter or open the panel from a different aggregator card.

​
Aggregator details

From the card’s dropdown menu, you can open the aggregator’s detail page to review its configuration (operation, event type, filters, thresholds) or edit it. See Aggregators for the full configuration reference.

​
Permissions

Access to the Usage section is gated by the usages_read permission. Manage permissions per role from Settings > Roles, under the Usage group. Existing roles that already had the events_read permission were granted usages_read automatically. New roles must opt in.