## DimensionInput The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. ## DataGridInput The fields for querying Data Grid records. The Data Pool to be queried. The ID of the Data Pool. The name of the Data Pool. The time range for retrieving the records. 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. 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. The relative time period. 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` The number of time units for the `LAST_N` relative periods. The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool. The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool. 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](https://en.wikipedia.org/wiki/Tz_database). Defaults to "UTC". The columns to retrieve. 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. The sort order of the rows. It can be ascending (`ASC`) or descending (`DESC`) order. Defaults to descending (`DESC`) order when not provided. The available sort orders. * `ASC`: Sort in ascending order. * `DESC`: Sort in descending order. The filters to apply to the records, in the form of SQL. You may only filter on columns included in the `columns` array input. The number of rows to be returned when paging forward. It can be a number between 1 and 1,000. The cursor to use when paging forward. The number of rows to be returned when paging forward. It can be a number between 1 and 1,000. The cursor to use when paging backward. The filters to apply to the records. You may only filter on columns included in the `columns` array input. deprecated: Use `filterSql` instead 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`. The name of the column to filter on. The operation to perform when comparing the column and filter values. The available Filter operators. * `EQUALS`: Selects values that are equal to the specified value. * `NOT_EQUALS`: Selects values that are not equal to the specified value. * `GREATER_THAN`: Selects values that are greater than the specified value. * `GREATER_THAN_OR_EQUAL_TO`: Selects values that are greater or equal to the specified value. * `LESS_THAN`: Selects values that are less than the specified value. * `LESS_THAN_OR_EQUAL_TO`: Selects values that are less or equal to the specified value. * `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. The value to compare the column to. Additional filters to AND with this one. AND takes precedence over OR. 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. The time range for calculating the Metric Report. 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. 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. The relative time period. 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` The number of time units for the `LAST_N` relative periods. The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool. The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool. 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](https://en.wikipedia.org/wiki/Tz_database). Defaults to "UTC". One or many dimensions to group the Metric values by. Typically, dimensions in a report are what you want to compare and rank. The fields for specifying a dimension to include in a Metric Report. The column name of the dimension to include in a Metric Report. This must match the name of a Data Pool column. The name to display in the `headers` array when displaying the report. This defaults to the column name if unspecified. The sort order for the dimension. It can be ascending (`ASC`) or descending (`DESC`) order. Defaults to ascending (`ASC`) order when not provided. The available sort orders. * `ASC`: Sort in ascending order. * `DESC`: Sort in descending order. One or more Metrics to include in the Metric Report. These will be broken down by `dimensions`. The fields for specifying a Metric to include in a Metric Report. 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. The ID of a pre-configured Metric. The name of a pre-configured Metric. An ad hoc Custom Metric. See CustomMetricQueryInput An ad hoc Count Metric. See CountMetricQueryInput An ad hoc Sum Metric. See SumMetricQueryInput An ad hoc Average Metric. See AverageMetricQueryInput An ad hoc Min Metric. See MinMetricQueryInput An ad hoc Max Metric. See MaxMetricQueryInput An ad hoc Count Distinct Metric. See CountDistinctMetricQueryInput The name to display in the `headers` array when displaying the report. This defaults to the Metric's unique name if unspecified. The Query Filters to apply when calculating the Metric, in the form of SQL. The sort order for the Metric. It can be ascending (`ASC`) or descending (`DESC`) order. Defaults to descending (`DESC`) order when not provided. The available sort orders. * `ASC`: Sort in ascending order. * `DESC`: Sort in descending order. The Metric's unique name. If not specified, Propel will lookup the Metric by ID. deprecated: Use `metric` The Metric's ID. If not specified, Propel will lookup the Metric by unique name. deprecated: Use `metric` The Query Filters to apply when calculating the Metric. deprecated: Use `filterSql` instead 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`. The name of the column to filter on. The operation to perform when comparing the column and filter values. See FilterOperator The value to compare the column to. Additional filters to AND with this one. AND takes precedence over OR. Additional filters to OR with this one. AND takes precedence over OR. The Query Filters to apply when building the Metric Report, in the form of SQL. These can be used to filter out rows. 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. The number of rows to be returned when paging forward. It can be a number between 1 and 1,000. The cursor to use when paging forward. The number of rows to be returned when paging forward. It can be a number between 1 and 1,000. The cursor to use when paging backward. The Query Filters to apply when building the Metric Report. These can be used to filter out rows. deprecated: Use `filterSql` instead 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`. The name of the column to filter on. The operation to perform when comparing the column and filter values. The available Filter operators. * `EQUALS`: Selects values that are equal to the specified value. * `NOT_EQUALS`: Selects values that are not equal to the specified value. * `GREATER_THAN`: Selects values that are greater than the specified value. * `GREATER_THAN_OR_EQUAL_TO`: Selects values that are greater or equal to the specified value. * `LESS_THAN`: Selects values that are less than the specified value. * `LESS_THAN_OR_EQUAL_TO`: Selects values that are less or equal to the specified value. * `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. The value to compare the column to. Additional filters to AND with this one. AND takes precedence over OR. 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. The column name of the dimension to include in a Metric Report. This must match the name of a Data Pool column. The name to display in the `headers` array when displaying the report. This defaults to the column name if unspecified. The sort order for the dimension. It can be ascending (`ASC`) or descending (`DESC`) order. Defaults to ascending (`ASC`) order when not provided. 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. 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. The ID of a pre-configured Metric. The name of a pre-configured Metric. An ad hoc Custom Metric. The Data Pool to which this Metric belongs. See DataPoolInput Custom expression for defining the Metric. An ad hoc Count Metric. The Data Pool to which this Metric belongs. See DataPoolInput An ad hoc Sum Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to be summed. See DimensionInput An ad hoc Average Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to be averaged. See DimensionInput An ad hoc Min Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to calculate the minimum from. See DimensionInput An ad hoc Max Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to calculate the maximum from. See DimensionInput An ad hoc Count Distinct Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to count distinct values from. See DimensionInput The name to display in the `headers` array when displaying the report. This defaults to the Metric's unique name if unspecified. The Query Filters to apply when calculating the Metric, in the form of SQL. The sort order for the Metric. It can be ascending (`ASC`) or descending (`DESC`) order. Defaults to descending (`DESC`) order when not provided. The available sort orders. * `ASC`: Sort in ascending order. * `DESC`: Sort in descending order. The Metric's unique name. If not specified, Propel will lookup the Metric by ID. deprecated: Use `metric` The Metric's ID. If not specified, Propel will lookup the Metric by unique name. deprecated: Use `metric` The Query Filters to apply when calculating the Metric. deprecated: Use `filterSql` instead 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`. The name of the column to filter on. The operation to perform when comparing the column and filter values. The available Filter operators. * `EQUALS`: Selects values that are equal to the specified value. * `NOT_EQUALS`: Selects values that are not equal to the specified value. * `GREATER_THAN`: Selects values that are greater than the specified value. * `GREATER_THAN_OR_EQUAL_TO`: Selects values that are greater or equal to the specified value. * `LESS_THAN`: Selects values that are less than the specified value. * `LESS_THAN_OR_EQUAL_TO`: Selects values that are less or equal to the specified value. * `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. The value to compare the column to. Additional filters to AND with this one. AND takes precedence over OR. Additional filters to OR with this one. AND takes precedence over OR. ## DataPoolInput The ID of the Data Pool. The name of the Data Pool. ## CustomMetricQueryInput The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. Custom expression for defining the Metric. ## CountMetricQueryInput The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. ## SumMetricQueryInput The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to be summed. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. ## AverageMetricQueryInput The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to be averaged. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. ## MinMetricQueryInput The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to calculate the minimum from. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. ## MaxMetricQueryInput The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to calculate the maximum from. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. ## CountDistinctMetricQueryInput The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to count distinct values from. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. ## MetricInput The ID of a pre-configured Metric. The name of a pre-configured Metric. An ad hoc Custom Metric. The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. Custom expression for defining the Metric. An ad hoc Count Metric. The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. An ad hoc Sum Metric. The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to be summed. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. An ad hoc Average Metric. The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to be averaged. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. An ad hoc Min Metric. The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to calculate the minimum from. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. An ad hoc Max Metric. The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to calculate the maximum from. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. An ad hoc Count Distinct Metric. The Data Pool to which this Metric belongs. The ID of the Data Pool. The name of the Data Pool. The column to count distinct values from. The fields for creating or modifying a Dimension. 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. 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. The ID of a pre-configured Metric. The name of a pre-configured Metric. An ad hoc Custom Metric. The Data Pool to which this Metric belongs. See DataPoolInput Custom expression for defining the Metric. An ad hoc Count Metric. The Data Pool to which this Metric belongs. See DataPoolInput An ad hoc Sum Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to be summed. See DimensionInput An ad hoc Average Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to be averaged. See DimensionInput An ad hoc Min Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to calculate the minimum from. See DimensionInput An ad hoc Max Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to calculate the maximum from. See DimensionInput An ad hoc Count Distinct Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to count distinct values from. See DimensionInput The time range for calculating the counter. 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. 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. The relative time period. 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` The number of time units for the `LAST_N` relative periods. The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool. The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool. 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](https://en.wikipedia.org/wiki/Tz_database). Defaults to "UTC". 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. The ID of the Metric to query. Required if `metricName` is not specified. deprecated: Use `metric` The name of the Metric to query. Required if `metricId` is not specified. deprecated: Use `metric` The Query Filters to apply before retrieving the counter data. If no Query Filters are provided, all data is included. deprecated: Use `filterSql` instead 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`. The name of the column to filter on. The operation to perform when comparing the column and filter values. The available Filter operators. * `EQUALS`: Selects values that are equal to the specified value. * `NOT_EQUALS`: Selects values that are not equal to the specified value. * `GREATER_THAN`: Selects values that are greater than the specified value. * `GREATER_THAN_OR_EQUAL_TO`: Selects values that are greater or equal to the specified value. * `LESS_THAN`: Selects values that are less than the specified value. * `LESS_THAN_OR_EQUAL_TO`: Selects values that are less or equal to the specified value. * `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. The value to compare the column to. Additional filters to AND with this one. AND takes precedence over OR. 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. The Metric to Query. It can be a pre-created one or it can be inlined here. The ID of a pre-configured Metric. The name of a pre-configured Metric. An ad hoc Custom Metric. The Data Pool to which this Metric belongs. See DataPoolInput Custom expression for defining the Metric. An ad hoc Count Metric. The Data Pool to which this Metric belongs. See DataPoolInput An ad hoc Sum Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to be summed. See DimensionInput An ad hoc Average Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to be averaged. See DimensionInput An ad hoc Min Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to calculate the minimum from. See DimensionInput An ad hoc Max Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to calculate the maximum from. See DimensionInput An ad hoc Count Distinct Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to count distinct values from. See DimensionInput The time range for calculating the time series. 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. 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. The relative time period. 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` The number of time units for the `LAST_N` relative periods. The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool. The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool. 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](https://en.wikipedia.org/wiki/Tz_database). Defaults to "UTC". The time granularity (hour, day, month, etc.) to aggregate the Metric values by. 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. 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. Columns to group by. The ID of the Metric to query. Required if `metricName` is not specified. deprecated: Use `metric` The name of the Metric to query. Required if `metricId` is not specified. deprecated: Use `metric` 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 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`. The name of the column to filter on. The operation to perform when comparing the column and filter values. The available Filter operators. * `EQUALS`: Selects values that are equal to the specified value. * `NOT_EQUALS`: Selects values that are not equal to the specified value. * `GREATER_THAN`: Selects values that are greater than the specified value. * `GREATER_THAN_OR_EQUAL_TO`: Selects values that are greater or equal to the specified value. * `LESS_THAN`: Selects values that are less than the specified value. * `LESS_THAN_OR_EQUAL_TO`: Selects values that are less or equal to the specified value. * `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. The value to compare the column to. Additional filters to AND with this one. AND takes precedence over OR. 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. 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. The ID of a pre-configured Metric. The name of a pre-configured Metric. An ad hoc Custom Metric. The Data Pool to which this Metric belongs. See DataPoolInput Custom expression for defining the Metric. An ad hoc Count Metric. The Data Pool to which this Metric belongs. See DataPoolInput An ad hoc Sum Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to be summed. See DimensionInput An ad hoc Average Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to be averaged. See DimensionInput An ad hoc Min Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to calculate the minimum from. See DimensionInput An ad hoc Max Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to calculate the maximum from. See DimensionInput An ad hoc Count Distinct Metric. The Data Pool to which this Metric belongs. See DataPoolInput The column to count distinct values from. See DimensionInput The time range for calculating the leaderboard. 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. 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. The relative time period. 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` The number of time units for the `LAST_N` relative periods. The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool. The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool. 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](https://en.wikipedia.org/wiki/Tz_database). Defaults to "UTC". One or many Dimensions to group the Metric values by. Typically, Dimensions in a leaderboard are what you want to compare and rank. The fields for creating or modifying a Dimension. The name of the column to create the Dimension from. The sort order of the rows. It can be ascending (`ASC`) or descending (`DESC`) order. Defaults to descending (`DESC`) order when not provided. The available sort orders. * `ASC`: Sort in ascending order. * `DESC`: Sort in descending order. The number of rows to be returned. It can be a number between 1 and 1,000. 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. The ID of the Metric to query. Required if `metricName` is not specified. deprecated: Use `metric` The name of the Metric to query. Required if `metricId` is not specified. deprecated: Use `metric` The Query Filters to apply before retrieving the leaderboard data. If no Query Filters are provided, all data is included. deprecated: Use `filterSql` instead 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`. The name of the column to filter on. The operation to perform when comparing the column and filter values. The available Filter operators. * `EQUALS`: Selects values that are equal to the specified value. * `NOT_EQUALS`: Selects values that are not equal to the specified value. * `GREATER_THAN`: Selects values that are greater than the specified value. * `GREATER_THAN_OR_EQUAL_TO`: Selects values that are greater or equal to the specified value. * `LESS_THAN`: Selects values that are less than the specified value. * `LESS_THAN_OR_EQUAL_TO`: Selects values that are less or equal to the specified value. * `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. The value to compare the column to. Additional filters to AND with this one. AND takes precedence over OR. 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. 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. The relative time period. 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` The number of time units for the `LAST_N` relative periods. The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool. 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`. The name of the column to filter on. The operation to perform when comparing the column and filter values. The available Filter operators. * `EQUALS`: Selects values that are equal to the specified value. * `NOT_EQUALS`: Selects values that are not equal to the specified value. * `GREATER_THAN`: Selects values that are greater than the specified value. * `GREATER_THAN_OR_EQUAL_TO`: Selects values that are greater or equal to the specified value. * `LESS_THAN`: Selects values that are less than the specified value. * `LESS_THAN_OR_EQUAL_TO`: Selects values that are less or equal to the specified value. * `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. The value to compare the column to. Additional filters to AND with this one. AND takes precedence over OR. Additional filters to OR with this one. AND takes precedence over OR. ## SqlV1Input Input to the SqlV1 api. The SQL query. The SQL dialect to use. If not provided, the query is parsed on a best-effort basis. 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. The SQL query. The SQL dialect to use. If not provided, the query is parsed on a best-effort basis. 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. The Data Pool to be queried. A Data Pool ID or unique name can be provided. The ID of the Data Pool. The name of the Data Pool. The columns to retrieve. The unique IDs of the records to retrieve. ## TopValuesInput The fields for querying the top values in a given column. The Data Pool to be queried. A Data Pool ID or unique name can be provided. The ID of the Data Pool. The name of the Data Pool. The column to fetch the unique values from. The time range for calculating the top values. 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. 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. The relative time period. 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` The number of time units for the `LAST_N` relative periods. The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool. The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool. 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](https://en.wikipedia.org/wiki/Tz_database). Defaults to "UTC". 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.