Skip to main content

ModifyMetricInput

The fields for modifying a Metric.

fields

  • metric required ID

    The ID of the Metric to modify.

  • uniqueName optional String

    The Metric's new unique name.

  • description optional String

    The Metric's new description.

  • dimensions optional array of DimensionInput

    The Metric's new Dimensions. Used to add or remove Dimensions.

    The fields for creating or modifying a Dimension.

    • dimensions.columnName required String

      The name of the column to create the Dimension from.

  • filters optional array of FilterInput

    The Metric's new Filters. Used to add or remove Metric Filters.

    The fields for defining a Filter.

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

  • accessControlEnabled optional Boolean

    Enables or disables access control for the Metric.