Skip to main content

MetricEdge

The Metric edge object.

Learn more about pagination in GraphQL.

fields

  • cursor non-null String

    The edge's cursor.

  • node non-null Metric

    The edge's node.

    The Metric object.

    A Metric is a business indicator measured over time.

    Learn more about Metrics.

    • node.id non-null ID

      The Metric's unique identifier.

    • node.uniqueName non-null String

      The Metric's unique name.

    • node.description non-null String

      The Metric's description.

    • node.account non-null Account

      The Metric's Account.

    • node.environment non-null Environment

      The Metric's Environment.

    • node.createdAt non-null DateTime

      The Metric's creation date and time in UTC.

    • node.modifiedAt non-null DateTime

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

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

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

    • node.dataPool nullable DataPool

      The Data Pool that powers this Metric.

    • node.dimensions non-null array of Dimension

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

    • node.timestamp non-null Dimension

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

    • node.boosters non-null BoosterConnection

      List the Boosters associated to the Metric.

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

      • CUSTOM

        Aggregates values based on the provided custom expression.

    • node.settings non-null MetricSettings

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


    • node.counter nullable CounterResponse

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

    • node.timeSeries nullable TimeSeriesResponse

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

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

    • node.policies non-null PolicyConnection

      List the Policies associated to the Metric.

    • node.accessControlEnabled non-null Boolean

      Whether or not access control is enabled for the Metric.