Inputs

DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

DataGridInput

The fields for querying Data Grid records.

DataPoolInput

required

The Data Pool to be queried.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

TimeRangeInput

The time range for retrieving the records.

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.

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.

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

Int

The number of time units for the LAST_N relative periods.

DateTime

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

DateTime

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

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

[String!]

required

The columns to retrieve.

Int

The index of the column to order the table by. The index is 1-based. If not provided, records will be ordered by their timestamp by default.

Sort

The sort order of the rows. 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.

String

The filters to apply to the records, in the form of SQL. You may only filter on columns included in the columns array input.

Int

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

String

The cursor to use when paging forward.

Int

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

String

The cursor to use when paging backward.

Show Deprecated Fields

[FilterInput!]

deprecated

The filters to apply to the records. You may only filter on columns included in the columns array input.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.

String

required

The name of the column to filter on.

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.

String

The value to compare the column to.

[FilterInput!]

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

[FilterInput!]

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

MetricReportInput

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.

TimeRangeInput

The time range for calculating the Metric Report.

Show TimeRangeInput

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.

RelativeTimeRange

The relative time period.

Show RelativeTimeRange

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

Int

The number of time units for the LAST_N relative periods.

DateTime

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

DateTime

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

String

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

String

required

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

String

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

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.

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

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

The ID of a pre-configured Metric.

String

The name of a pre-configured Metric.

CustomMetricQueryInput

An ad hoc Custom Metric.See CustomMetricQueryInput

CountMetricQueryInput

An ad hoc Count Metric.See CountMetricQueryInput

SumMetricQueryInput

An ad hoc Sum Metric.See SumMetricQueryInput

AverageMetricQueryInput

An ad hoc Average Metric.See AverageMetricQueryInput

MinMetricQueryInput

An ad hoc Min Metric.See MinMetricQueryInput

MaxMetricQueryInput

An ad hoc Max Metric.See MaxMetricQueryInput

CountDistinctMetricQueryInput

An ad hoc Count Distinct Metric.See CountDistinctMetricQueryInput

String

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

String

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

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

String

deprecated

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

deprecated

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

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

String

required

The name of the column to filter on.

FilterOperator

required

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

String

The value to compare the column to.

[FilterInput!]

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

[FilterInput!]

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

String

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

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.

Int

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

String

The cursor to use when paging forward.

Int

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

String

The cursor to use when paging backward.

Show Deprecated Fields

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

String

required

The name of the column to filter on.

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.

String

The value to compare the column to.

[FilterInput!]

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

[FilterInput!]

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

MetricReportDimensionInput

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

String

required

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

String

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

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.

MetricReportMetricInput

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

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

The ID of a pre-configured Metric.

String

The name of a pre-configured Metric.

CustomMetricQueryInput

An ad hoc Custom Metric.

Show CustomMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

String

required

Custom expression for defining the Metric.

CountMetricQueryInput

An ad hoc Count Metric.

Show CountMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

SumMetricQueryInput

An ad hoc Sum Metric.

Show SumMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to be summed.See DimensionInput

AverageMetricQueryInput

An ad hoc Average Metric.

Show AverageMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to be averaged.See DimensionInput

MinMetricQueryInput

An ad hoc Min Metric.

Show MinMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to calculate the minimum from.See DimensionInput

MaxMetricQueryInput

An ad hoc Max Metric.

Show MaxMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to calculate the maximum from.See DimensionInput

CountDistinctMetricQueryInput

An ad hoc Count Distinct Metric.

Show CountDistinctMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to count distinct values from.See DimensionInput

String

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

String

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

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

String

deprecated

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

deprecated

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

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

String

required

The name of the column to filter on.

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.

String

The value to compare the column to.

[FilterInput!]

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

[FilterInput!]

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

DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

CustomMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

String

required

Custom expression for defining the Metric.

CountMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

SumMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to be summed.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

AverageMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to be averaged.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

MinMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to calculate the minimum from.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

MaxMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to calculate the maximum from.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

CountDistinctMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to count distinct values from.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

MetricInput

The ID of a pre-configured Metric.

String

The name of a pre-configured Metric.

CustomMetricQueryInput

An ad hoc Custom Metric.

Show CustomMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

String

required

Custom expression for defining the Metric.

CountMetricQueryInput

An ad hoc Count Metric.

Show CountMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

SumMetricQueryInput

An ad hoc Sum Metric.

Show SumMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to be summed.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

AverageMetricQueryInput

An ad hoc Average Metric.

Show AverageMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to be averaged.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

MinMetricQueryInput

An ad hoc Min Metric.

Show MinMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to calculate the minimum from.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

MaxMetricQueryInput

An ad hoc Max Metric.

Show MaxMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to calculate the maximum from.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

CountDistinctMetricQueryInput

An ad hoc Count Distinct Metric.

Show CountDistinctMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

DimensionInput

required

The column to count distinct values from.

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

CounterInput

The fields for querying a Metric in counter format. A Metric’s counter query returns a single value over a given time range.

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

The ID of a pre-configured Metric.

String

The name of a pre-configured Metric.

CustomMetricQueryInput

An ad hoc Custom Metric.

Show CustomMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

String

required

Custom expression for defining the Metric.

CountMetricQueryInput

An ad hoc Count Metric.

Show CountMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

SumMetricQueryInput

An ad hoc Sum Metric.

Show SumMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to be summed.See DimensionInput

AverageMetricQueryInput

An ad hoc Average Metric.

Show AverageMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to be averaged.See DimensionInput

MinMetricQueryInput

An ad hoc Min Metric.

Show MinMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to calculate the minimum from.See DimensionInput

MaxMetricQueryInput

An ad hoc Max Metric.

Show MaxMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to calculate the maximum from.See DimensionInput

CountDistinctMetricQueryInput

An ad hoc Count Distinct Metric.

Show CountDistinctMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to count distinct values from.See DimensionInput

TimeRangeInput

The time range for calculating the counter.

Show TimeRangeInput

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.

RelativeTimeRange

The relative time period.

Show RelativeTimeRange

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

Int

The number of time units for the LAST_N relative periods.

DateTime

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

DateTime

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

String

The Query Filters to apply before retrieving the counter data, in the form of SQL. If no Query Filters are provided, all data is included.

Show Deprecated Fields

deprecated

The ID of the Metric to query.Required if metricName is not specified.deprecated: Use metric

String

deprecated

The name of the Metric to query.Required if metricId is not specified.deprecated: Use metric

[FilterInput!]

deprecated

The Query Filters to apply before retrieving the counter data. If no Query Filters are provided, all data is included.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.

String

required

The name of the column to filter on.

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.

String

The value to compare the column to.

[FilterInput!]

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

[FilterInput!]

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

TimeSeriesInput

The fields for querying a Metric in time series format. A Metric’s time series query returns the values over a given time range aggregated by a given time granularity; day, month, or year, for example.

MetricInput

The Metric to Query. It can be a pre-created one or it can be inlined here.

Show MetricInput

The ID of a pre-configured Metric.

String

The name of a pre-configured Metric.

CustomMetricQueryInput

An ad hoc Custom Metric.

Show CustomMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

String

required

Custom expression for defining the Metric.

CountMetricQueryInput

An ad hoc Count Metric.

Show CountMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

SumMetricQueryInput

An ad hoc Sum Metric.

Show SumMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to be summed.See DimensionInput

AverageMetricQueryInput

An ad hoc Average Metric.

Show AverageMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to be averaged.See DimensionInput

MinMetricQueryInput

An ad hoc Min Metric.

Show MinMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to calculate the minimum from.See DimensionInput

MaxMetricQueryInput

An ad hoc Max Metric.

Show MaxMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to calculate the maximum from.See DimensionInput

CountDistinctMetricQueryInput

An ad hoc Count Distinct Metric.

Show CountDistinctMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to count distinct values from.See DimensionInput

