createMinMetric
This mutation creates a new Min Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).
A Metric is a business indicator measured over time. A Min Metric returns the minimum value found in the underlying data during a specific time period.
Arguments
input optional CreateMinMetricInput
The fields for creating a new Minimum (Min) Metric.
input.dataPool required ID
The Data Pool that powers this Metric.
input.uniqueName optional String
The Metric's unique name. If not specified, Propel will set the ID as unique name.
input.description optional String
The Metric's description.
input.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 for defining a Filter.
input.filters.column required String
The name of the column to filter on.
input.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.
input.filters.value required String
The value to compare the column to.
input.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.
input.dimensions.columnName required String
The name of the column to create the Dimension from.
input.measure required DimensionInput
The column to calculate the minimum from.
Returns
Nullable MetricResponse
The result of a mutation which creates or modifies a Metric.
createMinMetric.metric nullable Metric
The Metric which was created or modified.