On this page
- application
- applicationByName
- applications
- dataSource
- dataSourceByName
- dataSources
- dataPool
- dataPoolByName
- dataPools
- environment
- materializedViews
- dataPoolAccessPolicy
- metric
- metricByName
- metrics
- booster
- policy
- sync
- table
- metricReport
- sqlV1
- describeSqlV1
- dataGrid
- recordsByUniqueId
- topValues
- counter
- counters
- timeSeries
- leaderboard
- deletionJob
- addColumnToDataPoolJob
- addColumnToDataPoolJobByStatus
- updateDataPoolRecordsJob
- updateDataPoolRecordsJobByStatus
- materializedView
- materializedViewByName
API Reference
Queries
Available queries in the Management API
application
Returns the Application specified by the given ID.
Arguments
Returns
Nullable
Application
Show Application
Show Application
The Application object.Propel Applications represent the web or mobile app you are building. They provide the API credentials that allow your client- or server-side app to access the Propel API. The Application’s Propeller determines the speed and cost of your Metric Queries.
The Application’s unique identifier.
The Application’s unique name.
The Application’s description.
The Application’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Application’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Application’s creation date and time in UTC.
The Application’s last modification date and time in UTC.
The Application’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Application’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Application’s OAuth 2.0 client identifier.
The Application’s OAuth 2.0 client secret.
The Application’s Propeller.
Show Propeller
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.
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
The Application’s OAuth 2.0 scopes.
Show ApplicationScope
Show 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.
METRIC_QUERY.applicationByName
Returns the Application with the given unique name.
Arguments
Returns
Nullable
Application
Show Application
Show Application
The Application object.Propel Applications represent the web or mobile app you are building. They provide the API credentials that allow your client- or server-side app to access the Propel API. The Application’s Propeller determines the speed and cost of your Metric Queries.
The Application’s unique identifier.
The Application’s unique name.
The Application’s description.
The Application’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Application’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Application’s creation date and time in UTC.
The Application’s last modification date and time in UTC.
The Application’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Application’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Application’s OAuth 2.0 client identifier.
The Application’s OAuth 2.0 client secret.
The Application’s Propeller.
Show Propeller
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.
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
The Application’s OAuth 2.0 scopes.
Show ApplicationScope
Show 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.
METRIC_QUERY.applications
Returns the Applications within the Environment.The
applications query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
Returns
Nullable
ApplicationConnection
Show ApplicationConnection
Show ApplicationConnection
The Application connection object.Learn more about pagination in GraphQL.
The Application connection’s edges.
Show ApplicationEdge
Show ApplicationEdge
The Application edge object.Learn more about pagination in GraphQL.
The edge’s cursor.
The edge’s node.See Application
The Application connection’s nodes.
Show Application
Show Application
The Application object.Propel Applications represent the web or mobile app you are building. They provide the API credentials that allow your client- or server-side app to access the Propel API. The Application’s Propeller determines the speed and cost of your Metric Queries.
The Application’s unique identifier.
The Application’s unique name.
The Application’s description.
The Application’s Environment.See Environment
The Application’s creation date and time in UTC.
The Application’s last modification date and time in UTC.
The Application’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Application’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Application’s OAuth 2.0 client identifier.
The Application’s OAuth 2.0 client secret.
The Application’s OAuth 2.0 scopes.See ApplicationScope
The Application connection’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
dataSource
Returns the Data Source specified by the given ID.
Copy
query {
dataSource(id: "DSOXXXXX") {
id
uniqueName
type
tables (first: 100){
nodes {
id
name
columns (first: 100) {
nodes {
name
type
isNullable
supportedDataPoolColumnTypes
}
}
}
}
}
}
Arguments
Returns
Nullable
DataSource
Show DataSource
Show DataSource
The Data Source object.A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.
The Data Source’s unique identifier.
The Data Source’s unique name.
The Data Source’s description.
The Data Source’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Data Source’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Data Source’s creation date and time in UTC.
The Data Source’s last modification date and time in UTC.
The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Source’s type.
Show DataSourceType
Show 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.
The Data Source’s status.
Show DataSourceStatus
Show 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.
The Data Source’s connection settings.
Show ConnectionSettings
Show ConnectionSettings
ConnectionSettings
SnowflakeConnectionSettings | InternalConnectionSettings | AmazonDataFirehoseConnectionSettings | AmazonDynamoDBConnectionSettings | ClickHouseConnectionSettings | HttpConnectionSettings | KafkaConnectionSettings | PostgreSqlConnectionSettings | S3ConnectionSettings | TwilioSegmentConnectionSettings | WebhookConnectionSettings
See SnowflakeConnectionSettingsSee InternalConnectionSettingsSee AmazonDataFirehoseConnectionSettingsSee AmazonDynamoDBConnectionSettingsSee ClickHouseConnectionSettingsSee HttpConnectionSettingsSee KafkaConnectionSettingsSee PostgreSqlConnectionSettingsSee S3ConnectionSettingsSee TwilioSegmentConnectionSettingsSee WebhookConnectionSettings
A list of checks performed on the Data Source during its most recent connection attempt.
Show DataSourceCheck
Show DataSourceCheck
The Data Source Check object.Data Source Checks are executed when setting up your Data Source. They check that Propel will be able to receive data and setup Data Pools.The exact Checks to perform vary by Data Source. For example, Snowflake-backed Data Sources will have their own specific Checks.
The name of the Data Source Check to be performed.
A description of the Data Source Check to be performed.
The status of the Data Source Check (all checks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).See DataSourceCheckStatus
If the Data Source Check failed, this field includes a descriptive error message.See Error
The time at which the Data Source Check was performed.
If you list Data Pools via the See DataPoolConnection
dataPools field on a Data Source, you will get Data Pools for the Data Source.The dataPools field uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
dataSourceByName
Returns the Data Source specified by the given unique name.
Arguments
Returns
Nullable
DataSource
Show DataSource
Show DataSource
The Data Source object.A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.
The Data Source’s unique identifier.
The Data Source’s unique name.
The Data Source’s description.
The Data Source’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Data Source’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Data Source’s creation date and time in UTC.
The Data Source’s last modification date and time in UTC.
The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Source’s type.
Show DataSourceType
Show 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.
The Data Source’s status.
Show DataSourceStatus
Show 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.
The Data Source’s connection settings.
Show ConnectionSettings
Show ConnectionSettings
ConnectionSettings
SnowflakeConnectionSettings | InternalConnectionSettings | AmazonDataFirehoseConnectionSettings | AmazonDynamoDBConnectionSettings | ClickHouseConnectionSettings | HttpConnectionSettings | KafkaConnectionSettings | PostgreSqlConnectionSettings | S3ConnectionSettings | TwilioSegmentConnectionSettings | WebhookConnectionSettings
See SnowflakeConnectionSettingsSee InternalConnectionSettingsSee AmazonDataFirehoseConnectionSettingsSee AmazonDynamoDBConnectionSettingsSee ClickHouseConnectionSettingsSee HttpConnectionSettingsSee KafkaConnectionSettingsSee PostgreSqlConnectionSettingsSee S3ConnectionSettingsSee TwilioSegmentConnectionSettingsSee WebhookConnectionSettings
A list of checks performed on the Data Source during its most recent connection attempt.
Show DataSourceCheck
Show DataSourceCheck
The Data Source Check object.Data Source Checks are executed when setting up your Data Source. They check that Propel will be able to receive data and setup Data Pools.The exact Checks to perform vary by Data Source. For example, Snowflake-backed Data Sources will have their own specific Checks.
The name of the Data Source Check to be performed.
A description of the Data Source Check to be performed.
The status of the Data Source Check (all checks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).See DataSourceCheckStatus
If the Data Source Check failed, this field includes a descriptive error message.See Error
The time at which the Data Source Check was performed.
If you list Data Pools via the See DataPoolConnection
dataPools field on a Data Source, you will get Data Pools for the Data Source.The dataPools field uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
dataSources
Returns the Data Sources within the Environment.A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.The
dataSources query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
Returns
Nullable
DataSourceConnection
Show DataSourceConnection
Show DataSourceConnection
The Data Source connection object.Learn more about pagination in GraphQL.
The Data Source connection’s edges.
Show DataSourceEdge
Show DataSourceEdge
The Data Source edge object.Learn more about pagination in GraphQL.
The edge’s cursor.
The edge’s node.See DataSource
The Data Source connection’s nodes.
Show DataSource
Show DataSource
The Data Source object.A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.
The Data Source’s unique identifier.
The Data Source’s unique name.
The Data Source’s description.
The Data Source’s Environment.See Environment
The Data Source’s creation date and time in UTC.
The Data Source’s last modification date and time in UTC.
The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Source’s type.See DataSourceType
The Data Source’s status.See DataSourceStatus
The Data Source’s connection settings.See ConnectionSettings
A list of checks performed on the Data Source during its most recent connection attempt.See DataSourceCheck
If you list Data Pools via the See DataPoolConnection
dataPools field on a Data Source, you will get Data Pools for the Data Source.The dataPools field uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
The Data Source connection’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
dataPool
Returns the Data Pool specified by the given ID.A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries.
Arguments
Returns
Nullable
DataPool
Show DataPool
Show DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cache
The Data Pool’s unique identifier.
The Data Pool’s unique name.
The Data Pool’s description.
The Data Pool’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Data Pool’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Data Pool’s creation date and time in UTC.
The Data Pool’s last modification date and time in UTC.
The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Pool’s Data Source.
See DataSource
The Data Pool’s status.
Show DataPoolStatus
Show 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.CONNECTINGCONNECTEDBROKENPAUSINGPAUSEDDELETING: Propel is deleting the Data Pool and all of its associated data.
The Data Pool’s data retention in days (not yet supported).
The name of the Data Pool’s table.
The Data Pool’s primary timestamp column, if any.
Show Timestamp
Show Timestamp
A 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 name of the column that represents the primary timestamp.
The primary timestamp column’s type.
The number of records in the Data Pool.
The amount of storage in terabytes used by the Data Pool.
The Data Pool’s columns.
Arguments
Show DataPoolColumnConnection
Show DataPoolColumnConnection
The Data Pool column connection object.Learn more about pagination in GraphQL.
The Data Pool column connection’s edges.See DataPoolColumnEdge
The Data Pool column connection’s nodes.See DataPoolColumn
The list of measures (numeric columns) in the Data Pool.
Arguments
Show DataPoolColumnConnection
Show DataPoolColumnConnection
The Data Pool column connection object.Learn more about pagination in GraphQL.
The Data Pool column connection’s edges.See DataPoolColumnEdge
The Data Pool column connection’s nodes.See DataPoolColumn
A list of setup tasks performed on the Data Pool during its most recent setup attempt.
Show DataPoolSetupTask
Show DataPoolSetupTask
The Data Pool Setup Task object.Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.
The name of the Data Pool Setup Task to be performed.
A description of the Data Pool Setup Task to be performed.
The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).See DataPoolSetupTaskStatus
If the Data Pool Setup Task failed, this field includes a descriptive error message.See Error
The time at which the Data Pool Setup Task was completed.
Settings related to Data Pool syncing.
Show DataPoolSyncing
Show DataPoolSyncing
Settings related to Data Pool syncing.
Indicates whether syncing is enabled or disabled.See DataPoolSyncStatus
The syncing interval.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.See DataPoolSyncIntervalThe date and time of the most recent Sync in UTC.
The list of Syncs of the Data Pool.
See SyncConnection
Arguments
Show SyncsFilter
Show 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.
Whether the Data Pool has access control enabled or not.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.
Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.
Arguments
Show ValidateExpressionResult
Show ValidateExpressionResult
Response returned by the validateExpression query for validating expressions in Custom Metrics.Returns whether the expression is valid or not with a reason explaining why.
True if the expression is valid, false otherwise.
The reason for why the expression is not valid in case it isn’t, null otherwise.
The Data Pool’s table settings.
Show TableSettings
Show TableSettings
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.See TableEngine
The PARTITION BY clause for the Data Pool’s table.
The PRIMARY KEY clause for the Data Pool’s table.
The ORDER BY clause for the Data Pool’s table.
The TTL clause for the Data Pool’s table.
The Data Pool’s columns that participate in its PARTITION BY clause.
Show DataPoolColumn
Show DataPoolColumn
The name of the Data Source column that this Data Pool column derives from.
The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.See ColumnType
The ClickHouse type. This is the exact representation of the type in ClickHouse.
Whether the column is nullable, meaning whether it accepts a null value.
Show Deprecated Fields
Show Deprecated Fields
The name of the Data Source column that this Data Pool column derives from.deprecated: Start using
columnName insteadThe Data Pool’s columns that participate in its PRIMARY KEY clause.
Show DataPoolColumn
Show DataPoolColumn
The name of the Data Source column that this Data Pool column derives from.
The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.See ColumnType
The ClickHouse type. This is the exact representation of the type in ClickHouse.
Whether the column is nullable, meaning whether it accepts a null value.
Show Deprecated Fields
Show Deprecated Fields
The name of the Data Source column that this Data Pool column derives from.deprecated: Start using
columnName insteadThe Data Pool’s columns that participate in its ORDER BY clause.
Show DataPoolColumn
Show DataPoolColumn
The name of the Data Source column that this Data Pool column derives from.
The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.See ColumnType
The ClickHouse type. This is the exact representation of the type in ClickHouse.
Whether the column is nullable, meaning whether it accepts a null value.
Show Deprecated Fields
Show Deprecated Fields
The name of the Data Source column that this Data Pool column derives from.deprecated: Start using
columnName insteadShow Deprecated Fields
Show Deprecated Fields
The Data Pool’s tenant ID, if configured.deprecated: Will be removed; use Data Pool Access Policies instead
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 UniqueId
Show UniqueId
A 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 name of the column that represents the unique ID.
dataPoolByName
Returns the Data Pool specified by the given unique name.A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries.
Arguments
Returns
Nullable
DataPool
Show DataPool
Show DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cache
The Data Pool’s unique identifier.
The Data Pool’s unique name.
The Data Pool’s description.
The Data Pool’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Data Pool’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Data Pool’s creation date and time in UTC.
The Data Pool’s last modification date and time in UTC.
The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Pool’s Data Source.
See DataSource
The Data Pool’s status.
Show DataPoolStatus
Show 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.CONNECTINGCONNECTEDBROKENPAUSINGPAUSEDDELETING: Propel is deleting the Data Pool and all of its associated data.
The Data Pool’s data retention in days (not yet supported).
The name of the Data Pool’s table.
The Data Pool’s primary timestamp column, if any.
Show Timestamp
Show Timestamp
A 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 name of the column that represents the primary timestamp.
The primary timestamp column’s type.
The number of records in the Data Pool.
The amount of storage in terabytes used by the Data Pool.
The Data Pool’s columns.
Arguments
Show DataPoolColumnConnection
Show DataPoolColumnConnection
The Data Pool column connection object.Learn more about pagination in GraphQL.
The Data Pool column connection’s edges.See DataPoolColumnEdge
The Data Pool column connection’s nodes.See DataPoolColumn
The list of measures (numeric columns) in the Data Pool.
Arguments
Show DataPoolColumnConnection
Show DataPoolColumnConnection
The Data Pool column connection object.Learn more about pagination in GraphQL.
The Data Pool column connection’s edges.See DataPoolColumnEdge
The Data Pool column connection’s nodes.See DataPoolColumn
A list of setup tasks performed on the Data Pool during its most recent setup attempt.
Show DataPoolSetupTask
Show DataPoolSetupTask
The Data Pool Setup Task object.Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.
The name of the Data Pool Setup Task to be performed.
A description of the Data Pool Setup Task to be performed.
The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).See DataPoolSetupTaskStatus
If the Data Pool Setup Task failed, this field includes a descriptive error message.See Error
The time at which the Data Pool Setup Task was completed.
Settings related to Data Pool syncing.
Show DataPoolSyncing
Show DataPoolSyncing
Settings related to Data Pool syncing.
Indicates whether syncing is enabled or disabled.See DataPoolSyncStatus
The syncing interval.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.See DataPoolSyncIntervalThe date and time of the most recent Sync in UTC.
The list of Syncs of the Data Pool.
See SyncConnection
Arguments
Show SyncsFilter
Show 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.
Whether the Data Pool has access control enabled or not.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.
Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.
Arguments
Show ValidateExpressionResult
Show ValidateExpressionResult
Response returned by the validateExpression query for validating expressions in Custom Metrics.Returns whether the expression is valid or not with a reason explaining why.
True if the expression is valid, false otherwise.
The reason for why the expression is not valid in case it isn’t, null otherwise.
The Data Pool’s table settings.
Show TableSettings
Show TableSettings
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.See TableEngine
The PARTITION BY clause for the Data Pool’s table.
The PRIMARY KEY clause for the Data Pool’s table.
The ORDER BY clause for the Data Pool’s table.
The TTL clause for the Data Pool’s table.
The Data Pool’s columns that participate in its PARTITION BY clause.
Show DataPoolColumn
Show DataPoolColumn
The name of the Data Source column that this Data Pool column derives from.
The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.See ColumnType
The ClickHouse type. This is the exact representation of the type in ClickHouse.
Whether the column is nullable, meaning whether it accepts a null value.
Show Deprecated Fields
Show Deprecated Fields
The name of the Data Source column that this Data Pool column derives from.deprecated: Start using
columnName insteadThe Data Pool’s columns that participate in its PRIMARY KEY clause.
Show DataPoolColumn
Show DataPoolColumn
The name of the Data Source column that this Data Pool column derives from.
The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.See ColumnType
The ClickHouse type. This is the exact representation of the type in ClickHouse.
Whether the column is nullable, meaning whether it accepts a null value.
Show Deprecated Fields
Show Deprecated Fields
The name of the Data Source column that this Data Pool column derives from.deprecated: Start using
columnName insteadThe Data Pool’s columns that participate in its ORDER BY clause.
Show DataPoolColumn
Show DataPoolColumn
The name of the Data Source column that this Data Pool column derives from.
The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.See ColumnType
The ClickHouse type. This is the exact representation of the type in ClickHouse.
Whether the column is nullable, meaning whether it accepts a null value.
Show Deprecated Fields
Show Deprecated Fields
The name of the Data Source column that this Data Pool column derives from.deprecated: Start using
columnName insteadShow Deprecated Fields
Show Deprecated Fields
The Data Pool’s tenant ID, if configured.deprecated: Will be removed; use Data Pool Access Policies instead
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 UniqueId
Show UniqueId
A 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 name of the column that represents the unique ID.
dataPools
Returns the Data Pools within the Environment.A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.The
dataPools query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
Returns
Nullable
DataPoolConnection
Show DataPoolConnection
Show DataPoolConnection
The Data Pool connection object.Learn more about pagination in GraphQL.
The Data Pool connection’s edges.
See DataPoolEdge
The Data Pool connection’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
environment
Returns the Environment specified by the given ID.
Arguments
Returns
Nullable
Environment
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
materializedViews
Returns the Materialized Views within the Environment.The
materializedViews query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
Returns
Nullable
MaterializedViewConnection
Show MaterializedViewConnection
Show MaterializedViewConnection
The Materialized View connection object.Learn more about pagination in GraphQL.
The Materialized View connection’s edges.
Show MaterializedViewEdge
Show MaterializedViewEdge
The Materialized View edge object.Learn more about pagination in GraphQL.
The edge’s cursor.
The edge’s node.See MaterializedView
The Materialized View connection’s nodes.
Show MaterializedView
Show MaterializedView
The Materialized View’s unique identifier.
The Materialized View’s unique name.
The Materialized View’s description.
The Materialized View’s Environment.See Environment
The Materialized View’s creation date and time in UTC.
The Materialized View’s last modification date and time in UTC.
The Materialized View’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Materialized View’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The SQL that the Materialized View executes.
The Materialized View’s destination (AKA “target”) Data Pool.See DataPool
The Materialized View connection’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
dataPoolAccessPolicy
Returns the Data Pool Access Policy specified by the given ID.A Data Pool Access Policy limits the data that Applications can access within a Data Pool.
Arguments
Returns
Nullable
DataPoolAccessPolicy
Show DataPoolAccessPolicy
Show DataPoolAccessPolicy
The ID of the Data Pool Access Policy.
The Data Pool Access Policy’s unique name.
The Data Pool Access Policy’s description.
The Data Pool Access Policy’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Data Pool Access Policy’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Data Pool Access Policy’s creation date and time in UTC.
The Data Pool Access Policy’s last modification date and time in UTC.
The Data Pool Access Policy’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool Access Policy’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
Columns that the Access Policy makes available for querying.
Row-level filters that the Access Policy applies before executing queries, in the form of SQL.
Show Deprecated Fields
Show Deprecated Fields
Row-level filters that the Access Policy applies before executing queries.deprecated: Use
filtersSql insteadShow Filter
Show Filter
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
metric
Returns the Metric specified by the given ID.A Metric is a business indicator measured over time.
Arguments
Returns
Nullable
Metric
Show Metric
Show Metric
The Metric object.A Metric is a business indicator measured over time.
The Metric’s unique identifier.
The Metric’s unique name.
The Metric’s description.
The Metric’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Metric’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Metric’s creation date and time in UTC.
The Metric’s last modification date and time in UTC.
The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Metric’s Dimensions. These Dimensions are available to Query Filters.
Show Dimension
Show Dimension
The Dimension object that represents a column in a table.
The column name it represents.
The column data type.
Whether the column is nullable.
Show Deprecated Fields
Show Deprecated Fields
Whether the column is a unique key.deprecated: This is Snowflake-specific, and will be removed
The statistics for the dimension values. Fetching statistics incurs query costs.deprecated: Issue normal queries for calculating statsSee DimensionStatistics
The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.
Show Dimension
Show Dimension
The Dimension object that represents a column in a table.
The column name it represents.
The column data type.
Whether the column is nullable.
Show Deprecated Fields
Show Deprecated Fields
Whether the column is a unique key.deprecated: This is Snowflake-specific, and will be removed
The statistics for the dimension values. Fetching statistics incurs query costs.deprecated: Issue normal queries for calculating statsSee DimensionStatistics
The Metric’s type. The different Metric types determine how the values are calculated.
Show MetricType
Show 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.
The settings for the Metric. The settings are specific to the Metric’s type.
Show MetricSettings
Show MetricSettings
A Metric’s settings, depending on its type.
MetricSettings
CountMetricSettings | SumMetricSettings | CountDistinctMetricSettings | AverageMetricSettings | MinMetricSettings | MaxMetricSettings | CustomMetricSettings
Show Deprecated Fields
Show Deprecated Fields
The Metric’s measure. Access this from the Metric’s
settings object instead.deprecated: Use the Metric settings object instead.Show Dimension
Show Dimension
The Dimension object that represents a column in a table.
The column name it represents.
The column data type.
Whether the column is nullable.
Show Deprecated Fields
Show Deprecated Fields
Whether the column is a unique key.deprecated: This is Snowflake-specific, and will be removed
The statistics for the dimension values. Fetching statistics incurs query costs.deprecated: Issue normal queries for calculating statsSee DimensionStatistics
Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.deprecated: Use the top-level
counter query insteadArguments
Show CounterInput
Show 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.See MetricInput
The time range for calculating the counter.See TimeRangeInput
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, in the form of SQL. If no Query Filters are provided, all data is included.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the counter data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadSee FilterInputQuery the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.deprecated: Use the top-level
timeSeries query insteadArguments
Show TimeSeriesInput
Show 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.See MetricInput
The time range for calculating the time series.See TimeRangeInput
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.See TimeSeriesGranularity
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.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the time series data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadSee FilterInputShow TimeSeriesResponse
Show TimeSeriesResponse
The time series response object. It contains an array of time series labels and an array of Metric values for the given time range and Query Filters.
The time series labels.
The time series values.
The time series values for each group in
groupBy, if specified.See TimeSeriesResponseGroupQuery the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.deprecated: Use the top-level
leaderboard query insteadArguments
Show LeaderboardInput
Show 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.See MetricInput
The time range for calculating the leaderboard.See TimeRangeInput
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”.
One or many Dimensions to group the Metric values by. Typically, Dimensions in a leaderboard are what you want to compare and rank.See DimensionInput
The sort order of the rows. It can be ascending (
ASC) or descending (DESC) order. Defaults to descending (DESC) order when not provided.See SortThe 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.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the leaderboard data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadSee FilterInputShow LeaderboardResponse
Show LeaderboardResponse
The leaderboard response object. It contains an array of headers and a table (array of rows) with the selected Dimensions and corresponding Metric values for the given time range and Query Filters.
The table headers. It contains the Dimension and Metric names.
An ordered array of rows. Each row contains the Dimension values and the corresponding Metric value. A Dimension value can be empty. A Metric value will never be empty.
Whether or not access control is enabled for the Metric.deprecated: Use Data Pool Access Policies instead
metricByName
Returns the Metric specified by the given unique name.A Metric is a business indicator measured over time.
Arguments
Returns
Nullable
Metric
Show Metric
Show Metric
The Metric object.A Metric is a business indicator measured over time.
The Metric’s unique identifier.
The Metric’s unique name.
The Metric’s description.
The Metric’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Metric’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Metric’s creation date and time in UTC.
The Metric’s last modification date and time in UTC.
The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Metric’s Dimensions. These Dimensions are available to Query Filters.
Show Dimension
Show Dimension
The Dimension object that represents a column in a table.
The column name it represents.
The column data type.
Whether the column is nullable.
Show Deprecated Fields
Show Deprecated Fields
Whether the column is a unique key.deprecated: This is Snowflake-specific, and will be removed
The statistics for the dimension values. Fetching statistics incurs query costs.deprecated: Issue normal queries for calculating statsSee DimensionStatistics
The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.
Show Dimension
Show Dimension
The Dimension object that represents a column in a table.
The column name it represents.
The column data type.
Whether the column is nullable.
Show Deprecated Fields
Show Deprecated Fields
Whether the column is a unique key.deprecated: This is Snowflake-specific, and will be removed
The statistics for the dimension values. Fetching statistics incurs query costs.deprecated: Issue normal queries for calculating statsSee DimensionStatistics
The Metric’s type. The different Metric types determine how the values are calculated.
Show MetricType
Show 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.
The settings for the Metric. The settings are specific to the Metric’s type.
Show MetricSettings
Show MetricSettings
A Metric’s settings, depending on its type.
MetricSettings
CountMetricSettings | SumMetricSettings | CountDistinctMetricSettings | AverageMetricSettings | MinMetricSettings | MaxMetricSettings | CustomMetricSettings
Show Deprecated Fields
Show Deprecated Fields
The Metric’s measure. Access this from the Metric’s
settings object instead.deprecated: Use the Metric settings object instead.Show Dimension
Show Dimension
The Dimension object that represents a column in a table.
The column name it represents.
The column data type.
Whether the column is nullable.
Show Deprecated Fields
Show Deprecated Fields
Whether the column is a unique key.deprecated: This is Snowflake-specific, and will be removed
The statistics for the dimension values. Fetching statistics incurs query costs.deprecated: Issue normal queries for calculating statsSee DimensionStatistics
Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.deprecated: Use the top-level
counter query insteadArguments
Show CounterInput
Show 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.See MetricInput
The time range for calculating the counter.See TimeRangeInput
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, in the form of SQL. If no Query Filters are provided, all data is included.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the counter data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadSee FilterInputQuery the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.deprecated: Use the top-level
timeSeries query insteadArguments
Show TimeSeriesInput
Show 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.See MetricInput
The time range for calculating the time series.See TimeRangeInput
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.See TimeSeriesGranularity
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.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the time series data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadSee FilterInputShow TimeSeriesResponse
Show TimeSeriesResponse
The time series response object. It contains an array of time series labels and an array of Metric values for the given time range and Query Filters.
The time series labels.
The time series values.
The time series values for each group in
groupBy, if specified.See TimeSeriesResponseGroupQuery the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.deprecated: Use the top-level
leaderboard query insteadArguments
Show LeaderboardInput
Show 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.See MetricInput
The time range for calculating the leaderboard.See TimeRangeInput
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”.
One or many Dimensions to group the Metric values by. Typically, Dimensions in a leaderboard are what you want to compare and rank.See DimensionInput
The sort order of the rows. It can be ascending (
ASC) or descending (DESC) order. Defaults to descending (DESC) order when not provided.See SortThe 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.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the leaderboard data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadSee FilterInputShow LeaderboardResponse
Show LeaderboardResponse
The leaderboard response object. It contains an array of headers and a table (array of rows) with the selected Dimensions and corresponding Metric values for the given time range and Query Filters.
The table headers. It contains the Dimension and Metric names.
An ordered array of rows. Each row contains the Dimension values and the corresponding Metric value. A Dimension value can be empty. A Metric value will never be empty.
Whether or not access control is enabled for the Metric.deprecated: Use Data Pool Access Policies instead
metrics
Returns the Metrics within the Environment.A Metric is a business indicator measured over time. Each Metric is associated with one Data Pool, which is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.The
metrics query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
Returns
Nullable
MetricConnection
Show MetricConnection
Show MetricConnection
The Metric connection object.Learn more about pagination in GraphQL.
The Metric connection’s edges.
See MetricEdge
The Metric connection’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
booster
Returns the Booster specified by the given ID.A Booster significantly improves the query performance for a Metric.
Arguments
Returns
Nullable
Booster
Show Booster
Show Booster
Boosters allow you to optimize Metric Queries for a subset of commonly used Dimensions. A Metric can have one or many Boosters to optimize for the different Query patterns.Boosters can be understood as an aggregating index. The index is formed from left to right as follows:
- The Data Pool’s Tenant ID column (if present)
- Metric Filter columns (if present)
- Query Filter Dimensions (see
dimensions) - The Data Pool’s timestamp column
The Booster’s unique identifier.
The Booster’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Booster’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Booster’s creation date and time in UTC.
The Booster’s last modification date and time in UTC.
The Booster’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Booster’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The status of the Booster (once LIVE it will be available for speeding up Metric queries).
Show BoosterStatus
Show 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.
When the Booster is OPTIMIZING, this represents its progress as a number from 0 to 1.
In all other states, progress is null.
Dimensions included in the Booster.
Show Dimension
Show Dimension
The Dimension object that represents a column in a table.
The column name it represents.
The column data type.
Whether the column is nullable.
Show Deprecated Fields
Show Deprecated Fields
Whether the column is a unique key.deprecated: This is Snowflake-specific, and will be removed
The statistics for the dimension values. Fetching statistics incurs query costs.deprecated: Issue normal queries for calculating statsSee DimensionStatistics
The number of records in the Booster.
The amount of storage in terabytes used by the Booster.
policy
Returns a Policy by ID.
Arguments
Returns
Nullable
Policy
Show Policy
Show Policy
The Policy type. It governs an Application’s access to a Metric’s data.
The Policy’s unique identifier.
The Policy’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Policy’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Policy’s creation date and time in UTC.
The Policy’s last modification date and time in UTC.
The Policy’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Policy’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The type of Policy.
Show PolicyType
Show 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.
The Application that is granted access.
See Application
sync
Returns a Sync by ID.
Arguments
Returns
Nullable
Sync
Show Sync
Show Sync
The Sync object.This represents the process of syncing data from your Data Source (for example, a Snowflake data warehouse) to your Data Pool.
The Sync’s unique identifier.
The Sync’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Sync’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Sync’s creation date and time in UTC.
The Sync’s last modification date and time in UTC.
The Sync’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Sync’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Sync’s Data Pool’s Data Source.
Show DataSource
Show DataSource
The Data Source object.A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.
The Data Source’s unique identifier.
The Data Source’s unique name.
The Data Source’s description.
The Data Source’s Environment.See Environment
The Data Source’s creation date and time in UTC.
The Data Source’s last modification date and time in UTC.
The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Source’s type.See DataSourceType
The Data Source’s status.See DataSourceStatus
The Data Source’s connection settings.See ConnectionSettings
A list of checks performed on the Data Source during its most recent connection attempt.See DataSourceCheck
If you list Data Pools via the See DataPoolConnection
dataPools field on a Data Source, you will get Data Pools for the Data Source.The dataPools field uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.Arguments
The number of new, updated, and deleted records contained within the Sync, if known. This excludes filtered records.
The (compressed) size of the Sync, in bytes, if known.
The status of the Sync (all Syncs begin as SYNCING before transitioning to SUCCEEDED or FAILED).
Show SyncStatus
Show 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.
The time at which the Sync started.
The time at which the Sync succeeded.
The time at which the Sync failed.
Show Deprecated Fields
Show Deprecated Fields
The number of new records contained within the Sync, if known. This excludes filtered records.deprecated: All records are considered to be processed; see
processedRecords insteadThe number of updated records contained within the Sync, if known. This excludes filtered records.deprecated: All records are considered to be processed; see
processedRecords insteadThe number of deleted records contained within the Sync, if known. This excludes filtered records.deprecated: All records are considered to be processed; see
processedRecords insteadThe number of filtered records contained within the Sync, due to issues such as a missing timestamp Dimension, if any are known to be invalid.deprecated: All records are considered to be processed; see
processedRecords insteadtable
Returns a table by ID.
Arguments
Returns
Nullable
Table
Show Table
Show Table
The table object.Once a table introspection succeeds, it creates a new table object for every table it introspected.
The table’s ID.
The table’s name.
The Data Source to which the table belongs.
See DataSource
The number of rows contained within the table at the time of introspection. Check the table’s
cachedAt time, since this info can become out of date.The size of the table (in bytes) at the time of introspection. Check the table’s
cachedAt time, since this info can become out of date.The time at which the table was cached (i.e., the time at which it was introspected).
The time at which the table was created. This is the same as its
cachedAt time.The table’s creator. This corresponds to the initiator of the table Introspection. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The table’s columns.
Arguments
Show ColumnConnection
Show ColumnConnection
The column connection object.Learn more about pagination in GraphQL.
The time at which the columns were cached (i.e., the time at which they were introspected).
The column connection’s edges.See ColumnEdge
The table’s columns which can be used as a timestamp for a Data Pool.
Arguments
Show ColumnConnection
Show ColumnConnection
The column connection object.Learn more about pagination in GraphQL.
The time at which the columns were cached (i.e., the time at which they were introspected).
The column connection’s edges.See ColumnEdge
The table’s columns which can be used as a measure for a Metric.
Arguments
Show ColumnConnection
Show ColumnConnection
The column connection object.Learn more about pagination in GraphQL.
The time at which the columns were cached (i.e., the time at which they were introspected).
The column connection’s edges.See ColumnEdge
Show Deprecated Fields
Show Deprecated Fields
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the table obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
metricReport
Build a report, or table, consisting of multiple Metrics broken down by one-or-more dimensions.The first few columns of the report are the dimensions you choose to break down by. The subsequent columns are the
Metrics you choose to query. By default, the report sorts on the first Metric in descending order, but you can
configure this with the
orderByMetric and sort inputs.Finally, reports use cursor-based pagination. You can control page size with the first and
last inputs.Arguments
Show MetricReportInput
Show 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.
Show TimeRangeInput
Show TimeRangeInput
The fields required to specify the time range for a time series, counter, or leaderboard Metric query.If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.If both relative and absolute time ranges are provided, the relative time range will take precedence.If a
LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.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.See RelativeTimeRange
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. 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.
Show MetricReportDimensionInput
Show 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.One or more Metrics to include in the Metric Report. These will be broken down by
dimensions.Show MetricReportMetricInput
Show 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.See MetricInput
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.See SortShow Deprecated Fields
Show Deprecated Fields
The Metric’s unique name. If not specified, Propel will lookup the Metric by ID.deprecated: Use
metricThe Metric’s ID. If not specified, Propel will lookup the Metric by unique name.deprecated: Use
metricThe Query Filters to apply when calculating the Metric.deprecated: Use
filterSql insteadSee FilterInputThe 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.
Show Deprecated Fields
Show Deprecated Fields
The Query Filters to apply when building the Metric Report. These can be used to filter out rows.deprecated: Use
filterSql insteadShow FilterInput
Show FilterInput
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
Returns
Nullable
MetricReportConnection
Show MetricReportConnection
Show MetricReportConnection
The Metric Report connection object.It includes
headers and rows for a single page of a report. It also allows paging forward and backward to other
pages of the report.The report connection’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
The report connection’s edges.
Show MetricReportEdge
Show MetricReportEdge
The report connection’s nodes.
Show MetricReportNode
Show MetricReportNode
The Metric Report node object.This type represents a single row of a report.
An ordered array of display names for your dimensions and Metrics, as defined in the report input. Use this to display your table’s header.
An ordered array of columns. Each column contains the dimension and Metric values for a single row, as defined in the report input. Use this to display a single row within your table.
An ordered array of display names for your dimensions and Metrics, as defined in the report input. Use this to display your table’s header.
An ordered array of rows. Each row contains dimension and Metric values, as defined in the report input. Use these to display the rows of your table.
The Query statistics and metadata.
Show QueryInfo
Show QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Query status.See QueryStatus
The Query subtype.See QuerySubtype
The SQL the query executed.
sqlV1
Query Data Pools using SQL.
Arguments
Show SqlV1Input
Show SqlV1Input
Input to the SqlV1 api.
The SQL query.
Returns
Non-null
SqlResponse
Show SqlResponse
Show SqlResponse
Response from the SQL API.
The column names in the same order as present in the
data field.Show SqlColumnResponse
Show SqlColumnResponse
The name of the returned column.
The returned column’s type.See ColumnType
Whether the column is nullable, meaning whether it accepts a null value.
The data gathered by the SQL query. The data is returned in an N x M matrix format, where the
first dimension are the rows retrieved, and the second dimension are the columns. Each cell
can be either a string or null, and the string can represent a number, text, date or boolean value.
The Query statistics and metadata.
Show QueryInfo
Show QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Query status.See QueryStatus
The Query subtype.See QuerySubtype
The SQL the query executed.
describeSqlV1
Describe SQL statements Data Pools.
Arguments
Show DescribeSqlV1Input
Show DescribeSqlV1Input
Input for describing SqlV1 inputs.
The SQL query.
Returns
Non-null
DescribeSqlResponse
Show DescribeSqlResponse
Show DescribeSqlResponse
Response from the describe SQL API.
The columns that the query would return.
Show SqlColumnResponse
Show SqlColumnResponse
The name of the returned column.
The returned column’s type.See ColumnType
Whether the column is nullable, meaning whether it accepts a null value.
dataGrid
Returns the individual records of a Data Pool with the convenience of built-in pagination, filtering, and sorting.
Arguments
Show DataGridInput
Show DataGridInput
The fields for querying Data Grid records.
The time range for retrieving the records.
Show TimeRangeInput
Show TimeRangeInput
The fields required to specify the time range for a time series, counter, or leaderboard Metric query.If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.If both relative and absolute time ranges are provided, the relative time range will take precedence.If a
LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.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.See RelativeTimeRange
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. 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.Show Sort
Show Sort
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.
Show Deprecated Fields
Show Deprecated Fields
The filters to apply to the records. You may only filter on columns included in the
columns array input.deprecated: Use filterSql insteadShow FilterInput
Show FilterInput
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
Returns
Non-null
DataGridConnection
Show DataGridConnection
Show DataGridConnection
The Data Grid connection.It includes
headers and rows for a single page of a Data Grid table. It also allows paging forward and backward to other
pages of the Data Grid table.The Data Grid table’s headers.
An array of arrays containing the values of the Data Grid table’s rows.
The Query statistics and metadata.
Show QueryInfo
Show QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Query status.See QueryStatus
The Query subtype.See QuerySubtype
The SQL the query executed.
The Data Grid table’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
The Data Grid table’s edges.
Show DataGridEdge
Show DataGridEdge
recordsByUniqueId
Returns records by the given unique IDs.
Arguments
Show RecordsByUniqueIdInput
Show RecordsByUniqueIdInput
The fields for querying records by unique ID.
The columns to retrieve.
The unique IDs of the records to retrieve.
Returns
Non-null
RecordsByUniqueIdResponse
Show RecordsByUniqueIdResponse
Show RecordsByUniqueIdResponse
The Data Pool columns for the record.
An array of values for the record.
The Query statistics and metadata.
Show QueryInfo
Show QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Query status.See QueryStatus
The Query subtype.See QuerySubtype
The SQL the query executed.
topValues
Returns an array of the most frequent values in a given column. The resulting array is sorted in descending order of approximate frequency of values.
Arguments
Show TopValuesInput
Show TopValuesInput
The fields for querying the top values in a given column.
The column to fetch the unique values from.
The time range for calculating the top values.
Show TimeRangeInput
Show TimeRangeInput
The fields required to specify the time range for a time series, counter, or leaderboard Metric query.If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.If both relative and absolute time ranges are provided, the relative time range will take precedence.If a
LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.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.See RelativeTimeRange
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. 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.
Returns
Non-null
TopValuesResponse
Show TopValuesResponse
Show TopValuesResponse
An array with the list of values.
counter
Query a metric in counter format. Returns a single metric value for the given time range and filters.
Arguments
Show CounterInput
Show 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.
Show MetricInput
Show MetricInput
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 time range for calculating the counter.
Show TimeRangeInput
Show TimeRangeInput
The fields required to specify the time range for a time series, counter, or leaderboard Metric query.If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.If both relative and absolute time ranges are provided, the relative time range will take precedence.If a
LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.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.See RelativeTimeRange
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. 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.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the counter data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadShow FilterInput
Show FilterInput
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
Returns
Nullable
CounterResponse
Show CounterResponse
Show CounterResponse
The counter response object. It contains a single Metric value for the given time range and Query Filters.
The value of the counter.
The Query statistics and metadata.
Show QueryInfo
Show QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Query status.See QueryStatus
The Query subtype.See QuerySubtype
The SQL the query executed.
counters
Query metrics in counter format. Returns a metric value for each input in the array of inputs.
Arguments
Show [CounterInput!]
Show [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.
Show MetricInput
Show MetricInput
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 time range for calculating the counter.
Show TimeRangeInput
Show TimeRangeInput
The fields required to specify the time range for a time series, counter, or leaderboard Metric query.If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.If both relative and absolute time ranges are provided, the relative time range will take precedence.If a
LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.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.See RelativeTimeRange
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. 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.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the counter data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadShow FilterInput
Show FilterInput
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
Returns
Non-null
CounterResponse
Show CounterResponse
Show CounterResponse
The counter response object. It contains a single Metric value for the given time range and Query Filters.
The value of the counter.
The Query statistics and metadata.
Show QueryInfo
Show QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Query status.See QueryStatus
The Query subtype.See QuerySubtype
The SQL the query executed.
timeSeries
Query a metric in time series format. Returns arrays of timestamps and metric values for the given time range and filters.
Arguments
Show TimeSeriesInput
Show 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.
Show MetricInput
Show MetricInput
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 time range for calculating the time series.
Show TimeRangeInput
Show TimeRangeInput
The fields required to specify the time range for a time series, counter, or leaderboard Metric query.If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.If both relative and absolute time ranges are provided, the relative time range will take precedence.If a
LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.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.See RelativeTimeRange
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. Defaults to “UTC”.
The time granularity (hour, day, month, etc.) to aggregate the Metric values by.
Show TimeSeriesGranularity
Show TimeSeriesGranularity
The available time series granularities. Granularities define the unit of time to aggregate the Metric data for a time series query.For example, if the granularity is set to
DAY, then the the time series query will return a label and a value for each day.If there are no records for a given time series granularity, Propel will return the label and a value of “0” so that the time series can be properly visualized.MINUTE: Aggregates values by minute intervals.FIVE_MINUTES: Aggregates values by 5-minute intervals.TEN_MINUTES: Aggregates values by 10-minute intervals.FIFTEEN_MINUTES: Aggregates values by 15-minute intervals.HOUR: Aggregates values by hourly intervals.DAY: Aggregates values by daily intervals.WEEK: Aggregates values by weekly intervals.MONTH: Aggregates values by monthly intervals.YEAR: Aggregates values by yearly intervals.
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.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the time series data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadShow FilterInput
Show FilterInput
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
Returns
Nullable
TimeSeriesResponse
Show TimeSeriesResponse
Show TimeSeriesResponse
The time series response object. It contains an array of time series labels and an array of Metric values for the given time range and Query Filters.
The time series labels.
The time series values.
The time series values for each group in
groupBy, if specified.Show TimeSeriesResponseGroup
Show TimeSeriesResponseGroup
The time series response object for a group specified in
groupBy. It contains an array of time series labels and an array of Metric values for a particular group.The time series group’s columns.
The time series group’s labels.
The time series group’s values.
The Query statistics and metadata.
Show QueryInfo
Show QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Query status.See QueryStatus
The Query subtype.See QuerySubtype
The SQL the query executed.
leaderboard
Query a metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the metric’s corresponding values for the given time range and filters.
Arguments
Show LeaderboardInput
Show 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.
Show MetricInput
Show MetricInput
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 time range for calculating the leaderboard.
Show TimeRangeInput
Show TimeRangeInput
The fields required to specify the time range for a time series, counter, or leaderboard Metric query.If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric’s Data Pool and ending with the latest record.If both relative and absolute time ranges are provided, the relative time range will take precedence.If a
LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.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.See RelativeTimeRange
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. 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.
Show DimensionInput
Show DimensionInput
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.Show Sort
Show Sort
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.
Show Deprecated Fields
Show Deprecated Fields
The ID of the Metric to query.Required if
metricName is not specified.deprecated: Use metricThe name of the Metric to query.Required if
metricId is not specified.deprecated: Use metricThe Query Filters to apply before retrieving the leaderboard data. If no Query Filters are provided, all data is included.deprecated: Use
filterSql insteadShow FilterInput
Show FilterInput
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
Returns
Nullable
LeaderboardResponse
Show LeaderboardResponse
Show LeaderboardResponse
The leaderboard response object. It contains an array of headers and a table (array of rows) with the selected Dimensions and corresponding Metric values for the given time range and Query Filters.
The table headers. It contains the Dimension and Metric names.
An ordered array of rows. Each row contains the Dimension values and the corresponding Metric value. A Dimension value can be empty. A Metric value will never be empty.
The Query statistics and metadata.
Show QueryInfo
Show QueryInfo
The Query Info object. It contains metadata and statistics about a Query performed.
The Query’s unique identifier.
The date and time in UTC when the Query was created.
The unique identifier of the actor that performed the Query.
The date and time in UTC when the Query was last modified.
The unique identifier of the actor that modified the Query.
The bytes processed by the Query.
The duration of the Query in milliseconds.
The number of records processed by the Query.
The bytes returned by the Query.
The number of records returned by the Query.
The Query status.See QueryStatus
The Query subtype.See QuerySubtype
The SQL the query executed.
deletionJob
Returns the Deletion Job specified by the given ID.The Deletion Job represents the asynchronous process of deleting data
given some filters inside a Data Pool.
Arguments
Returns
Nullable
DeletionJob
Show DeletionJob
Show DeletionJob
Deletion Job scheduled for a specific Data Pool.The Deletion Job represents the asynchronous process of deleting data
given some filters inside a Data Pool. It tracks the deletion process
until it is finished, showing the progress and the outcome when it is finished.
The Deletion Job’s ID.
The Deletion Job’s creation date and time in UTC.
Who created the Deletion Job.
The Deletion Job’s last modification date and time in UTC.
Who last modified the Deletion Job.
Account to which the Deletion Job belongs.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
Environment to which the Deletion Job belongs.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Data Pool whose records will be deleted by the Deletion Job.
See DataPool
The current Deletion Job’s status.
Show JobStatus
Show 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.
The filters that will be used for deleting data, in the form of SQL. Data matching the filters will be deleted.
The current progress of the Deletion Job, from 0.0 to 1.0.
The time at which the Deletion Job started.
The time at which the Deletion Job succeeded.
The time at which the Deletion Job failed.
Show Deprecated Fields
Show Deprecated Fields
The list of filters that will be used for deleting data. Data matching the filters will be deleted.deprecated: Use
filterSql insteadShow Filter
Show Filter
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
addColumnToDataPoolJob
Returns the AddColumnToDataPoolJob specified by the given ID.The AddColumnToDataPoolJob represents the asynchronous process of adding
a column, given its name and type, to a Data Pool.
Arguments
Returns
Nullable
AddColumnToDataPoolJob
Show AddColumnToDataPoolJob
Show AddColumnToDataPoolJob
AddColumnToDataPoolJob scheduled for a specific Data Pool.The Add Column Job represents the asynchronous process of adding a column,
given its name and type, to a Data Pool. It tracks the process of adding a column
until it is finished, showing the progress and the outcome when it is finished.
The AddColumnToDataPoolJob’s ID.
The AddColumnToDataPoolJob’s creation date and time in UTC.
Who created the AddColumnToDataPoolJob.
The AddColumnToDataPoolJob’s last modification date and time in UTC.
Who modified the AddColumnToDataPoolJob last.
Account to which the AddColumnToDataPoolJob belongs.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
Environment to which the AddColumnToDataPoolJob belongs.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The current AddColumnToDataPoolJob’s status.
Show JobStatus
Show 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.
Name of the new column.
Type of the new column.
Show ColumnType
Show 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.
The ClickHouse type of the new column when
columnType is set to CLICKHOUSE.JSON property to which the new column corresponds.
The current progress of the AddColumnToDataPool Job, from 0.0 to 1.0.
The time at which the AddColumnToDataPool Job started.
The time at which the AddColumnToDataPool Job succeeded.
The time at which the AddColumnToDataPool Job failed.
addColumnToDataPoolJobByStatus
Returns the AddColumnToDataPool Job specified by a given status.
Arguments
Show JobStatus
Show 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.
Returns
Non-null
AddColumnToDataPoolJobConnection
Show AddColumnToDataPoolJobConnection
Show AddColumnToDataPoolJobConnection
The Add column to Data Pool Job connection object.Learn more about pagination in GraphQL.
The Add column to Data Pool Job connection’s edges.
See AddColumnToDataPoolJobEdge
The Add column to Data Pool Job connection’s nodes.
See AddColumnToDataPoolJob
The Add column to Data Pool Job connection’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
updateDataPoolRecordsJob
Returns the UpdateDataPoolRecords Job specified by the given ID.The UpdateDataPoolRecords Job represents the asynchronous process of updating
records inside a Data Pool.
Arguments
Returns
Nullable
UpdateDataPoolRecordsJob
Show UpdateDataPoolRecordsJob
Show UpdateDataPoolRecordsJob
UpdateDataPoolRecords Job scheduled for a specific Data Pool.
The Update Data Pool Records Job represents the asynchronous process of updating records
given some filters, inside a Data Pool. It tracks the process of updating records
until it is finished, showing the progress and the outcome when it is finished.
The UpdateDataPoolRecords Job’s ID
The UpdateDataPoolRecords Job’s creation date and time in UTC
Who created the UpdateDataPoolRecords Job
The UpdateDataPoolRecords Job’s last modification date and time in UTC
Who last modified the UpdateDataPoolRecords Job
Account to which the UpdateDataPoolRecords Job belongs
Show Account
Show Account
The Account object.
The Account’s unique identifier.
Environment to which the UpdateDataPoolRecords Job belongs
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Data Pool whose records will be updated by the UpdateDataPoolRecords Job
See DataPool
The current UpdateDataPoolRecords Job’s status
Show JobStatus
Show 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.
The filters that will be used for updating data, in the form of SQL. Data matching the filters will be updated.
Describes how the job will update the records.
Show UpdateDataPoolRecordsJobSetColumn
Show UpdateDataPoolRecordsJobSetColumn
The fields for creating an Update Data Pool Records Job.
Copy
{
"column": "status",
"expression": "'completed'"
}
{
"column": "counter",
"expression": "counter + 1"
}
{
"column": "full_name",
"expression": "concat(first_name, ' ', last_name)"
}
The name of the column to update.
The value to which the column will be updated. Once evaluated, it should be of the same data type as the column.
The current progress of the UpdateDataPoolRecords Job, from 0.0 to 1.0.
The time at which the UpdateDataPoolRecords Job started.
The time at which the UpdateDataPoolRecords Job succeeded.
The time at which the UpdateDataPoolRecords Job failed.
Show Deprecated Fields
Show Deprecated Fields
The list of filters that will be used for updating data. Data matching the filters will be updated.deprecated: Use
filterSql insteadShow Filter
Show Filter
The fields of a filter.You can construct more complex filters using you could writeNote that
and and or. For example, to construct a filter equivalent toCopy
(value > 0 AND value <= 100) OR status = "confirmed"
Copy
{
"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"
}]
}
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.
updateDataPoolRecordsJobByStatus
Returns the UpdateDataPoolRecords Job specified by a given status.
Arguments
Show JobStatus
Show 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.
Returns
Non-null
UpdateDataPoolRecordsJobConnection
Show UpdateDataPoolRecordsJobConnection
Show UpdateDataPoolRecordsJobConnection
The Update Data Pool records Job connection object.Learn more about pagination in GraphQL.
The Update Data Pool records Job connection’s edges.
See UpdateDataPoolRecordsJobEdge
The Update Data Pool records Job connection’s nodes.
See UpdateDataPoolRecordsJob
The Update Data Pool records Job connection’s page info.
Show PageInfo
Show PageInfo
The page info object used for pagination.
Points to the first item returned in the results. Used when paginating backward.
Points to the last item returned in the results. Used when paginating forward.
A boolean that indicates whether a next page of results exists. Can be used to display a “next page” button in user interfaces, for example.
A boolean that indicates whether a previous page of results exists. Can be used to display a “previous page” button in user interfaces, for example.
materializedView
Returns the Materialized View specified by the given ID.
Arguments
Returns
Nullable
MaterializedView
Show MaterializedView
Show MaterializedView
The Materialized View’s unique identifier.
The Materialized View’s unique name.
The Materialized View’s description.
The Materialized View’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Materialized View’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Materialized View’s creation date and time in UTC.
The Materialized View’s last modification date and time in UTC.
The Materialized View’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Materialized View’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The SQL that the Materialized View executes.
The Materialized View’s destination (AKA “target”) Data Pool.
Show DataPool
Show DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cache
The Data Pool’s unique identifier.
The Data Pool’s unique name.
The Data Pool’s description.
The Data Pool’s Environment.See Environment
The Data Pool’s creation date and time in UTC.
The Data Pool’s last modification date and time in UTC.
The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Pool’s Data Source.
See DataSource
The Data Pool’s status.See DataPoolStatus
The Data Pool’s data retention in days (not yet supported).
The name of the Data Pool’s table.
The number of records in the Data Pool.
The amount of storage in terabytes used by the Data Pool.
A list of setup tasks performed on the Data Pool during its most recent setup attempt.See DataPoolSetupTask
Settings related to Data Pool syncing.See DataPoolSyncing
Whether the Data Pool has access control enabled or not.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.
Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.See ValidateExpressionResult
Arguments
The Data Pool’s table settings.See TableSettings
The Data Pool’s columns that participate in its PARTITION BY clause.See DataPoolColumn
The Data Pool’s columns that participate in its PRIMARY KEY clause.See DataPoolColumn
The Data Pool’s columns that participate in its ORDER BY clause.See DataPoolColumn
Show Deprecated Fields
Show Deprecated Fields
The Data Pool’s tenant ID, if configured.deprecated: Will be removed; use Data Pool Access Policies insteadSee Tenant
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.See UniqueId
The Materialized View’s source Data Pool.
Show DataPool
Show DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cache
The Data Pool’s unique identifier.
The Data Pool’s unique name.
The Data Pool’s description.
The Data Pool’s Environment.See Environment
The Data Pool’s creation date and time in UTC.
The Data Pool’s last modification date and time in UTC.
The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Pool’s Data Source.
See DataSource
The Data Pool’s status.See DataPoolStatus
The Data Pool’s data retention in days (not yet supported).
The name of the Data Pool’s table.
The number of records in the Data Pool.
The amount of storage in terabytes used by the Data Pool.
A list of setup tasks performed on the Data Pool during its most recent setup attempt.See DataPoolSetupTask
Settings related to Data Pool syncing.See DataPoolSyncing
Whether the Data Pool has access control enabled or not.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.
Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.See ValidateExpressionResult
Arguments
The Data Pool’s table settings.See TableSettings
The Data Pool’s columns that participate in its PARTITION BY clause.See DataPoolColumn
The Data Pool’s columns that participate in its PRIMARY KEY clause.See DataPoolColumn
The Data Pool’s columns that participate in its ORDER BY clause.See DataPoolColumn
Show Deprecated Fields
Show Deprecated Fields
The Data Pool’s tenant ID, if configured.deprecated: Will be removed; use Data Pool Access Policies insteadSee Tenant
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.See UniqueId
Other Data Pools queried by the Materialized View.
Show DataPool
Show DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cache
The Data Pool’s unique identifier.
The Data Pool’s unique name.
The Data Pool’s description.
The Data Pool’s Environment.See Environment
The Data Pool’s creation date and time in UTC.
The Data Pool’s last modification date and time in UTC.
The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Pool’s Data Source.
See DataSource
The Data Pool’s status.See DataPoolStatus
The Data Pool’s data retention in days (not yet supported).
The name of the Data Pool’s table.
The number of records in the Data Pool.
The amount of storage in terabytes used by the Data Pool.
A list of setup tasks performed on the Data Pool during its most recent setup attempt.See DataPoolSetupTask
Settings related to Data Pool syncing.See DataPoolSyncing
Whether the Data Pool has access control enabled or not.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.
Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.See ValidateExpressionResult
Arguments
The Data Pool’s table settings.See TableSettings
The Data Pool’s columns that participate in its PARTITION BY clause.See DataPoolColumn
The Data Pool’s columns that participate in its PRIMARY KEY clause.See DataPoolColumn
The Data Pool’s columns that participate in its ORDER BY clause.See DataPoolColumn
Show Deprecated Fields
Show Deprecated Fields
The Data Pool’s tenant ID, if configured.deprecated: Will be removed; use Data Pool Access Policies insteadSee Tenant
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.See UniqueId
materializedViewByName
Returns the Materialized View specified by its unique name.
Arguments
Returns
Nullable
MaterializedView
Show MaterializedView
Show MaterializedView
The Materialized View’s unique identifier.
The Materialized View’s unique name.
The Materialized View’s description.
The Materialized View’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
The Materialized View’s Environment.
Show Environment
Show Environment
The Environments object.Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
The Environment’s unique identifier.
The Environment’s unique name.
The Environment’s description.
The Environment’s creation date and time in UTC.
The Environment’s last modification date and time in UTC.
The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.
The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.
The Materialized View’s creation date and time in UTC.
The Materialized View’s last modification date and time in UTC.
The Materialized View’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Materialized View’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The SQL that the Materialized View executes.
The Materialized View’s destination (AKA “target”) Data Pool.
Show DataPool
Show DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cache
The Data Pool’s unique identifier.
The Data Pool’s unique name.
The Data Pool’s description.
The Data Pool’s Environment.See Environment
The Data Pool’s creation date and time in UTC.
The Data Pool’s last modification date and time in UTC.
The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Pool’s Data Source.
See DataSource
The Data Pool’s status.See DataPoolStatus
The Data Pool’s data retention in days (not yet supported).
The name of the Data Pool’s table.
The number of records in the Data Pool.
The amount of storage in terabytes used by the Data Pool.
A list of setup tasks performed on the Data Pool during its most recent setup attempt.See DataPoolSetupTask
Settings related to Data Pool syncing.See DataPoolSyncing
Whether the Data Pool has access control enabled or not.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.
Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.See ValidateExpressionResult
Arguments
The Data Pool’s table settings.See TableSettings
The Data Pool’s columns that participate in its PARTITION BY clause.See DataPoolColumn
The Data Pool’s columns that participate in its PRIMARY KEY clause.See DataPoolColumn
The Data Pool’s columns that participate in its ORDER BY clause.See DataPoolColumn
Show Deprecated Fields
Show Deprecated Fields
The Data Pool’s tenant ID, if configured.deprecated: Will be removed; use Data Pool Access Policies insteadSee Tenant
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.See UniqueId
The Materialized View’s source Data Pool.
Show DataPool
Show DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cache
The Data Pool’s unique identifier.
The Data Pool’s unique name.
The Data Pool’s description.
The Data Pool’s Environment.See Environment
The Data Pool’s creation date and time in UTC.
The Data Pool’s last modification date and time in UTC.
The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Pool’s Data Source.
See DataSource
The Data Pool’s status.See DataPoolStatus
The Data Pool’s data retention in days (not yet supported).
The name of the Data Pool’s table.
The number of records in the Data Pool.
The amount of storage in terabytes used by the Data Pool.
A list of setup tasks performed on the Data Pool during its most recent setup attempt.See DataPoolSetupTask
Settings related to Data Pool syncing.See DataPoolSyncing
Whether the Data Pool has access control enabled or not.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.
Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.See ValidateExpressionResult
Arguments
The Data Pool’s table settings.See TableSettings
The Data Pool’s columns that participate in its PARTITION BY clause.See DataPoolColumn
The Data Pool’s columns that participate in its PRIMARY KEY clause.See DataPoolColumn
The Data Pool’s columns that participate in its ORDER BY clause.See DataPoolColumn
Show Deprecated Fields
Show Deprecated Fields
The Data Pool’s tenant ID, if configured.deprecated: Will be removed; use Data Pool Access Policies insteadSee Tenant
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.See UniqueId
Other Data Pools queried by the Materialized View.
Show DataPool
Show DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cache
The Data Pool’s unique identifier.
The Data Pool’s unique name.
The Data Pool’s description.
The Data Pool’s Environment.See Environment
The Data Pool’s creation date and time in UTC.
The Data Pool’s last modification date and time in UTC.
The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The Data Pool’s Data Source.
See DataSource
The Data Pool’s status.See DataPoolStatus
The Data Pool’s data retention in days (not yet supported).
The name of the Data Pool’s table.
The number of records in the Data Pool.
The amount of storage in terabytes used by the Data Pool.
A list of setup tasks performed on the Data Pool during its most recent setup attempt.See DataPoolSetupTask
Settings related to Data Pool syncing.See DataPoolSyncing
Whether the Data Pool has access control enabled or not.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.
Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.See ValidateExpressionResult
Arguments
The Data Pool’s table settings.See TableSettings
The Data Pool’s columns that participate in its PARTITION BY clause.See DataPoolColumn
The Data Pool’s columns that participate in its PRIMARY KEY clause.See DataPoolColumn
The Data Pool’s columns that participate in its ORDER BY clause.See DataPoolColumn
Show Deprecated Fields
Show Deprecated Fields
The Data Pool’s tenant ID, if configured.deprecated: Will be removed; use Data Pool Access Policies insteadSee Tenant
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.See UniqueId
Assistant
Responses are generated using AI and may contain mistakes.