TimeRangeInput

The time range for calculating the time series.

Show TimeRangeInput

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.

RelativeTimeRange

The relative time period.

Show RelativeTimeRange

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

Int

The number of time units for the LAST_N relative periods.

DateTime

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

DateTime

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

String

TimeSeriesGranularity

required

The time granularity (hour, day, month, etc.) to aggregate the Metric values by.

Show TimeSeriesGranularity

The available time series granularities. Granularities define the unit of time to aggregate the Metric data for a time series query.For example, if the granularity is set to DAY, then the the time series query will return a label and a value for each day.If there are no records for a given time series granularity, Propel will return the label and a value of “0” so that the time series can be properly visualized.

MINUTE: Aggregates values by minute intervals.
FIVE_MINUTES: Aggregates values by 5-minute intervals.
TEN_MINUTES: Aggregates values by 10-minute intervals.
FIFTEEN_MINUTES: Aggregates values by 15-minute intervals.
HOUR: Aggregates values by hourly intervals.
DAY: Aggregates values by daily intervals.
WEEK: Aggregates values by weekly intervals.
MONTH: Aggregates values by monthly intervals.
YEAR: Aggregates values by yearly intervals.

String

The Query Filters to apply before retrieving the time series data, in the form of SQL. If no Query Filters are provided, all data is included.

[String!]

Columns to group by.

Show Deprecated Fields

deprecated

The ID of the Metric to query.Required if metricName is not specified.deprecated: Use metric

String

deprecated

The name of the Metric to query.Required if metricId is not specified.deprecated: Use metric

[FilterInput!]

deprecated

The Query Filters to apply before retrieving the time series data. If no Query Filters are provided, all data is included.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.

String

required

The name of the column to filter on.

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.

String

The value to compare the column to.

[FilterInput!]

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

[FilterInput!]

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

LeaderboardInput

The fields for querying a Metric in leaderboard format. A Metric’s leaderboard query returns an ordered table of Dimension and Metric values over a given time range.

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

The ID of a pre-configured Metric.

String

The name of a pre-configured Metric.

CustomMetricQueryInput

An ad hoc Custom Metric.

Show CustomMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

String

required

Custom expression for defining the Metric.

CountMetricQueryInput

An ad hoc Count Metric.

Show CountMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

SumMetricQueryInput

An ad hoc Sum Metric.

Show SumMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to be summed.See DimensionInput

AverageMetricQueryInput

An ad hoc Average Metric.

Show AverageMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to be averaged.See DimensionInput

MinMetricQueryInput

An ad hoc Min Metric.

Show MinMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to calculate the minimum from.See DimensionInput

MaxMetricQueryInput

An ad hoc Max Metric.

Show MaxMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to calculate the maximum from.See DimensionInput

CountDistinctMetricQueryInput

An ad hoc Count Distinct Metric.

Show CountDistinctMetricQueryInput

DataPoolInput

required

The Data Pool to which this Metric belongs.See DataPoolInput

DimensionInput

required

The column to count distinct values from.See DimensionInput

TimeRangeInput

The time range for calculating the leaderboard.

Show TimeRangeInput

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.

RelativeTimeRange

The relative time period.

Show RelativeTimeRange

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

Int

The number of time units for the LAST_N relative periods.

DateTime

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

DateTime

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

String

[DimensionInput!]

required

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

Show DimensionInput

The fields for creating or modifying a Dimension.

String

required

The name of the column to create the Dimension from.

Sort

The sort order of the rows. 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.

Int

required

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

String

The Query Filters to apply before retrieving the leaderboard data, in the form of SQL. If no Query Filters are provided, all data is included.

Show Deprecated Fields

deprecated

The ID of the Metric to query.Required if metricName is not specified.deprecated: Use metric

String

deprecated

The name of the Metric to query.Required if metricId is not specified.deprecated: Use metric

[FilterInput!]

deprecated

The Query Filters to apply before retrieving the leaderboard data. If no Query Filters are provided, all data is included.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.

String

