Enums
Enumeration types in the Management API
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.
P1_X_SMALL
: Max records per second: 5,000,000 records per secondP1_SMALL
: Max records per second: 25,000,000 records per secondP1_MEDIUM
: Max records per second: 100,000,000 records per secondP1_LARGE
: Max records per second: 250,000,000 records per secondP1_X_LARGE
: Max records per second: 500,000,000 records per second
ApplicationScope
The API operations an Application is authorized to perform.
ADMIN
: Grant read/write access to Data Sources, Data Pools, Metrics and Policies.APPLICATION_ADMIN
: Grant read/write access to Applications.DATA_POOL_QUERY
: Grant read access to query Data Pools.DATA_POOL_READ
: Grant read access to read Data Pools.DATA_POOL_STATS
: Grant read access to fetch column statistics from Data Pools.ENVIRONMENT_ADMIN
: Grant read/write access to Environments.METRIC_QUERY
: Grant read access to query Metrics.METRIC_STATS
: Grant read access to fetch Dimension statistics from Metrics.METRIC_READ
: Grant read access to Metrics.
This does not allow querying Metrics. For that, see METRIC_QUERY
.
DataSourceCheckStatus
The status of a Data Source Check.
NOT_STARTED
: The Check has not started.SUCCEEDED
: The Check succeeded.FAILED
: The Check failed.
TableIntrospectionStatus
The status of a table introspection.
NOT_STARTED
: The table introspection has not started.STARTED
: The table introspection has started.SUCCEEDED
: The table introspection succeeded.FAILED
: The table introspection failed.
DataSourceType
The types of Data Sources.
WEBHOOK
: Indicates a Webhook Data Source.TWILIO_SEGMENT
: Indicates a Twilio Segment Data Source.S3
: Indicates an Amazon S3 Data Source.Redshift
: Indicates a Redshift Data Source.POSTGRESQL
: Indicates a PostgreSQL Data Source.KAFKA
: Indicates a Kafka Data Source.Http
: Indicates an Http Data Source.CLICKHOUSE
: Indicates a ClickHouse Data Source.AMAZON_DYNAMODB
: Indicates an Amazon DynamoDB Data Source.AMAZON_DATA_FIREHOSE
: Indicates an Amazon Data Firehose Data Source.Snowflake
: Indicates a Snowflake Data Source.INTERNAL
: Indicates an internal Data Source.
DataSourceStatus
The status of a Data Source.
CREATED
: The Data Source has been created, but it is not connected yet.CONNECTING
: Propel is attempting to connect the Data Source.CONNECTED
: The Data Source is connected.BROKEN
: The Data Source failed to connect.DELETING
: Propel is deleting the Data Source.
ColumnType
The Propel data types.
BOOLEAN
: True or false.STRING
: A variable-length string.FLOAT
: A 32-bit signed double-precision floating point number.DOUBLE
: A 64-bit signed double-precision floating point number.INT8
: An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.INT16
: A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.INT32
: A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.INT64
: A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.DATE
: A date without a timestamp. For example, “YYYY-MM-DD”.TIMESTAMP
: A date with a timestamp. For example, “yyy-MM-dd HH:mm:ss”.JSON
: A JavaScript Object Notation (JSON) document.CLICKHOUSE
: A ClickHouse-specific type.
TableEngineType
ClickHouse table engine types.
MERGE_TREE
: The MergeTree table engine.REPLACING_MERGE_TREE
: The ReplacingMergeTree table engine.SUMMING_MERGE_TREE
: The SummingMergeTree table engine.AGGREGATING_MERGE_TREE
: The AggregatingMergeTree table engine.POSTGRESQL
: The PostgreSQL table engine.
DataPoolSetupTaskStatus
The status of a Data Pool Setup Task.
NOT_STARTED
: The Data Pool Setup Task has not been started yet.SUCCEEDED
: The Data Pool Setup Task has completed successfully.FAILED
: The Data Pool Setup Task has failed.
DataPoolStatus
The status of a Data Pool.
CREATED
: The Data Pool has been created and will be set up soon.PENDING
: Propel is attempting to set up the Data Pool.LIVE
: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.SETUP_FAILED
: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.CONNECTING
CONNECTED
BROKEN
PAUSING
PAUSED
DELETING
: Propel is deleting the Data Pool and all of its associated data.
DataPoolSyncInterval
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.
EVERY_1_MINUTE
EVERY_5_MINUTES
EVERY_15_MINUTES
EVERY_30_MINUTES
EVERY_1_HOUR
EVERY_4_HOURS
EVERY_12_HOURS
EVERY_24_HOURS
DataPoolSyncStatus
The Data Pool Sync Status. It indicates whether a Data Pool is syncing data or not.
ENABLED
: Syncing is enabled for the Data Pool.DISABLING
: Propel is disabling syncing for the Data Pool.DISABLED
: Syncing is disabled for the Data Pool.
SyncStatus
The status of a Sync.
SYNCING
: Propel is actively syncing records contained within the Sync.SUCCEEDED
: The Sync succeeded. Propel successfully synced all records contained within the Sync.FAILED
: The Sync failed. Propel failed to sync some or all records contained within the Sync.DELETING
: Propel is deleting the Sync.
SyncsFilter
The filter to apply when listing the Syncs for a Data Pool.
EMPTY
: Returns only Syncs with empty records.NOT_EMPTY
: Returns only Syncs that contain one or more records.ALL
: Returns all Syncs, regardless of whether they contain records or not.
MetricType
The available Metric types.
COUNT
: Counts the number of records that matches the Metric Filters. For time series, it will count the values for each time granularity.SUM
: Sums the values of the specified column for every record that matches the Metric Filters. For time series, it will sum the values for each time granularity.COUNT_DISTINCT
: Counts the number of distinct values in the specified column for every record that matches the Metric Filters. For time series, it will count the distinct values for each time granularity.AVERAGE
: Averages the values of the specified column for every record that matches the Metric Filters. For time series, it will average the values for each time granularity.MIN
: Selects the minimum value of the specified column for every record that matches the Metric Filters. For time series, it will select the minimum value for each time granularity.MAX
: Selects the maximum value of the specified column for every record that matches the Metric Filters. For time series, it will select the maximum value for each time granularity.CUSTOM
: Aggregates values based on the provided custom expression.
Sort
The available sort orders.
ASC
: Sort in ascending order.DESC
: Sort in descending order.
RelativeTimeRange
The Relative time ranges are based on the current date and time.
THIS
- The current unit of time. For example, if today is June 8, 2022, and
THIS_MONTH
is selected, then data for June 2022 would be returned.
PREVIOUS
- The previous unit of time. For example, if today is June 8, 2022, and
PREVIOUS_MONTH
is selected, then data for May 2022 would be returned. It excludes
the current unit of time.
NEXT
- The next unit of time. For example, if today is June 8, 2022, and
NEXT_MONTH
is selected, then data for July 2022 would be returned. It excludes
the current unit of time.
LAST_N
- The last n
units of time, including the current one. For example, if today
is June 8, 2022 and LAST_N_YEARS
with n
= 3 is selected, then data for 2020, 2021, and
2022 will be returned. It will include the current time period.
THIS_HOUR
: Starts at the zeroth minute of the current hour and continues for 60 minutes.TODAY
: Starts at 12:00:00 AM of the current day and continues for 24 hours.THIS_WEEK
: Starts on Monday, 12:00:00 AM of the current week and continues for seven days.THIS_MONTH
: Starts at 12:00:00 AM on the first day of the current month and continues for the duration of the month.THIS_QUARTER
: Starts at 12:00:00 AM on the first day of the current calendar quarter and continues for the duration of the quarter.THIS_YEAR
: Starts on January 1st, 12:00:00 AM of the current year and continues for the duration of the year.PREVIOUS_HOUR
: Starts at the zeroth minute of the previous hour and continues for 60 minutes.YESTERDAY
: Starts at 12:00:00 AM on the day before the today and continues for 24 hours.PREVIOUS_WEEK
: Starts on Monday, 12:00:00 AM, a week before the current week, and continues for seven days.PREVIOUS_MONTH
: Starts at 12:00:00 AM on the first day of the month before the current month and continues for the duration of the month.PREVIOUS_QUARTER
: Starts at 12:00:00 AM on the first day of the calendar quarter before the current quarter and continues for the duration of the quarter.PREVIOUS_YEAR
: Starts on January 1st, 12:00:00 AM, the year before the current year, and continues for the duration of the year.NEXT_HOUR
: Starts at the zeroth minute of the next hour and continues for 60 minutes.TOMORROW
: ” Starts at 12:00:00 AM, the day after the current day, and continues for 24 hours.NEXT_WEEK
: Starts on Monday, 12:00:00 AM, the week after the current week, and continues for the duration of the week.NEXT_MONTH
: Starts at 12:00:00 AM on the first day of the next month and continues for the duration of the month.NEXT_QUARTER
: Starts at 12:00:00 AM on the first day of the next calendar quarter and continues for the duration of the quarter.NEXT_YEAR
: Starts on January 1st, 12:00:00 AM of the next year and continues for the duration of the year.LAST_N_MINUTES
: Starts at the zeroth secondn
- 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 then
- 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 quartern
- 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 yearn
- 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
TimeSeriesGranularity
The available time series granularities. Granularities define the unit of time to aggregate the Metric data for a time series query.
For example, if the granularity is set to DAY
, then the the time series query will return a label and a value for each day.
If there are no records for a given time series granularity, Propel will return the label and a value of “0” so that the time series can be properly visualized.
MINUTE
: Aggregates values by minute intervals.FIVE_MINUTES
: Aggregates values by 5-minute intervals.TEN_MINUTES
: Aggregates values by 10-minute intervals.FIFTEEN_MINUTES
: Aggregates values by 15-minute intervals.HOUR
: Aggregates values by hourly intervals.DAY
: Aggregates values by daily intervals.WEEK
: Aggregates values by weekly intervals.MONTH
: Aggregates values by monthly intervals.YEAR
: Aggregates values by yearly intervals.
FilterOperator
The available Filter operators.
EQUALS
: Selects values that are equal to the specified value.NOT_EQUALS
: Selects values that are not equal to the specified value.GREATER_THAN
: Selects values that are greater than the specified value.GREATER_THAN_OR_EQUAL_TO
: Selects values that are greater or equal to the specified value.LESS_THAN
: Selects values that are less than the specified value.LESS_THAN_OR_EQUAL_TO
: Selects values that are less or equal to the specified value.IS_NULL
: Selects values that are null. This operator does not accept a value.IS_NOT_NULL
: Selects values that are not null. This operator does not accept a value.LIKE
: Selects values that match the specified pattern.NOT_LIKE
: “Selects values that do not match the specified pattern.
QueryStatus
The Query status.
COMPLETED
: The Query was completed succesfully.ERROR
: The Query experienced an error.TIMED_OUT
: The Query timed out.
QueryType
The Query type.
METRIC
: Indicates a Metric Query.STATS
: Indicates a Dimension Stats Query.REPORT
: Indicates a Report Query.RECORDS
: Indicates a Record Table Query.RECORDS_BY_UNIQUE_ID
: Indicates records queried by unique ID.SQL
: Indicates a SQL Query.TOP_VALUES
: Indicates a Top Values Query.
QuerySubtype
The Query subtype.
COUNTER
: Indicates a Metric counter Query.TIME_SERIES
: Indicates a Metric time series Query.LEADERBOARD
: Indicates a Metric leaderboard Query.
BoosterStatus
The Booster status.
CREATED
: The Booster has been created. Propel will start optimizing the Data Pool soon.OPTIMIZING
: Propel is setting up the Booster and optimizing the Data Pool.LIVE
: The Booster is now live and available to speed up Metric queries.FAILED
: Propel failed to setup the Booster. Please write to support. Alternatively, you can delete the Booster and try again.DELETING
: Propel is deleting the Booster and all of its associated data.
PolicyType
The types of Policies that can be applied to a Metric.
ALL_ACCESS
: Grants access to all Metric data.TENANT_ACCESS
: Grants access to a specified tenant’s Metric data.
JobStatus
CREATED
: The Job was created, but is not yet being executed.IN_PROGRESS
: The Job is executing.SUCCEEDED
: The Job succeeded.FAILED
: The Job failed. Check the error message.
PartitionOrder
The available options for partition processing order.
OLDEST_FIRST
: Partitions are processed in ascending order, starting with the oldest.NEWEST_FIRST
: Partitions are processed in descending order, starting with the newest.
SqlDialectV1
The SQL dialect to use when parsing queries.
POSTGRESQL
: Parse as PostgreSQL-compatible SQL.CLICKHOUSE
: Parse as ClickHouse-compatible SQL.