CreateSumMetricInput
The fields for creating a new Sum Metric.
fields
dataPool required ID
The Data Pool that powers this Metric.
uniqueName optional String
The Metric's unique name. If not specified, Propel will set the ID as unique name.
description optional String
The Metric's description.
filters optional array of FilterInput
The Metric's Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
The fields of a filter.
You can construct more complex filters using
and
andor
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
you could write
{ "column": "value", "operator": "GREATER_THAN", "value": "0", "and": [{ "column": "value", "operator": "LESS_THAN_OR_EQUAL_TO", "value": "0" }], "or": [{ "column": "status", "operator": "EQUALS", "value": "confirmed" }] }
Note that
and
takes precedence overor
.filters.column required String
The name of the column to filter on.
filters.operator required FilterOperator
The operation to perform when comparing the column and filter values.
The available Filter operators.
EQUALS
Selects values that are equal to the specified value.
NOT_EQUALS
Selects values that are not equal to the specified value.
GREATER_THAN
Selects values that are greater than the specified value.
GREATER_THAN_OR_EQUAL_TO
Selects values that are greater or equal to the specified value.
LESS_THAN
Selects values that are less than the specified value.
LESS_THAN_OR_EQUAL_TO
Selects values that are less or equal to the specified value.
filters.value required String
The value to compare the column to.
filters.and optional array of FilterInput
Additional filters to AND with this one. AND takes precedence over OR.
filters.or optional array of FilterInput
Additional filters to OR with this one. AND takes precedence over OR.
dimensions optional array of DimensionInput
The Metric's Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.
The fields for creating or modifying a Dimension.
dimensions.columnName required String
The name of the column to create the Dimension from.
measure required DimensionInput
The column to be summed.