diff --git a/website/docs/docs/build/ratio-metrics.md b/website/docs/docs/build/ratio-metrics.md
index cc1d13b7835..fdaeb878450 100644
--- a/website/docs/docs/build/ratio-metrics.md
+++ b/website/docs/docs/build/ratio-metrics.md
@@ -24,6 +24,8 @@ Ratio allows you to create a ratio between two metrics. You simply specify a num
The following displays the complete specification for ratio metrics, along with an example.
+
+
```yaml
metrics:
- name: The metric name # Required
@@ -40,11 +42,19 @@ metrics:
filter: Filter for the denominator # Optional
alias: Alias for the denominator # Optional
```
+
For advanced data modeling, you can use `fill_nulls_with` and `join_to_timespine` to [set null metric values to zero](/docs/build/fill-nulls-advanced), ensuring numeric values for every data row.
## Ratio metrics example
+These examples demonstrate how to create ratio metrics in your model. They cover basic and advanced use cases, including applying filters to the numerator and denominator metrics.
+
+#### Example 1
+This example is a basic ratio metric that calculates the ratio of food orders to total orders:
+
+
+
```yaml
metrics:
- name: food_order_pct
@@ -55,6 +65,30 @@ metrics:
numerator: food_orders
denominator: orders
```
+
+
+#### Example 2
+This example is a ratio metric that calculates the ratio of food orders to total orders, with a filter and alias applied to the numerator. Note that in order to add these attributes, you'll need to use an explicit key for the name attribute too.
+
+
+
+```yaml
+metrics:
+ - name: food_order_pct
+ description: "The food order count as a ratio of the total order count, filtered by location"
+ label: Food order ratio by location
+ type: ratio
+ type_params:
+ numerator:
+ name: food_orders
+ filter: location = 'New York'
+ alias: ny_food_orders
+ denominator:
+ name: orders
+ filter: location = 'New York'
+ alias: ny_orders
+```
+
## Ratio metrics using different semantic models
@@ -109,6 +143,8 @@ on
Users can define constraints on input metrics for a ratio metric by applying a filter directly to the input metric, like so:
+
+
```yaml
metrics:
- name: frequent_purchaser_ratio
@@ -123,6 +159,7 @@ metrics:
denominator:
name: distinct_purchasers
```
+
Note the `filter` and `alias` parameters for the metric referenced in the numerator.
- Use the `filter` parameter to apply a filter to the metric it's attached to.