required

The name of the column to filter on.

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.

String

The value to compare the column to.

[FilterInput!]

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

[FilterInput!]

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

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.

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.

RelativeTimeRange

The relative time period.

Show RelativeTimeRange

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

Int

The number of time units for the LAST_N relative periods.

DateTime

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

DateTime

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

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.

String

required

The name of the column to filter on.

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.

String

The value to compare the column to.

[FilterInput!]

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

[FilterInput!]

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

SqlV1Input

Input to the SqlV1 api.

String

required

The SQL query.

SqlDialectV1

The SQL dialect to use. If not provided, the query is parsed on a best-effort basis.

Show SqlDialectV1

The SQL dialect to use when parsing queries.

POSTGRESQL: Parse as PostgreSQL-compatible SQL.
CLICKHOUSE: Parse as ClickHouse-compatible SQL.

DescribeSqlV1Input

Input for describing SqlV1 inputs.

String

required

The SQL query.

SqlDialectV1

The SQL dialect to use. If not provided, the query is parsed on a best-effort basis.

Show SqlDialectV1

The SQL dialect to use when parsing queries.

POSTGRESQL: Parse as PostgreSQL-compatible SQL.
CLICKHOUSE: Parse as ClickHouse-compatible SQL.

RecordsByUniqueIdInput

The fields for querying records by unique ID.

DataPoolInput

required

The Data Pool to be queried. A Data Pool ID or unique name can be provided.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

[String!]

required

The columns to retrieve.

[String!]

required

The unique IDs of the records to retrieve.

TopValuesInput

The fields for querying the top values in a given column.

DataPoolInput

required

The Data Pool to be queried. A Data Pool ID or unique name can be provided.

Show DataPoolInput

The ID of the Data Pool.

String

The name of the Data Pool.

String

required

The column to fetch the unique values from.

TimeRangeInput

The time range for calculating the top values.

Show TimeRangeInput

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.

RelativeTimeRange

The relative time period.

Show RelativeTimeRange

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

Int

The number of time units for the LAST_N relative periods.

DateTime

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

DateTime

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

String

Int

The maximum number of values to return. It can be a number between 1 and 1,000. If the parameter is omitted, default value 10 is used.

Introduction

API Reference

DimensionInput

DataGridInput

MetricReportInput

MetricReportDimensionInput

MetricReportMetricInput

DataPoolInput

CustomMetricQueryInput

CountMetricQueryInput

SumMetricQueryInput

AverageMetricQueryInput

MinMetricQueryInput

MaxMetricQueryInput

CountDistinctMetricQueryInput

MetricInput

CounterInput

TimeSeriesInput

LeaderboardInput

TimeRangeInput

FilterInput

SqlV1Input

DescribeSqlV1Input

RecordsByUniqueIdInput

TopValuesInput

​DimensionInput

​DataGridInput

​MetricReportInput

​MetricReportDimensionInput

​MetricReportMetricInput

​DataPoolInput

​CustomMetricQueryInput

​CountMetricQueryInput

​SumMetricQueryInput

​AverageMetricQueryInput

​MinMetricQueryInput

​MaxMetricQueryInput

​CountDistinctMetricQueryInput

​MetricInput

​CounterInput

​TimeSeriesInput

​LeaderboardInput

​TimeRangeInput

​FilterInput

​SqlV1Input

​DescribeSqlV1Input

​RecordsByUniqueIdInput

​TopValuesInput

DimensionInput

DataGridInput

MetricReportInput

MetricReportDimensionInput

MetricReportMetricInput

DataPoolInput

CustomMetricQueryInput

CountMetricQueryInput

SumMetricQueryInput

AverageMetricQueryInput

MinMetricQueryInput

MaxMetricQueryInput

CountDistinctMetricQueryInput

MetricInput

CounterInput

TimeSeriesInput

LeaderboardInput

TimeRangeInput

FilterInput

SqlV1Input

DescribeSqlV1Input

RecordsByUniqueIdInput

TopValuesInput