Operations
An aggregator uses one of two operations to compute a billable metric from your events:Count
Counts the number of matching events. Use this when you bill based on the number of occurrences (e.g., API calls, logins, transactions).Sum
Sums the value of a specific numeric property across matching events. Use this when you bill based on a cumulative measure (e.g., data transferred in GB, compute hours consumed). When using Sum, you must specify which event property to aggregate.Configuration
When creating an aggregator, you configure the following:- Name: A descriptive label for the aggregator
- Event type: The type of event to aggregate (e.g.,
api_calls,storage,users) - Operation: Count or Sum (and the target property for Sum)
- Filters: Optional conditions to narrow which events are included. Filters support AND/OR logic with operators like
equals,in,gte,lt, etc. - Exposed event keys: Event fields to surface in the UI for transparency and debugging
- Allow negative values: Whether the aggregated result can go below zero
Which products use aggregators?
Not all product types require an aggregator. Here’s when you need one:| Product type | Aggregator required? | Allowed operations |
|---|---|---|
| Fee | No | — |
| Seat | No | — |
| Connected seat | Yes | Count only |
| Usage | Yes | Count, Sum |
| Credit | Yes | Count, Sum |
A seat product becomes a connected seat product when an aggregator is selected.
Managing aggregators
Navigate to Usage > Aggregators to create, edit, and delete aggregators.Create an aggregator
Click New aggregator, configure the operation, event type, and optional filters, then save.Edit an aggregator
Click on an existing aggregator to update its configuration. The detail page also shows which products are currently linked to this aggregator.Delete an aggregator
An aggregator can only be deleted if no products are linked to it.Linking an aggregator to a product
When creating or editing a usage-based, credit, or connected seat product, you select an existing aggregator from a dropdown instead of configuring metering inline.- Usage products: select any aggregator (count or sum)
- Credit products: select any aggregator (count or sum)
- Seat products: select a count aggregator (only when connected seats are enabled)