Metric report

Get multiple aggregated values grouped by common dimensions.

Use cases

Advanced reporting

Create reports with multiple metrics.

Custom reporting

Build reports with custom metrics.

Features

All the common API features, plus:

Group by dimensions

Group the results by one or more dimensions.

• Use dimensions in the query to specify the dimensions to group by

query MetricReportExample {
  metricReport(input: {
    ...
    dimensions: [
      {
        columnName: "restaurant_name"
      }
    ]
    ...
  }) {
    headers
    rows
  }
}

Ordering

Order the results based on a sort direction.

• Use orderByColumn to specify the column to order by

query MetricReportExample {
  metricReport(input: {
    ...
    orderByColumn: 1,
    ...
  }) {
    rows
  }
}

Pagination

Provides built-in cursor-based pagination for navigating through large data sets.

• Use first to specify the maximum number of records to return
• The pageInfo object in the response provides pagination details

query MetricReportExample {
  metricReport(input: {
    ...
    first: 10
    ...
  }) {
    rows
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

See our API pagination guide to learn more.

Example

Example 1: Simple metric report query

Get the total taco sales for the last 30 days, grouped by restaurant name and taco name, and count distinct orders.

Query

query MetricReportExample {
  metricReport(input: {
    timeRange: {
      relative: LAST_N_DAYS,
      n: 30
    },
    dimensions: [
      {
        columnName: "restaurant_name"
      },
      {
        columnName: "taco_name"
      }
    ],
    metrics: [
      {
        metric: {
          sum: {
            dataPool: {
              name: "TacoSoft Demo Data"
            },
            measure: {
              columnName: "taco_total_price"
            }
          }
        }
      },
      {
        metric: {
          countDistinct: {
            dataPool: {
              name: "TacoSoft Demo Data"
            },
            dimension: {
              columnName: "order_id"
            }
          }
        }
      }
    ],
    orderByColumn: 1,
    first: 3
  }) {
    headers
    rows
    pageInfo {
      startCursor
      endCursor
      hasNextPage
      hasPreviousPage
    }
  }
}

Usage

Arguments

The fields for querying a Metric Report.

A Metric Report is a table whose columns include dimensions and Metric values, calculated over a given time range.

timeRange · TimeRangeInput

The time range for calculating the Metric Report.

Show TimeRangeInput

The fields required to specify the time range for a time series, counter, or leaderboard Metric query.

If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.

If both relative and absolute time ranges are provided, the relative time range will take precedence.

If a LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.

timestamp · String

The timestamp field to use when querying. Defaults to the timestamp configured on the Data Pool or Metric, if any. Set this to filter on an alternative timestamp field.

relative · RelativeTimeRange

The relative time period.

Show RelativeTimeRange

The Relative time ranges are based on the current date and time.

THIS - The current unit of time. For example, if today is June 8, 2022, and THIS_MONTH is selected, then data for June 2022 would be returned.

PREVIOUS - The previous unit of time. For example, if today is June 8, 2022, and PREVIOUS_MONTH is selected, then data for May 2022 would be returned. It excludes the current unit of time.

NEXT - The next unit of time. For example, if today is June 8, 2022, and NEXT_MONTH is selected, then data for July 2022 would be returned. It excludes the current unit of time.

LAST_N - The last n units of time, including the current one. For example, if today is June 8, 2022 and LAST_N_YEARS with n = 3 is selected, then data for 2020, 2021, and 2022 will be returned. It will include the current time period.

​

• THIS_HOUR: Starts at the zeroth minute of the current hour and continues for 60 minutes.
• TODAY: Starts at 12:00:00 AM of the current day and continues for 24 hours.
• THIS_WEEK: Starts on Monday, 12:00:00 AM of the current week and continues for seven days.
• THIS_MONTH: Starts at 12:00:00 AM on the first day of the current month and continues for the duration of the month.
• THIS_QUARTER: Starts at 12:00:00 AM on the first day of the current calendar quarter and continues for the duration of the quarter.
• THIS_YEAR: Starts on January 1st, 12:00:00 AM of the current year and continues for the duration of the year.
• PREVIOUS_HOUR: Starts at the zeroth minute of the previous hour and continues for 60 minutes.
• YESTERDAY: Starts at 12:00:00 AM on the day before the today and continues for 24 hours.
• PREVIOUS_WEEK: Starts on Monday, 12:00:00 AM, a week before the current week, and continues for seven days.
• PREVIOUS_MONTH: Starts at 12:00:00 AM on the first day of the month before the current month and continues for the duration of the month.
• PREVIOUS_QUARTER: Starts at 12:00:00 AM on the first day of the calendar quarter before the current quarter and continues for the duration of the quarter.
• PREVIOUS_YEAR: Starts on January 1st, 12:00:00 AM, the year before the current year, and continues for the duration of the year.
• NEXT_HOUR: Starts at the zeroth minute of the next hour and continues for 60 minutes.
• TOMORROW: ” Starts at 12:00:00 AM, the day after the current day, and continues for 24 hours.
• NEXT_WEEK: Starts on Monday, 12:00:00 AM, the week after the current week, and continues for the duration of the week.
• NEXT_MONTH: Starts at 12:00:00 AM on the first day of the next month and continues for the duration of the month.
• NEXT_QUARTER: Starts at 12:00:00 AM on the first day of the next calendar quarter and continues for the duration of the quarter.
• NEXT_YEAR: Starts on January 1st, 12:00:00 AM of the next year and continues for the duration of the year.
• LAST_N_MINUTES: Starts at the zeroth second n - 1 minute(s) before the current minute and continues through the current minute. It includes this minute.
• LAST_N_HOURS: Starts at the zeroth minute of the n - 1 hour(s) before the current hour, and continues through the current hour. It includes this hour.
• LAST_N_DAYS: Starts at 12:00:00 AM, n - 1 day(s) before the current day, and continues through the current day. It includes today.
• LAST_N_WEEKS: Starts on Monday, 12:00:00 AM, n - 1 week(s) before the current week, and continues through the current week. It includes this week.
• LAST_N_MONTHS: Starts at 12:00:00 AM on the first day of the month, n - 1 month(s) before the current month, and continues through the current month. It includes this month.
• LAST_N_QUARTERS: Starts at 12:00:00 AM on the first day of the calendar quarter n - 1 quarter(s) before the current quarter and continues through the current quarter. It includes this quarter.
• LAST_N_YEARS: Starts on January 1st, 12:00:00 AM of the year n - 1 year(s) before the current year and continues through the current year. It includes this year.
• LAST_15_MINUTES
• LAST_30_MINUTES
• LAST_HOUR
• LAST_4_HOURS
• LAST_12_HOURS
• LAST_24_HOURS
• LAST_7_DAYS
• LAST_30_DAYS
• LAST_90_DAYS
• LAST_3_MONTHS
• LAST_6_MONTHS
• LAST_YEAR
• LAST_2_YEARS
• LAST_5_YEARS

n · Int

The number of time units for the LAST_N relative periods.

start · DateTime

The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool.

stop · DateTime

The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool.

timeZone · String

The time zone to use. Dates and times are always returned in UTC, but setting the time zone influences relative time ranges and granularities.

You can set this to “America/Los_Angeles”, “Europe/Berlin”, or any other value in the IANA time zone database. Defaults to “UTC”.

dimensions · [MetricReportDimensionInput!] · required

One or many dimensions to group the Metric values by. Typically, dimensions in a report are what you want to compare and rank.

Show MetricReportDimensionInput

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

columnName · String · required

The column name of the dimension to include in a Metric Report. This must match the name of a Data Pool column.

displayName · String

The name to display in the headers array when displaying the report. This defaults to the column name if unspecified.

sort · Sort

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

Show Sort

The available sort orders.

​

• ASC: Sort in ascending order.
• DESC: Sort in descending order.

metrics · [MetricReportMetricInput!] · required

One or more Metrics to include in the Metric Report. These will be broken down by dimensions.

Show MetricReportMetricInput

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

metric · MetricInput

The Metric to query. You can query a pre-configured Metric by ID or name, or you can query an ad hoc Metric that you define inline.

Show MetricInput

id · ID

The ID of a pre-configured Metric.

name · String

The name of a pre-configured Metric.

custom · CustomMetricQueryInput

An ad hoc Custom Metric.

Show CustomMetricQueryInput

dataPool · DataPoolInput · required

The Data Pool to which this Metric belongs.

Show DataPoolInput

id · ID

The ID of the Data Pool.

name · String

The name of the Data Pool.

expression · String · required

Custom expression for defining the Metric.

count · CountMetricQueryInput

An ad hoc Count Metric.

Show CountMetricQueryInput

dataPool · DataPoolInput · required

The Data Pool to which this Metric belongs.

Show DataPoolInput

id · ID

The ID of the Data Pool.

name · String

The name of the Data Pool.

sum · SumMetricQueryInput

An ad hoc Sum Metric.

Show SumMetricQueryInput

dataPool · DataPoolInput · required

The Data Pool to which this Metric belongs.

Show DataPoolInput

id · ID

The ID of the Data Pool.

name · String

The name of the Data Pool.

measure · DimensionInput · required

The column to be summed.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

average · AverageMetricQueryInput

An ad hoc Average Metric.

Show AverageMetricQueryInput

dataPool · DataPoolInput · required

The Data Pool to which this Metric belongs.

Show DataPoolInput

id · ID

The ID of the Data Pool.

name · String

The name of the Data Pool.

measure · DimensionInput · required

The column to be averaged.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

min · MinMetricQueryInput

An ad hoc Min Metric.

Show MinMetricQueryInput

dataPool · DataPoolInput · required

The Data Pool to which this Metric belongs.

Show DataPoolInput

id · ID

The ID of the Data Pool.

name · String

The name of the Data Pool.

measure · DimensionInput · required

The column to calculate the minimum from.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

max · MaxMetricQueryInput

An ad hoc Max Metric.

Show MaxMetricQueryInput

dataPool · DataPoolInput · required

The Data Pool to which this Metric belongs.

Show DataPoolInput

id · ID

The ID of the Data Pool.

name · String

The name of the Data Pool.

measure · DimensionInput · required

The column to calculate the maximum from.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

countDistinct · CountDistinctMetricQueryInput

An ad hoc Count Distinct Metric.

Show CountDistinctMetricQueryInput

dataPool · DataPoolInput · required

The Data Pool to which this Metric belongs.

Show DataPoolInput

id · ID

The ID of the Data Pool.

name · String

The name of the Data Pool.

dimension · DimensionInput · required

The column to count distinct values from.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

displayName · String

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

filterSql · String

The Query Filters to apply when calculating the Metric, in the form of SQL.

sort · Sort

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

Show Sort

The available sort orders.

​

• ASC: Sort in ascending order.
• DESC: Sort in descending order.

Show Deprecated Fields

uniqueName · String · deprecated

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

deprecated: Use metric

id · ID · deprecated

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

deprecated: Use metric

filters · [FilterInput!] · deprecated

The Query Filters to apply when calculating the Metric.

deprecated: Use filterSql instead

Show FilterInput

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.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

Show FilterOperator

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.
• IS_NULL: Selects values that are null. This operator does not accept a value.
• IS_NOT_NULL: Selects values that are not null. This operator does not accept a value.
• LIKE: Selects values that match the specified pattern.
• NOT_LIKE: “Selects values that do not match the specified pattern.

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

filterSql · String

The Query Filters to apply when building the Metric Report, in the form of SQL. These can be used to filter out rows.

orderByColumn · Int

The index of the column to order the Metric Report by. The index is 1-based and defaults to the first Metric column. In other words, by default, reports are ordered by the first Metric; however, you can order by the second Metric, third Metric, etc., by overriding the orderByColumn input. You can also order by dimensions this way.

first · Int

The number of rows to be returned when paging forward. It can be a number between 1 and 1,000.

after · String

The cursor to use when paging forward.

last · Int

The number of rows to be returned when paging forward. It can be a number between 1 and 1,000.

before · String

The cursor to use when paging backward.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Query Filters to apply when building the Metric Report. These can be used to filter out rows.

deprecated: Use filterSql instead

Show FilterInput

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.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

Show FilterOperator

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.
• IS_NULL: Selects values that are null. This operator does not accept a value.
• IS_NOT_NULL: Selects values that are not null. This operator does not accept a value.
• LIKE: Selects values that match the specified pattern.
• NOT_LIKE: “Selects values that do not match the specified pattern.

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Response

The Metric Report node object.

This type represents a single row of a report.

headers · [String] · required

An ordered array of display names for your dimensions and Metrics, as defined in the report input. Use this to display your table’s header.

row · [String] · required

An ordered array of columns. Each column contains the dimension and Metric values for a single row, as defined in the report input. Use this to display a single row within your table.