Skip to main content

modifyMetric

This mutation selects a Metric by its ID and modifies it to have the given unique name, description, and Dimensions.

If any of the optional arguments are omitted, those properties will be unchanged on the Metric.

A Metric is a business indicator measured over time.

Arguments

  • input optional ModifyMetricInput

    The fields for modifying a Metric.

    • input.metric required ID

      The ID of the Metric to modify.

    • input.uniqueName optional String

      The Metric's new unique name.

    • input.description optional String

      The Metric's new description.

    • input.dimensions optional array of DimensionInput

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

      The fields for creating or modifying a Dimension.

    • input.filters optional array of FilterInput

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

      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.accessControlEnabled optional Boolean

      Enables or disables access control for the Metric.


Returns

Nullable MetricResponse

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