Skip to main content

migrateMetric

Arguments

  • input required MigrateMetricInput

    The fields for migrating a Metric's Data Pool.

    • input.metricId required ID

      The Metric that is going to be migrated.

    • input.newDataPoolId required ID

      The DataPool to which the Metric is going to be migrated.


Returns

Nullable Metric

The Metric object.

A Metric is a business indicator measured over time.

Learn more about Metrics.

  • migrateMetric.id non-null ID

    The Metric's unique identifier.

  • migrateMetric.uniqueName non-null String

    The Metric's unique name.

  • migrateMetric.description non-null String

    The Metric's description.

  • migrateMetric.account non-null Account

    The Metric's Account.

  • migrateMetric.environment non-null Environment

    The Metric's Environment.

  • migrateMetric.createdAt non-null DateTime

    The Metric's creation date and time in UTC.

  • migrateMetric.modifiedAt non-null DateTime

    The Metric's last modification date and time in UTC.

  • migrateMetric.createdBy non-null String

    The Metric's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.

  • migrateMetric.modifiedBy non-null String

    The Metric's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.

  • migrateMetric.dataPool nullable DataPool

    The Data Pool that powers this Metric.

  • migrateMetric.dimensions non-null array of Dimension

    The Metric's Dimensions. These Dimensions are available to Query Filters.

  • migrateMetric.timestamp non-null Dimension

    The Metric's timestamp. This is the same as its Data Pool's timestamp.

  • migrateMetric.boosters non-null BoosterConnection

    List the Boosters associated to the Metric.

  • migrateMetric.type non-null MetricType

    The Metric's type. The different Metric types determine how the values are calculated.

    The available Metric types.

    • COUNT

      Counts the number of records that matches the Metric Filters. For time series, it will count the values for each time granularity.

    • SUM

      Sums the values of the specified column for every record that matches the Metric Filters. For time series, it will sum the values for each time granularity.

    • COUNT_DISTINCT

      Counts the number of distinct values in the specified column for every record that matches the Metric Filters. For time series, it will count the distinct values for each time granularity.

    • AVERAGE

      Averages the values of the specified column for every record that matches the Metric Filters. For time series, it will average the values for each time granularity.

    • MIN

      Selects the minimum value of the specified column for every record that matches the Metric Filters. For time series, it will select the minimum value for each time granularity.

    • MAX

      Selects the maximum value of the specified column for every record that matches the Metric Filters. For time series, it will select the maximum value for each time granularity.

  • migrateMetric.settings non-null MetricSettings

    The settings for the Metric. The settings are specific to the Metric's type.


  • migrateMetric.counter nullable CounterResponse

    The Metric data in counter format. A single metric value for the given time range and filters.

  • migrateMetric.timeSeries nullable TimeSeriesResponse

    The Metric data in time series format. Arrays of timestamps and Metric values for the given time range and filters.

  • migrateMetric.leaderboard nullable LeaderboardResponse

    The Metric data in leaderboard format. A table (array of rows) with the selected dimensions and corresponding Metric values for the given time range and filters.

  • migrateMetric.policies non-null PolicyConnection

    List the Policies associated to the Metric.

  • migrateMetric.accessControlEnabled non-null Boolean

    Whether or not access control is enabled for the Metric.