Dimensions
What are the metrics that are important to your business?
Dimensions are metrics that are meaningful to your business.
Dimensions explain what you want to measure in your API, and form the basis for any metrics, dashboards, or pricing plans you define. When you record usage metrics, dimensions tell Kable what is important to you to track.
- A messaging API might track messages sent with a Message dimension with key
messageId. - An authentication API might track monthly active users with a User dimension with key
userId. - A payments API might track payment volume with a Payment Amount dimension with key
paymentAmountInCents.
You might also create dimensions for API routes, response codes, or any other metrics that might be important to track.
| Name | API Field | Description |
|---|---|---|
| ID | dimensionId | A Kable-defined identifier for each dimension (which you don't need to store). |
| Name | name | A human-readable description of the dimension. Dimension names will appear in dashboards, on invoices, and in reports. |
| Key | key | The key in a JSON key-value pair, and uniquely identifies a dimension when you record usage metrics in Kable. |
When you record metrics in Kable, you'll pass JSON key-value pairs into the payload of the event. For each dimension, you'll include the key as well as some value to assign. These values are stored and considered in aggregations by Kable.
You can define dimensions in the Dimensions tab of your dashboard. You'll set a name and key for each dimension. You can also toggle whether or not the dimension is visible on the main page of your dashboard and in any customer-facing embedded dashboards.
Terminology
You may have heard the term "meter" before. This term often describes the same concept as the Kable dimension. We believe "dimension" to be more self-explanatory and easier to understand as terminology.
Updated 8 months ago