Skip to content

Commit

Permalink
config for metrics is singular rather than plural
Browse files Browse the repository at this point in the history
  • Loading branch information
dbeatty10 authored Oct 7, 2023
1 parent 0fa8b1b commit 45fce44
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/docs/docs/build/metrics-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The keys for metrics definitions are:
| `description` | Provide the description for 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 |
| `configs` | Provide the specific configurations for your metric. | Optional |
| `config` | Provide the specific configurations for your metric. | Optional |
| `label` | The display name for your metric. This value will be shown in downstream tools. | Required |
| `filter` | You can optionally add a filter string to any metric type, applying filters to dimensions, entities, or time dimensions during metric computation. Consider it as your WHERE clause. | Optional |
| `meta` | Additional metadata you want to add to your metric. | Optional |
Expand All @@ -31,7 +31,7 @@ metrics:
type: the type of the metric ## Required
type_params: ## Required
- specific properties for the metric type
configs: here for `enabled` ## Optional
config: here for `enabled` ## Optional
label: The display name for your metric. This value will be shown in downstream tools. ## Required
filter: | ## Optional
{{ Dimension('entity__name') }} > 0 and {{ Dimension(' entity__another name') }} is not
Expand Down

0 comments on commit 45fce44

Please sign in to comment.