Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update code to align with table #4753

Merged
merged 6 commits into from
Jan 16, 2024
Merged

update code to align with table #4753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1974b67
update code to align with table
mirnawong1 Jan 16, 2024
8c7c462
Update metrics-overview.md
mirnawong1 Jan 16, 2024
de140cf
Update website/docs/docs/build/metrics-overview.md
mirnawong1 Jan 16, 2024
d89dd89
Update website/docs/docs/build/metrics-overview.md
mirnawong1 Jan 16, 2024
20e1acf
Merge branch 'current' into mirnawong1-patch-22
mirnawong1 Jan 16, 2024
f7a7c2b
Merge branch 'current' into mirnawong1-patch-22
mirnawong1 Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions website/docs/docs/build/conversion-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,11 @@ The following code example displays the complete specification for conversion me
```yaml
metrics:
- name: The metric name # Required
description: the metric description # Required
type: conversion
type_params:
conversion_type_params:
description: the metric description # Optional
type: conversion # Required
label: # Required
type_params: # Required
conversion_type_params: # Required
entity: ENTITY # Required
calculation: CALCULATION_TYPE # Optional. default: conversion_rate. options: conversions(buys) or conversion_rate (buys/visits), and more to come.
base_measure: MEASURE # Required
Expand Down
20 changes: 9 additions & 11 deletions website/docs/docs/build/metrics-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The keys for metrics definitions are:
| Parameter | Description | Type |
| --------- | ----------- | ---- |
| `name` | Provide the reference name for the metric. This name must be unique amongst all metrics. | Required |
| `description` | Provide the description for your metric. | Optional |
| `description` | Describe your metric. | Optional |
| `type` | Define the type of metric, which can be `simple`, `ratio`, `cumulative`, or `derived`. | Required |
| `type_params` | Additional parameters used to configure metrics. `type_params` are different for each metric type. | Required |
| `config` | Provide the specific configurations for your metric. | Optional |
Expand Down Expand Up @@ -55,10 +55,11 @@ This page explains the different supported metric types you can add to your dbt
```yaml
metrics:
- name: The metric name # Required
description: the metric description # Required
type: conversion
type_params:
conversion_type_params:
description: the metric description # Optional
type: conversion # Required
label: # Required
type_params: # Required
conversion_type_params: # Required
entity: ENTITY # Required
calculation: CALCULATION_TYPE # Optional. default: conversion_rate. options: conversions(buys) or conversion_rate (buys/visits), and more to come.
base_measure: MEASURE # Required
Expand All @@ -71,10 +72,10 @@ metrics:

### Cumulative metrics

[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**, you will need to create the [time spine model](/docs/build/metricflow-time-spine) before you add cumulative metrics.
[Cumulative metrics](/docs/build/cumulative) aggregate a measure over a given window. If no window is specified, the window will accumulate the measure over all of the recorded time period. Note that 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)
# 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 of time)
metrics:
- name: wau_rolling_7
owners:
Expand Down Expand Up @@ -126,7 +127,7 @@ metrics:

### Ratio metrics

[Ratio metrics](/docs/build/ratio) involve a numerator metric and a denominator metric. A `constraint` string can be applied, to both numerator and denominator, or applied separately to the numerator or denominator.
[Ratio metrics](/docs/build/ratio) involve a numerator metric and a denominator metric. A `constraint` string can be applied to both the numerator and denominator or separately to the numerator or denominator.

```yaml
# Ratio Metric
Expand Down Expand Up @@ -192,9 +193,6 @@ You can set more metadata for your metrics, which can be used by other tools lat

- **Description** — Write a detailed description of the metric.

<!--Provide a detailed description of the metric. This description surfaced in the main “definition” section of the metric page using rich Markdown formatting in the Transform UI. [this includes transform and not sure how this looks in core and cloud]-->


## Related docs

- [Semantic models](/docs/build/semantic-models)
Expand Down
Loading