Aggregations

How should metrics be evaluated?

📘

Aggregations define how a given dimension metric is evaluated.

If dimensions are the what, then aggregations are the how for a given measurement.

Aggregations help define how usage metrics are evaluated for pricing plans and in dashboards. When defining a pricing plan, you'll set both a dimension and an aggregation to determine usage. Your dashboards also will reflect dimension metrics through some aggregation.

The following aggregations are supported by Kable:

NameAPI FieldDescriptionExamples
CountCOUNTCounts, as the name implies, count the total number of occurrences of some dimension.- count of requests to your API
- count of messages sent by your API (as in the Mailman example in Quick Start)
Count DistinctCOUNT_DISTINCTDistinct counts track how many unique occurrences of some dimension occur.- count distinct active users (popular with authentication APIs)
- count distinct accounts accessed (popular with financial APIs)
SumSUMFor numerical values, sums track the mathematical sum of values accrued over some duration.- sum of revenue accrued (popular with financial APIs)
- sum of instance seconds (popular with infrastructure APIs)

Aggregations are particularly important when configuring pricing plans. The aggregation you choose for a given plan determines the metric against which the plan will be billed.

👍

We offer free pricing strategy consultations to all of our customers. If you have questions about how best to set up your billing model, let us know.