The Application’s Propeller. If no Propeller is provided, Propel will set the Propeller to P1_X_SMALL.
Show Propeller
A Propeller determines your Application’s query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.
The Application’s API authorization scopes. If specified, at least one scope must be provided; otherwise, all scopes will be granted to the Application by default.
Show ApplicationScope
The API operations an Application is authorized to perform.
A Propeller determines your Application’s query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.
The Snowflake account. Only include the part before the “snowflakecomputing.com” part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like “znXXXXX.us-east-2.aws”. For Google Cloud-based accounts, this looks like “ffXXXXX.us-central1.gcp”.
The Snowflake account. Only include the part before the “snowflakecomputing.com” part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like “znXXXXX.us-east-2.aws”. For Google Cloud-based accounts, this looks like “ffXXXXX.us-central1.gcp”. If not provided this property will not be modified.
The Snowflake warehouse name. It should be “PROPELLING” if you used the default name in the setup script. If not provided this property will not be modified.
The Snowflake account. Only include the part before the “snowflakecomputing.com” part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like “znXXXXX.us-east-2.aws”. For Google Cloud-based accounts, this looks like “ffXXXXX.us-central1.gcp”.
The Snowflake account. Only include the part before the “snowflakecomputing.com” part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like “znXXXXX.us-east-2.aws”. For Google Cloud-based accounts, this looks like “ffXXXXX.us-central1.gcp”. If not provided this property will not be modified.
The Snowflake warehouse name. It should be “PROPELLING” if you used the default name in the setup script. If not provided this property will not be modified.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
By default, a destination Data Pool with default settings will be created for the Materialized View;
however, you can customize the destination Data Pool (or point to an existing Data Pool), by setting
this field. Use this to target an existing Data Pool or the engine settings of a new Data Pool.
Show CreateMaterializedViewDestinationInput
The fields for targeting an existing Data Pool or a new Data Pool.
If specified, the Materialized View will target an existing Data Pool.
Ensure the Data Pool’s schema is compatible with your Materialized View’s SQL statement.
Enables or disables access control for the Data Pool.If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
Policies in order to query the Data Pool and its Metrics.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsInput
Optionally specify the Data Pool’s unique ID. This will influence the Data Pool’s engine settings.deprecated: Will be removed; use table settings to define the primary key.See UniqueIdInput
By default, a Materialized View only applies to records added after its creation. This option allows
to backfill all the data that was present before the Materialized View creation.
If specified, the Materialized View will target an existing Data Pool.
Ensure the Data Pool’s schema is compatible with your Materialized View’s SQL statement.
Optionally specify the Data Pool’s primary timestamp. This will influence the Data Pool’s engine settings.
Show TimestampInput
The fields to specify the Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.
Enables or disables access control for the Data Pool.If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
Policies in order to query the Data Pool and its Metrics.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.See TableEngineInput
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
Optionally specify the Data Pool’s unique ID. This will influence the Data Pool’s engine settings.deprecated: Will be removed; use table settings to define the primary key.
Show UniqueIdInput
The fields to specify the Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.
Optionally specify the Data Pool’s primary timestamp. This will influence the Data Pool’s engine settings.
Show TimestampInput
The fields to specify the Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.
Enables or disables access control for the Data Pool.If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
Policies in order to query the Data Pool and its Metrics.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
Optionally specify the Data Pool’s unique ID. This will influence the Data Pool’s engine settings.deprecated: Will be removed; use table settings to define the primary key.
Show UniqueIdInput
The fields to specify the Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.
The fields to specify the Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.
The fields to specify the Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.
The table’s primary timestamp column.Propel uses the primary timestamp to order and partition your data in Data Pools. It’s part of what makes Propel
fast for larger data sets. It will also serve as the time dimension for your Metrics.If you do not provide a primary timestamp column, you will need to supply an alternate timestamp when querying your
Data Pool or its Metrics using the TimeRangeInput.
Show TimestampInput
The fields to specify the Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.
The available Data Pool sync intervals. Specify unit of time between attempts to sync data from your data warehouse.Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.
Enables or disables access control for the Data Pool.If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
Policies in order to query the Data Pool and its Metrics.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The Data Pool’s optional tenant ID column. The tenant ID column is used to control access to your data with access policies.deprecated: Will be removed; use Data Pool Access Policies instead
Show TenantInput
The fields to specify the Data Pool’s tenant ID column. The tenant ID column is used to control access to your data with access policies.
The Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.deprecated: Will be removed; use table settings to define the primary key.
Show UniqueIdInput
The fields to specify the Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.
The available Data Pool sync intervals. Specify unit of time between attempts to sync data from your data warehouse.Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.
The table’s primary timestamp column.Propel uses the primary timestamp to order and partition your data in Data Pools. It’s part of what makes Propel
fast for larger data sets. It will also serve as the time dimension for your Metrics.If you do not provide a primary timestamp column, you will need to supply an alternate timestamp when querying your
Data Pool or its Metrics using the TimeRangeInput.
Show TimestampInput
The fields to specify the Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.
Enables or disables access control for the Data Pool.If the Data Pool has access control enabled, Applications must be assigned Data Pool Access
Policies in order to query the Data Pool and its Metrics.
The available Data Pool sync intervals. Specify unit of time between attempts to sync data from your data warehouse.Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.
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 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.
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”.
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 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 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.
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”.
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 Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be 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"
The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be 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"
The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be 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"
The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be 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"
The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be 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"
The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be 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"
The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.
The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be 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"
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 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.
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”.
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"
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 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 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.
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”.
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.
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"
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 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 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.
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”.
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"
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 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.
Row-level filters that the Access Policy applies before executing queries. If not provided this property will not be modified.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"
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 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.
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”.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose issues requests to its custom HTTP endpoint.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp value, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose issues requests to its custom HTTP endpoint.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp value, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.See TableEngineInput
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose issues requests to its custom HTTP endpoint. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose issues requests to its custom HTTP endpoint. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose transmits records from your DynamoDB table to its
custom HTTP endpoint.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp value, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose transmits records from your DynamoDB table to its
custom HTTP endpoint.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp value, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.See TableEngineInput
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose transmits records from your DynamoDB table to its
custom HTTP endpoint. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose transmits records from your DynamoDB table to its
custom HTTP endpoint. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
The HTTP Basic authentication settings for uploading new data.If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
The HTTP Basic authentication settings for uploading new data.If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
The HTTP Basic authentication settings for uploading new data.If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.
The HTTP Basic authentication settings for uploading new data.If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.
The connection settings for an Amazon S3 Data Source. These include the Amazon S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.
The Amazon S3 Data Source’s new connection settings. If not provided this property will not be modified.
Show PartialS3ConnectionSettingsInput
The connection settings for an Amazon S3 Data Source. These include the Amazon S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.
The connection settings for an Amazon S3 Data Source. These include the Amazon S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.
The connection settings for an Amazon S3 Data Source. These include the Amazon S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
The HTTP basic authentication settings for the Twilio Segment Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.See TableEngineInput
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The HTTP basic authentication settings for the Twilio Segment Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.
The HTTP basic authentication settings for the Twilio Segment Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
The HTTP basic authentication settings for the Twilio Segment Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.See TableEngineInput
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The unique ID column, if any. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated.
The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.
The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.
Show HttpBasicAuthInput
The fields for specifying an HTTP Data Source’s Basic authentication settings.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.
Show TableSettingsInput
A Data Pool’s table settings.These describe how the Data Pool’s table is created in ClickHouse.
The ClickHouse table engine for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PARTITION BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The PRIMARY KEY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The ORDER BY clause for the Data Pool’s table.This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.
The unique ID column, if any. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated.
