Skip to main content

createCustomMetric

Creates a new Custom Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).

Learn more about Metrics.

Arguments

  • input optional CreateCustomMetricInput

    The fields for creating a new Custom 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.

    • 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.

    • input.expression required String

      The expression that defines the aggregation function for this Metric.


Returns

Nullable MetricResponse

The result of a mutation which creates or modifies a Metric.