FailureResponse
The failure response object.Error
The error object.The error code.
The error message.
Account
The Account object.The Account’s unique identifier.
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 Environment’s Account.
Show Account
Show Account
The Account object.
The Account’s unique identifier.
EnvironmentResponse
The result of a mutation which creates or modifies an Environment.The Environment which was created or modified.
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.
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.
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.Show Deprecated Fields
Show Deprecated Fields
ApplicationResponse
The result of a mutation which creates or modifies an Application.The Application which was created or modified.
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.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
Show SnowflakeConnectionSettings
Show SnowflakeConnectionSettings
The Snowflake Data Source connection settings.
The Snowflake account. This is the part before the “snowflakecomputing.com” part of your Snowflake URL.
The Snowflake database name.
The Snowflake warehouse name. It should be “PROPELLING” if you used the default name in the setup script.
The Snowflake schema.
The Snowflake username. It should be “PROPEL” if you used the default name in the setup script.
The Snowflake role. It should be “PROPELLER” if you used the default name in the setup script.
Show InternalConnectionSettings
Show InternalConnectionSettings
Show AmazonDataFirehoseConnectionSettings
Show AmazonDataFirehoseConnectionSettings
The Amazon Data Firehose Data Source’s connection settings.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose issues requests to its custom HTTP endpoint.See HttpBasicAuthSettingsAdditional columns for the table in Propel.See AmazonDataFirehoseDataSourceColumn
Copy this value into the URL field when configuring your Amazon Data Firehose to deliver to a custom HTTP endpoint.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s
timestamp value, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsThe primary timestamp column, if any.
Copy this value into the
X-Amz-Firehose-Access-Key header when configuring your Amazon Data Firehose to deliver to a custom HTTP endpoint.Show AmazonDynamoDBConnectionSettings
Show AmazonDynamoDBConnectionSettings
The Amazon DynamoDB Data Source’s connection settings.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
HTTP basic access authentication credentials. You must configure these same credentials to be included in the
X-Amz-Firehose-Access-Key header when Amazon Data Firehose transmits records from your DynamoDB table to its
custom HTTP endpoint.See HttpBasicAuthSettingsAdditional columns for the table in Propel.See AmazonDynamoDBDataSourceColumn
Copy this value into the URL field when configuring your Amazon Data Firehose to transmit records from your
DynamoDB table to a custom HTTP endpoint.
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s
timestamp value, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsThe primary timestamp column, if any.
Copy this value into the
X-Amz-Firehose-Access-Key header when configuring your Amazon Data Firehose to
transmit records from your DynamoDB table to its custom HTTP endpoint.Show ClickHouseConnectionSettings
Show ClickHouseConnectionSettings
The ClickHouse Data Source connection settings.
Which database to connect to
The password for the provided user
Whether the user has readonly permissions or not for querying ClickHouse
The URL where the ClickHouse host is listening to HTTP[S] connections
The user for authenticating against the ClickHouse host
Show HttpConnectionSettings
Show HttpConnectionSettings
The HTTP Data Source connection settings.
The HTTP Basic authentication settings for uploading new data.If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.See HttpBasicAuthSettings
The HTTP Data Source’s tables.See HttpDataSourceTable
Show KafkaConnectionSettings
Show KafkaConnectionSettings
The Kafka Data Source connection settings.
The type of authentication to use. Can be SCRAM-SHA-256, SCRAM-SHA-512, PLAIN or NONE
The bootstrap server(s) to connect to
The password for the provided user
Whether the the connection to the Kafka servers is encrypted or not
The user for authenticating against the Kafka servers
Show PostgreSqlConnectionSettings
Show PostgreSqlConnectionSettings
The PostgreSQL Data Source connection settings.
Which database to connect to
The host where PostgreSQL is listening
The port where PostgreSQL is listening (usually 5432)
Which schema to use
The user for authenticating against PostgreSQL
Show S3ConnectionSettings
Show S3ConnectionSettings
The connection settings for an Amazon S3 Data Source. These include the Amazon S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.
The AWS access key ID for an IAM user with sufficient access to the Amazon S3 bucket.
The name of the Amazon S3 bucket.
The Amazon S3 Data Source’s tables.See S3DataSourceTable
Show TwilioSegmentConnectionSettings
Show TwilioSegmentConnectionSettings
The Twilio Segment Data Source connection settings.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
The HTTP basic authentication settings for the Twilio Segment Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.See HttpBasicAuthSettings
The additional columns for the table in Propel.See TwilioSegmentDataSourceColumn
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s
timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsThe primary timestamp column, if any.
The webhook URL that Twilio Segment should POST events to.
Show WebhookConnectionSettings
Show WebhookConnectionSettings
The Webhook Data Source connection settings.
Enables or disables access control for the Data Pool.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.See HttpBasicAuthSettings
The additional columns for the table in Propel.See WebhookDataSourceColumn
Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a
default will be chosen based on the Data Pool’s
timestamp and uniqueId values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsThe primary timestamp column, if any.
The Webhook URL for posting JSON events
Show Deprecated Fields
Show Deprecated Fields
The tenant ID column, if any.deprecated: Will be removed; use Data Pool Access Policies instead.
The unique ID column, if any. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated.deprecated: Will be removed; use Table Settings to define the primary key.
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).
Show DataSourceCheckStatus
Show DataSourceCheckStatus
The status of a Data Source Check.
NOT_STARTED: The Check has not started.SUCCEEDED: The Check succeeded.FAILED: The Check failed.
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
Show Deprecated Fields
Show Deprecated Fields
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).
Show DataSourceCheckStatus
Show DataSourceCheckStatus
The status of a Data Source Check.
NOT_STARTED: The Check has not started.SUCCEEDED: The Check succeeded.FAILED: The Check failed.
The time at which the Data Source Check was performed.
TableIntrospection
The table introspection object. When setting up a Data Source, Propel may need to introspect tables in order to determine what tables and columns are available to create Data Pools from. The table introspection represents the lifecycle of this operation (whether it’s in-progress, succeeded, or failed) and the resulting tables and columns. These will be captured as table and column objects, respectively.The Data Source the table introspection was performed for.
See DataSource
The status of the table introspection.
Show TableIntrospectionStatus
Show TableIntrospectionStatus
The status of a table introspection.
NOT_STARTED: The table introspection has not started.STARTED: The table introspection has started.SUCCEEDED: The table introspection succeeded.FAILED: The table introspection failed.
The table introspection’s creation date and time in UTC.
The table introspection’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.
The table introspection’s last modification date and time in UTC.
The table introspection’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.
The number of tables introspected.
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.
Show ColumnEdge
Show ColumnEdge
The column connection’s nodes.
Show Column
Show Column
The column object.Once a table introspection succeeds, it creates a new table object for every table it introspected. Within each table object, it also creates a column object for every column it introspected.
The column’s name.
The column’s type.
Whether the column is nullable, meaning whether it accepts a null value.
The time at which the column was cached (i.e., the time at which it was introspected).
The time at which the column was created. This is the same as its
cachedAt time.The column’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.
This is the suggested Data Pool column type to use when converting this Data Source column to a Data Pool column.
Propel makes this suggestion based on the Data Source column type. If the Data Source column type is unsupported, this field returns
null.Sometimes, you know better which Data Pool column type to convert to. In these cases, you can refer
to supportedDataPoolColumnTypes for the full set of supported conversions.See ColumnTypeThis is the set of supported Data Pool column types you can use when converting this Data Source column to a Data Pool column. If the Data Source column type is unsupported, this field returns an empty array.For example, a numeric Data Source column type could be converted to a narrower or wider numeric Data Pool column type; a string-valued Data Source column type could be mapped to a date or timestamp Data Pool column type.See ColumnType
Show Deprecated Fields
Show Deprecated Fields
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
The column 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 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.
Show ColumnEdge
Show ColumnEdge
The column connection’s nodes.
Show Column
Show Column
The column object.Once a table introspection succeeds, it creates a new table object for every table it introspected. Within each table object, it also creates a column object for every column it introspected.
The column’s name.
The column’s type.
Whether the column is nullable, meaning whether it accepts a null value.
The time at which the column was cached (i.e., the time at which it was introspected).
The time at which the column was created. This is the same as its
cachedAt time.The column’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.
This is the suggested Data Pool column type to use when converting this Data Source column to a Data Pool column.
Propel makes this suggestion based on the Data Source column type. If the Data Source column type is unsupported, this field returns
null.Sometimes, you know better which Data Pool column type to convert to. In these cases, you can refer
to supportedDataPoolColumnTypes for the full set of supported conversions.See ColumnTypeThis is the set of supported Data Pool column types you can use when converting this Data Source column to a Data Pool column. If the Data Source column type is unsupported, this field returns an empty array.For example, a numeric Data Source column type could be converted to a narrower or wider numeric Data Pool column type; a string-valued Data Source column type could be mapped to a date or timestamp Data Pool column type.See ColumnType
Show Deprecated Fields
Show Deprecated Fields
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
The column 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 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.
Show ColumnEdge
Show ColumnEdge
The column connection’s nodes.
Show Column
Show Column
The column object.Once a table introspection succeeds, it creates a new table object for every table it introspected. Within each table object, it also creates a column object for every column it introspected.
The column’s name.
The column’s type.
Whether the column is nullable, meaning whether it accepts a null value.
The time at which the column was cached (i.e., the time at which it was introspected).
The time at which the column was created. This is the same as its
cachedAt time.The column’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.
This is the suggested Data Pool column type to use when converting this Data Source column to a Data Pool column.
Propel makes this suggestion based on the Data Source column type. If the Data Source column type is unsupported, this field returns
null.Sometimes, you know better which Data Pool column type to convert to. In these cases, you can refer
to supportedDataPoolColumnTypes for the full set of supported conversions.See ColumnTypeThis is the set of supported Data Pool column types you can use when converting this Data Source column to a Data Pool column. If the Data Source column type is unsupported, this field returns an empty array.For example, a numeric Data Source column type could be converted to a narrower or wider numeric Data Pool column type; a string-valued Data Source column type could be mapped to a date or timestamp Data Pool column type.See ColumnType
Show Deprecated Fields
Show Deprecated Fields
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
The column 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.
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
Column
The column object. Once a table introspection succeeds, it creates a new table object for every table it introspected. Within each table object, it also creates a column object for every column it introspected.The column’s name.
The column’s type.
Whether the column is nullable, meaning whether it accepts a null value.
The time at which the column was cached (i.e., the time at which it was introspected).
The time at which the column was created. This is the same as its
cachedAt time.The column’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.
This is the suggested Data Pool column type to use when converting this Data Source column to a Data Pool column.
Propel makes this suggestion based on the Data Source column type. If the Data Source column type is unsupported, this field returns
null.Sometimes, you know better which Data Pool column type to convert to. In these cases, you can refer
to supportedDataPoolColumnTypes for the full set of supported conversions.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.
This is the set of supported Data Pool column types you can use when converting this Data Source column to a Data Pool column. If the Data Source column type is unsupported, this field returns an empty array.For example, a numeric Data Source column type could be converted to a narrower or wider numeric Data Pool column type; a string-valued Data Source column type could be mapped to a date or timestamp Data Pool column type.
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.
Show Deprecated Fields
Show Deprecated Fields
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
Information about the column obtained from Snowflake.deprecated: This is Snowflake-specific, and will be removed
InternalConnectionSettings
SnowflakeConnectionSettings
The Snowflake Data Source connection settings.The Snowflake account. This is the part before the “snowflakecomputing.com” part of your Snowflake URL.
The Snowflake database name.
The Snowflake warehouse name. It should be “PROPELLING” if you used the default name in the setup script.
The Snowflake schema.
The Snowflake username. It should be “PROPEL” if you used the default name in the setup script.
The Snowflake role. It should be “PROPELLER” if you used the default name in the setup script.
HttpBasicAuthSettings
The HTTP Basic authentication settings.Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.
Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.
HttpDataSourceTable
An HTTP Data Source’s table.The ID of the table
The name of the table
All the columns present in the table
Show HttpDataSourceColumn
Show HttpDataSourceColumn
A column in an HTTP Data Source’s table.
The column name. It has to be unique within a table.
The column type.
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 to use when
type is set to CLICKHOUSE.Whether the column’s type is nullable or not.
HttpDataSourceColumn
A column in an HTTP Data Source’s table.The column name. It has to be unique within a table.
The column type.
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 to use when
type is set to CLICKHOUSE.Whether the column’s type is nullable or not.
S3DataSourceTable
An Amazon S3 Data Source’s table.The ID of the table
The name of the table
The path to the table’s files in Amazon S3.
All the columns present in the table
Show S3DataSourceColumn
Show S3DataSourceColumn
A column in an Amazon S3 Data Source’s table.
The column name.
The column type.
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.
Whether the column’s type is nullable or not.
S3DataSourceColumn
A column in an Amazon S3 Data Source’s table.The column name.
The column type.
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.
Whether the column’s type is nullable or not.
AmazonDataFirehoseDataSourceColumn
A column in an Amazon Data Firehose Data Source’s table.The column name.
The JSON property that the column will be derived from. For example, if you send a JSON event like this:Then you can use the JSON property “greeting.message” to extract “hello, world” to a column.
Copy
{ "greeting": { "message": "hello, world" } }
The column type.
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.
Whether the column’s type is nullable or not.
AmazonDynamoDBDataSourceColumn
A column in an Amazon DynamoDB Data Source’s table.The column name.
The JSON property that the column will be derived from. For example, if you send a JSON event like this:Then you can use the JSON property “greeting.message” to extract “hello, world” to a column.
Copy
{ "greeting": { "message": "hello, world" } }
The column type.
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.
Whether the column’s type is nullable or not.
TwilioSegmentDataSourceColumn
A column in a Twilio Segment Data Source’s table.The column name.
The JSON property that the column will be derived from. For example, if you POST a JSON event like this:Then you can use the JSON property “greeting.message” to extract “hello, world” to a column.
Copy
{ "greeting": { "message": "hello, world" } }
The column type.
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.
Whether the column’s type is nullable or not.
WebhookDataSourceColumn
A column in a Webhook Data Source’s table.The column name.
The JSON property that the column will be derived from. For example, if you POST a JSON event like this:Then you can use the JSON property “greeting.message” to extract “hello, world” to a column.
Copy
{ "greeting": { "message": "hello, world" } }
The column type.
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.
Whether the column’s type is nullable or not.
DataSourceResponse
The result of a mutation which creates or modifies a Data Source.The Data Source which was created or modified.
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
DataPool
The Data Pool object. Data Pools are Propel’s high-speed data store and cacheThe 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.
Show DataPoolColumnEdge
Show DataPoolColumnEdge
The Data Pool column edge object.Learn more about pagination in GraphQL.
The edge’s cursor.
The edge’s node.See DataPoolColumn
The Data Pool column connection’s nodes.
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 column 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 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.
Show DataPoolColumnEdge
Show DataPoolColumnEdge
The Data Pool column edge object.Learn more about pagination in GraphQL.
The edge’s cursor.
The edge’s node.See DataPoolColumn
The Data Pool column connection’s nodes.
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 column 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.
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).
Show DataPoolSetupTaskStatus
Show DataPoolSetupTaskStatus
The status of a Data Pool Setup Task.
NOT_STARTED: The Data Pool Setup Task has not been started yet.SUCCEEDED: The Data Pool Setup Task has completed successfully.FAILED: The Data Pool Setup Task has failed.
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.
Show DataPoolSyncStatus
Show DataPoolSyncStatus
The Data Pool Sync Status. It indicates whether a Data Pool is syncing data or not.
ENABLED: Syncing is enabled for the Data Pool.DISABLING: Propel is disabling syncing for the Data Pool.DISABLED: Syncing is disabled for the Data Pool.
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.Show DataPoolSyncInterval
Show DataPoolSyncInterval
The available Data Pool sync intervals. Specify unit of time between attempts to sync data from your data warehouse.Note that the syncing interval is approximate. For example, setting the syncing interval to
EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.EVERY_1_MINUTEEVERY_5_MINUTESEVERY_15_MINUTESEVERY_30_MINUTESEVERY_1_HOUREVERY_4_HOURSEVERY_12_HOURSEVERY_24_HOURS
The 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.
Show TableEngine
Show TableEngine
A Data Pool’s table engine.
TableEngine
MergeTreeTableEngine | ReplacingMergeTreeTableEngine | SummingMergeTreeTableEngine | AggregatingMergeTreeTableEngine | PostgreSqlTableEngine
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.
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. 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.
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. 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.
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. 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.
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.
Show TableEngine
Show TableEngine
A Data Pool’s table engine.
TableEngine
MergeTreeTableEngine | ReplacingMergeTreeTableEngine | SummingMergeTreeTableEngine | AggregatingMergeTreeTableEngine | PostgreSqlTableEngine
Show MergeTreeTableEngine
Show MergeTreeTableEngine
Parameters for the MergeTree table engine.
The type is always
MERGE_TREE.See TableEngineTypeShow ReplacingMergeTreeTableEngine
Show ReplacingMergeTreeTableEngine
Parameters for the ReplacingMergeTree table engine.
The type is always
REPLACING_MERGE_TREE.See TableEngineTypeThe
ver parameter to the ReplacingMergeTree engine.Show SummingMergeTreeTableEngine
Show SummingMergeTreeTableEngine
Parameters for the SummingMergeTree table engine.
The type is always
SUMMING_MERGE_TREE.See TableEngineTypeThe columns argument for the SummingMergeTree table engine
Show AggregatingMergeTreeTableEngine
Show AggregatingMergeTreeTableEngine
Parameters for the AggregatingMergeTree table engine.
The type is always
AGGREGATING_MERGE_TREE.See TableEngineTypeShow PostgreSqlTableEngine
Show PostgreSqlTableEngine
Parameters for the PostgreSQL table engine.
The type is always
POSTGRESQL.See TableEngineTypeThe 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.
MergeTreeTableEngine
Parameters for the MergeTree table engine.The type is always
MERGE_TREE.Show TableEngineType
Show TableEngineType
ClickHouse table engine types.
MERGE_TREE: The MergeTree table engine.REPLACING_MERGE_TREE: The ReplacingMergeTree table engine.SUMMING_MERGE_TREE: The SummingMergeTree table engine.AGGREGATING_MERGE_TREE: The AggregatingMergeTree table engine.POSTGRESQL: The PostgreSQL table engine.
ReplacingMergeTreeTableEngine
Parameters for the ReplacingMergeTree table engine.The type is always
REPLACING_MERGE_TREE.Show TableEngineType
Show TableEngineType
ClickHouse table engine types.
MERGE_TREE: The MergeTree table engine.REPLACING_MERGE_TREE: The ReplacingMergeTree table engine.SUMMING_MERGE_TREE: The SummingMergeTree table engine.AGGREGATING_MERGE_TREE: The AggregatingMergeTree table engine.POSTGRESQL: The PostgreSQL table engine.
The
ver parameter to the ReplacingMergeTree engine.SummingMergeTreeTableEngine
Parameters for the SummingMergeTree table engine.The type is always
SUMMING_MERGE_TREE.Show TableEngineType
Show TableEngineType
ClickHouse table engine types.
MERGE_TREE: The MergeTree table engine.REPLACING_MERGE_TREE: The ReplacingMergeTree table engine.SUMMING_MERGE_TREE: The SummingMergeTree table engine.AGGREGATING_MERGE_TREE: The AggregatingMergeTree table engine.POSTGRESQL: The PostgreSQL table engine.
The columns argument for the SummingMergeTree table engine
AggregatingMergeTreeTableEngine
Parameters for the AggregatingMergeTree table engine.The type is always
AGGREGATING_MERGE_TREE.Show TableEngineType
Show TableEngineType
ClickHouse table engine types.
MERGE_TREE: The MergeTree table engine.REPLACING_MERGE_TREE: The ReplacingMergeTree table engine.SUMMING_MERGE_TREE: The SummingMergeTree table engine.AGGREGATING_MERGE_TREE: The AggregatingMergeTree table engine.POSTGRESQL: The PostgreSQL table engine.
PostgreSqlTableEngine
Parameters for the PostgreSQL table engine.The type is always
POSTGRESQL.Show TableEngineType
Show TableEngineType
ClickHouse table engine types.
MERGE_TREE: The MergeTree table engine.REPLACING_MERGE_TREE: The ReplacingMergeTree table engine.SUMMING_MERGE_TREE: The SummingMergeTree table engine.AGGREGATING_MERGE_TREE: The AggregatingMergeTree table engine.POSTGRESQL: The PostgreSQL table engine.
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).
Show DataPoolSetupTaskStatus
Show DataPoolSetupTaskStatus
The status of a Data Pool Setup Task.
NOT_STARTED: The Data Pool Setup Task has not been started yet.SUCCEEDED: The Data Pool Setup Task has completed successfully.FAILED: The Data Pool Setup Task has failed.
The time at which the Data Pool Setup Task was completed.
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 stats
Show DimensionStatistics
Show DimensionStatistics
Statistics about a particular Dimension.
The minimum value of the Dimension.
The maximum value of the Dimension.
The average value of the Dimension. Empty for non-numeric Dimensions.
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.
DimensionStatistics
Statistics about a particular Dimension.The minimum value of the Dimension.
The maximum value of the Dimension.
The average value of the Dimension. Empty for non-numeric Dimensions.
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 Propeller used for this query.
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 Query status.
Show QueryStatus
Show QueryStatus
The Query status.
COMPLETED: The Query was completed succesfully.ERROR: The Query experienced an error.TIMED_OUT: The Query timed out.
The Query type.
Show QueryType
Show QueryType
The Query type.
METRIC: Indicates a Metric Query.STATS: Indicates a Dimension Stats Query.REPORT: Indicates a Report Query.RECORDS: Indicates a Record Table Query.RECORDS_BY_UNIQUE_ID: Indicates records queried by unique ID.SQL: Indicates a SQL Query.TOP_VALUES: Indicates a Top Values Query.
The Query subtype.
Show QuerySubtype
Show QuerySubtype
The Query subtype.
COUNTER: Indicates a Metric counter Query.TIME_SERIES: Indicates a Metric time series Query.LEADERBOARD: Indicates a Metric leaderboard Query.
The SQL the query executed.
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 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.
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 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.
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 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.
MaterializedViewResponse
The result of a mutation which creates or modifies a Materialized View.The Materialized View which was created or modified.
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
Filter
The fields of a filter. You can construct more complex filters usingand and or. For example, to construct a filter equivalent to
Copy
(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.
Show FilterOperator
Show FilterOperator
The available Filter operators.
EQUALS: Selects values that are equal to the specified value.NOT_EQUALS: Selects values that are not equal to the specified value.GREATER_THAN: Selects values that are greater than the specified value.GREATER_THAN_OR_EQUAL_TO: Selects values that are greater or equal to the specified value.LESS_THAN: Selects values that are less than the specified value.LESS_THAN_OR_EQUAL_TO: Selects values that are less or equal to the specified value.IS_NULL: Selects values that are null. This operator does not accept a value.IS_NOT_NULL: Selects values that are not null. This operator does not accept a value.LIKE: Selects values that match the specified pattern.NOT_LIKE: “Selects values that do not match the specified pattern.
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.
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.
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.
Tenant
A Data Pool’s tenant ID column. The tenant ID column is used to control access to your data with access policies.The name of the column that represents the tenant ID.
The tenant ID column’s type.
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.
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.
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. 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 insteadDataPoolResponse
The result of a mutation which creates or modifies a Data Pool.The Data Pool which was created or modified.
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.
DataPoolSyncing
Settings related to Data Pool syncing.Indicates whether syncing is enabled or disabled.
Show DataPoolSyncStatus
Show DataPoolSyncStatus
The Data Pool Sync Status. It indicates whether a Data Pool is syncing data or not.
ENABLED: Syncing is enabled for the Data Pool.DISABLING: Propel is disabling syncing for the Data Pool.DISABLED: Syncing is disabled for the Data Pool.
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.Show DataPoolSyncInterval
Show DataPoolSyncInterval
The available Data Pool sync intervals. Specify unit of time between attempts to sync data from your data warehouse.Note that the syncing interval is approximate. For example, setting the syncing interval to
EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.EVERY_1_MINUTEEVERY_5_MINUTESEVERY_15_MINUTESEVERY_30_MINUTESEVERY_1_HOUREVERY_4_HOURSEVERY_12_HOURSEVERY_24_HOURS
The date and time of the most recent Sync in UTC.
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 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
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 insteadMetricReportConnection
The Metric Report connection object. It includesheaders 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 Metric Report edge object.
The edge’s node.
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.
The edge’s cursor.
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 Propeller used for this query.
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 Query status.
Show QueryStatus
Show QueryStatus
The Query status.
COMPLETED: The Query was completed succesfully.ERROR: The Query experienced an error.TIMED_OUT: The Query timed out.
The Query type.
Show QueryType
Show QueryType
The Query type.
METRIC: Indicates a Metric Query.STATS: Indicates a Dimension Stats Query.REPORT: Indicates a Report Query.RECORDS: Indicates a Record Table Query.RECORDS_BY_UNIQUE_ID: Indicates records queried by unique ID.SQL: Indicates a SQL Query.TOP_VALUES: Indicates a Top Values Query.
The Query subtype.
Show QuerySubtype
Show QuerySubtype
The Query subtype.
COUNTER: Indicates a Metric counter Query.TIME_SERIES: Indicates a Metric time series Query.LEADERBOARD: Indicates a Metric leaderboard Query.
The SQL the query executed.
MetricReportEdge
The Metric Report edge object.The edge’s node.
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.
The edge’s cursor.
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.
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 stats
Show DimensionStatistics
Show DimensionStatistics
Statistics about a particular Dimension.
The minimum value of the Dimension.
The maximum value of the Dimension.
The average value of the Dimension. Empty for non-numeric Dimensions.
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 stats
Show DimensionStatistics
Show DimensionStatistics
Statistics about a particular Dimension.
The minimum value of the Dimension.
The maximum value of the Dimension.
The average value of the Dimension. Empty for non-numeric Dimensions.
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 CountMetricSettings
Show CountMetricSettings
Settings for Count Metrics.
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.You can provide the filters in the form of SQL.Show Deprecated Fields
Show Deprecated Fields
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.deprecated: Use filterSql insteadSee FilterShow SumMetricSettings
Show SumMetricSettings
Settings for Sum Metrics.
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.You can provide the filters in the form of SQL.Show Deprecated Fields
Show Deprecated Fields
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.deprecated: Use filterSql insteadSee FilterShow CountDistinctMetricSettings
Show CountDistinctMetricSettings
Settings for Count Distinct Metrics.
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.You can provide the filters in the form of SQL.The Dimension where the count distinct operation is going to be performed.See Dimension
Show Deprecated Fields
Show Deprecated Fields
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.deprecated: Use filterSql insteadSee FilterShow AverageMetricSettings
Show AverageMetricSettings
Settings for Average Metrics.
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.You can provide the filters in the form of SQL.Show Deprecated Fields
Show Deprecated Fields
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.deprecated: Use filterSql insteadSee FilterShow MinMetricSettings
Show MinMetricSettings
Settings for Min Metrics.
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.You can provide the filters in the form of SQL.Show Deprecated Fields
Show Deprecated Fields
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.deprecated: Use filterSql insteadSee FilterShow MaxMetricSettings
Show MaxMetricSettings
Settings for Max Metrics.
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.You can provide the filters in the form of SQL.Show Deprecated Fields
Show Deprecated Fields
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.deprecated: Use filterSql insteadSee FilterShow CustomMetricSettings
Show CustomMetricSettings
Settings for Custom Metrics.
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.You can provide the filters in the form of SQL.The expression that defines the aggregation function for this Metric.
Show Deprecated Fields
Show Deprecated Fields
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.deprecated: Use filterSql insteadSee FilterShow 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 stats
Show DimensionStatistics
Show DimensionStatistics
Statistics about a particular Dimension.
The minimum value of the Dimension.
The maximum value of the Dimension.
The average value of the Dimension. Empty for non-numeric Dimensions.
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.
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.
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.
Query 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.
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.
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.
Query 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.
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.
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.
Whether or not access control is enabled for the Metric.deprecated: Use Data Pool Access Policies instead
CountMetricSettings
Settings for Count Metrics.Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.You can provide the filters in the form of SQL.Show Deprecated Fields
Show Deprecated Fields
Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Metric Filters are present, all records will be included. To filter at query time, add Dimensions and use the
filters property on the timeSeriesInput, counterInput, or leaderboardInput objects. There is no need to add filters to be able to filter at query time.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.
Show FilterOperator
Show FilterOperator
The available Filter operators.
EQUALS: Selects values that are equal to the specified value.NOT_EQUALS: Selects values that are not equal to the specified value.GREATER_THAN: Selects values that are greater than the specified value.GREATER_THAN_OR_EQUAL_TO: Selects values that are greater or equal to the specified value.LESS_THAN: Selects values that are less than the specified value.LESS_THAN_OR_EQUAL_TO: Selects values that are less or equal to the specified value.IS_NULL: Selects values that are null. This operator does not accept a value.IS_NOT_NULL: Selects values that are not null. This operator does not accept a value.LIKE: Selects values that match the specified pattern.NOT_LIKE: “Selects values that do not match the specified pattern.
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.