Simple metrics
Simple metrics are metrics that directly reference a single measure, without any additional measures involved. They are aggregations over a column in your data platform and can be filtered by one or multiple dimensions.
The parameters, description, and type for simple metrics are:
Parameter | Description | Type |
---|---|---|
name | The name of the metric. | Required |
description | The description of the metric. | Optional |
type | The type of the metric (cumulative, derived, ratio, or simple). | Required |
label | The value that will be displayed in downstream tools. | Required |
type_params | The type parameters of the metric. | Required |
measure | The measure you're referencing. | Required |
fill_nulls_with | Set the value in your metric definition instead of null (such as zero). | Optional |
The following displays the complete specification for simple metrics, along with an example.
metrics:
- name: The metric name # Required
description: the metric description # Optional
type: simple # Required
label: The value that will be displayed in downstream tools # Required
type_params: # Required
measure: The measure you're referencing # Required
fill_nulls_with: Set value instead of null (such as zero) # Optional
Simple metrics example
metrics:
- name: customers
description: Count of customers
type: simple # Pointers to a measure you created in a semantic model
label: Count of customers
type_params:
fills_nulls_with: 0
measure: customers # The measure you're creating a proxy of.
- name: large_orders
description: "Order with order values over 20."
type: SIMPLE
label: Large Orders
type_params:
fill_nulls_with: 0
measure: orders
filter: | # For any metric you can optionally include a filter on dimension values
{{Dimension('customer__order_total_dim')}} >= 20
0