diff --git a/website/docs/docs/build/cumulative-metrics.md b/website/docs/docs/build/cumulative-metrics.md index 77d23d32dce..efdde600635 100644 --- a/website/docs/docs/build/cumulative-metrics.md +++ b/website/docs/docs/build/cumulative-metrics.md @@ -8,6 +8,12 @@ tags: [Metrics, Semantic Layer] Cumulative metrics aggregate a measure over a given window. If no window is specified, the window is considered infinite and accumulates values over all time. +:::info MetricFlow time spine required + +You will need to create the [time spine model](/docs/build/metricflow-time-spine) before you add cumulative metrics. + +::: + ```yaml # Cumulative metrics aggregate a measure over a given window. The window is considered infinite if no window parameter is passed (accumulate the measure over all time) metrics: @@ -24,7 +30,7 @@ metrics: ### Window options -This section details examples for when you specify and don't specify window options. +This section details examples of when you specify and don't specify window options. @@ -56,7 +62,7 @@ metrics: window: 7 days ``` -From the sample yaml above, note the following: +From the sample YAML above, note the following: * `type`: Specify cumulative to indicate the type of metric. * `type_params`: Specify the measure you want to aggregate as a cumulative metric. You have the option of specifying a `window`, or a `grain to date`. @@ -142,7 +148,7 @@ metrics: ```yaml metrics: name: revenue_monthly_grain_to_date #For this metric, we use a monthly grain to date - description: Monthly revenue using a grain to date of 1 month (think of this as a monthly resetting point) + description: Monthly revenue using grain to date of 1 month (think of this as a monthly resetting point) type: cumulative type_params: measures: diff --git a/website/docs/docs/build/metrics-overview.md b/website/docs/docs/build/metrics-overview.md index b2cadb9116f..351c674ca8a 100644 --- a/website/docs/docs/build/metrics-overview.md +++ b/website/docs/docs/build/metrics-overview.md @@ -28,7 +28,7 @@ This page explains the different supported metric types you can add to your dbt ### Cumulative metrics -[Cumulative metrics](/docs/build/cumulative) aggregate a measure over a given window. Note that if no window is specified, the window would accumulate the measure over all time. +[Cumulative metrics](/docs/build/cumulative) aggregate a measure over a given window. If no window is specified, the window would accumulate the measure over all time. **Note**m, you will need to create the [time spine model](/docs/build/metricflow-time-spine) before you add cumulative metrics. ```yaml # Cumulative metrics aggregate a measure over a given window. The window is considered infinite if no window parameter is passed (accumulate the measure over all time)