Skip to main content

MetricReportMetricInput

The fields for specifying a Metric to include in a Metric Report.

fields

  • uniqueName optional String

    The Metric's unique name. If not specified, Propel will lookup the Metric by ID.

  • id optional ID

    The Metric's ID. If not specified, Propel will lookup the Metric by unique name.

  • displayName optional String

    The name to display in the headers array when displaying the report. This defaults to the Metric's unique name if unspecified.

  • filters optional array of FilterInput

    The Query Filters to apply when calculating the Metric.

    The fields of a filter.

    You can construct more complex filters using and and or. 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 over or.

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

  • sort optional Sort

    The sort order for the Metric. It can be ascending (ASC) or descending (DESC) order. Defaults to descending (DESC) order when not provided.

    The sort order options for Metric Queries.

    • ASC

      Sort in ascending order.

    • DESC

      Sort in descending order.