Unions

Union types in the Management API

ApplicationOrFailureResponse

The result of a mutation which creates or modifies an Application.

If successful, an ApplicationResponse will be returned; otherwise, a FailureResponse will be returned.

ApplicationOrFailureResponse · ApplicationResponse | FailureResponse

Show ApplicationResponse

The result of a mutation which creates or modifies an Application.

application · Application

The Application which was created or modified.

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.

id · ID · required

The Application’s unique identifier.

uniqueName · String · required

The Application’s unique name.

description · String · required

The Application’s description.

account · Account · required

The Application’s Account.

See Account

environment · Environment · required

The Application’s Environment.

See Environment

createdAt · DateTime · required

The Application’s creation date and time in UTC.

modifiedAt · DateTime · required

The Application’s last modification date and time in UTC.

createdBy · String · required

The Application’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Application’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

clientId · String · required

The Application’s OAuth 2.0 client identifier.

secret · String

The Application’s OAuth 2.0 client secret.

propeller · Propeller · required

The Application’s Propeller.

See Propeller

scopes · [ApplicationScope!] · required

The Application’s OAuth 2.0 scopes.

See ApplicationScope

dataPoolAccessPolicies · DataPoolAccessPolicyConnection · required

A paginated list of Data Pool Access Policies associated with the Application.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolAccessPolicyConnection

Show Deprecated Fields

policies · PolicyConnection · required · deprecated

A paginated list of Policies associated with the Application.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

ConnectionSettings

ConnectionSettings · SnowflakeConnectionSettings | InternalConnectionSettings | AmazonDataFirehoseConnectionSettings | AmazonDynamoDBConnectionSettings | ClickHouseConnectionSettings | HttpConnectionSettings | KafkaConnectionSettings | PostgreSqlConnectionSettings | S3ConnectionSettings | TwilioSegmentConnectionSettings | WebhookConnectionSettings

Show SnowflakeConnectionSettings

The Snowflake Data Source connection settings.

account · String · required

The Snowflake account. This is the part before the “snowflakecomputing.com” part of your Snowflake URL.

database · String · required

The Snowflake database name.

warehouse · String · required

The Snowflake warehouse name. It should be “PROPELLING” if you used the default name in the setup script.

schema · String · required

The Snowflake schema.

username · String · required

The Snowflake username. It should be “PROPEL” if you used the default name in the setup script.

role · String · required

The Snowflake role. It should be “PROPELLER” if you used the default name in the setup script.

Show InternalConnectionSettings

_ · Boolean

Show AmazonDataFirehoseConnectionSettings

The Amazon Data Firehose Data Source’s connection settings.

accessControlEnabled · Boolean

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.

basicAuth · HttpBasicAuthSettings · required

HTTP basic access authentication credentials. You must configure these same credentials to be included in the X-Amz-Firehose-Access-Key header when Amazon Data Firehose issues requests to its custom HTTP endpoint.

Show HttpBasicAuthSettings

The HTTP Basic authentication settings.

username · String · required

Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

password · String · required

Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

columns · [AmazonDataFirehoseDataSourceColumn!]

Additional columns for the table in Propel.

Show AmazonDataFirehoseDataSourceColumn

A column in an Amazon Data Firehose Data Source’s table.

name · String · required

The column name.

jsonProperty · String · required

The JSON property that the column will be derived from. For example, if you send a JSON event like this:

{ "greeting": { "message": "hello, world" } }

Then you can use the JSON property “greeting.message” to extract “hello, world” to a column.

type · ColumnType · required

The column type.

See ColumnType

nullable · Boolean · required

Whether the column’s type is nullable or not.

httpEndpointURL · String · required

Copy this value into the URL field when configuring your Amazon Data Firehose to deliver to a custom HTTP endpoint.

tableSettings · TableSettings

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp value, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

timestamp · String

The primary timestamp column, if any.

xAmzFirehoseAccessKey · String · required

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

The Amazon DynamoDB Data Source’s connection settings.

accessControlEnabled · Boolean

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.

basicAuth · HttpBasicAuthSettings · required

HTTP basic access authentication credentials. You must configure these same credentials to be included in the X-Amz-Firehose-Access-Key header when Amazon Data Firehose transmits records from your DynamoDB table to its custom HTTP endpoint.

Show HttpBasicAuthSettings

The HTTP Basic authentication settings.

username · String · required

Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

password · String · required

Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

columns · [AmazonDynamoDBDataSourceColumn!]

Additional columns for the table in Propel.

Show AmazonDynamoDBDataSourceColumn

A column in an Amazon DynamoDB Data Source’s table.

name · String · required

The column name.

jsonProperty · String · required

The JSON property that the column will be derived from. For example, if you send a JSON event like this:

{ "greeting": { "message": "hello, world" } }

Then you can use the JSON property “greeting.message” to extract “hello, world” to a column.

type · ColumnType · required

The column type.

See ColumnType

nullable · Boolean · required

Whether the column’s type is nullable or not.

httpEndpointURL · String · required

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.

tableSettings · TableSettings

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp value, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

timestamp · String

The primary timestamp column, if any.

xAmzFirehoseAccessKey · String · required

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

The ClickHouse Data Source connection settings.

database · String · required

Which database to connect to

password · String · required

The password for the provided user

readonly · Boolean

Whether the user has readonly permissions or not for querying ClickHouse

url · String · required

The URL where the ClickHouse host is listening to HTTP[S] connections

user · String · required

The user for authenticating against the ClickHouse host

Show HttpConnectionSettings

The HTTP Data Source connection settings.

basicAuth · HttpBasicAuthSettings

The HTTP Basic authentication settings for uploading new data.

If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.

Show HttpBasicAuthSettings

The HTTP Basic authentication settings.

username · String · required

Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

password · String · required

Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

tables · [HttpDataSourceTable!] · required

The HTTP Data Source’s tables.

Show HttpDataSourceTable

An HTTP Data Source’s table.

id · ID · required

The ID of the table

name · String · required

The name of the table

columns · [HttpDataSourceColumn!] · required

All the columns present in the table

See HttpDataSourceColumn

Show KafkaConnectionSettings

The Kafka Data Source connection settings.

auth · String · required

The type of authentication to use. Can be SCRAM-SHA-256, SCRAM-SHA-512, PLAIN or NONE

bootstrapServers · [String!] · required

The bootstrap server(s) to connect to

password · String · required

The password for the provided user

tls · Boolean

Whether the the connection to the Kafka servers is encrypted or not

user · String · required

The user for authenticating against the Kafka servers

Show PostgreSqlConnectionSettings

The PostgreSQL Data Source connection settings.

database · String

Which database to connect to

host · String · required

The host where PostgreSQL is listening

port · Int

The port where PostgreSQL is listening (usually 5432)

schema · String

Which schema to use

user · String · required

The user for authenticating against PostgreSQL

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.

awsAccessKeyId · String · required

The AWS access key ID for an IAM user with sufficient access to the Amazon S3 bucket.

bucket · String · required

The name of the Amazon S3 bucket.

tables · [S3DataSourceTable!] · required

The Amazon S3 Data Source’s tables.

Show S3DataSourceTable

An Amazon S3 Data Source’s table.

id · ID · required

The ID of the table

name · String · required

The name of the table

path · String

The path to the table’s files in Amazon S3.

columns · [S3DataSourceColumn!] · required

All the columns present in the table

See S3DataSourceColumn

Show TwilioSegmentConnectionSettings

The Twilio Segment Data Source connection settings.

accessControlEnabled · Boolean

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.

basicAuth · HttpBasicAuthSettings

The HTTP basic authentication settings for the Twilio Segment Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.

Show HttpBasicAuthSettings

The HTTP Basic authentication settings.

username · String · required

Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

password · String · required

Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

columns · [TwilioSegmentDataSourceColumn!]

The additional columns for the table in Propel.

Show TwilioSegmentDataSourceColumn

A column in a Twilio Segment Data Source’s table.

name · String · required

The column name.

jsonProperty · String · required

The JSON property that the column will be derived from. For example, if you POST a JSON event like this:

{ "greeting": { "message": "hello, world" } }

Then you can use the JSON property “greeting.message” to extract “hello, world” to a column.

type · ColumnType · required

The column type.

See ColumnType

nullable · Boolean · required

Whether the column’s type is nullable or not.

tableSettings · TableSettings

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

timestamp · String

The primary timestamp column, if any.

webhookUrl · String · required

The webhook URL that Twilio Segment should POST events to.

Show WebhookConnectionSettings

The Webhook Data Source connection settings.

accessControlEnabled · Boolean

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.

basicAuth · HttpBasicAuthSettings

The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.

Show HttpBasicAuthSettings

The HTTP Basic authentication settings.

username · String · required

Username for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

password · String · required

Password for HTTP Basic authentication that must be included in the Authorization header when uploading new data.

columns · [WebhookDataSourceColumn!]

The additional columns for the table in Propel.

Show WebhookDataSourceColumn

A column in a Webhook Data Source’s table.

name · String · required

The column name.

jsonProperty · String · required

The JSON property that the column will be derived from. For example, if you POST a JSON event like this:

{ "greeting": { "message": "hello, world" } }

Then you can use the JSON property “greeting.message” to extract “hello, world” to a column.

type · ColumnType · required

The column type.

See ColumnType

nullable · Boolean · required

Whether the column’s type is nullable or not.

tableSettings · TableSettings

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

timestamp · String

The primary timestamp column, if any.

webhookUrl · String · required

The Webhook URL for posting JSON events

Show Deprecated Fields

tenant · String · deprecated

The tenant ID column, if any.

deprecated: Will be removed; use Data Pool Access Policies instead.

uniqueId · String · deprecated

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.

DataSourceOrFailureResponse

The result of a mutation which creates or modifies a DataSource.

If successful, an DataSourceResponse will be returned; otherwise, a FailureResponse will be returned.

DataSourceOrFailureResponse · DataSourceResponse | FailureResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the 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

first · Int

after · String

last · Int

before · String

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

TableEngine

A Data Pool’s table engine.

TableEngine · MergeTreeTableEngine | ReplacingMergeTreeTableEngine | SummingMergeTreeTableEngine | AggregatingMergeTreeTableEngine | PostgreSqlTableEngine

Show MergeTreeTableEngine

Parameters for the MergeTree table engine.

type · TableEngineType · required

The type is always MERGE_TREE.

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.

Show ReplacingMergeTreeTableEngine

Parameters for the ReplacingMergeTree table engine.

type · TableEngineType · required

The type is always REPLACING_MERGE_TREE.

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.

ver · String

The ver parameter to the ReplacingMergeTree engine.

Show SummingMergeTreeTableEngine

Parameters for the SummingMergeTree table engine.

type · TableEngineType · required

The type is always SUMMING_MERGE_TREE.

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.

columns · [String!]

The columns argument for the SummingMergeTree table engine

Show AggregatingMergeTreeTableEngine

Parameters for the AggregatingMergeTree table engine.

type · TableEngineType · required

The type is always AGGREGATING_MERGE_TREE.

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.

Show PostgreSqlTableEngine

Parameters for the PostgreSQL table engine.

type · TableEngineType · required

The type is always POSTGRESQL.

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.

DataPoolOrFailureResponse

The result of a mutation which creates or modifies a Data Pool.

If successful, an DataPoolResponse will be returned; otherwise, a FailureResponse will be returned.

DataPoolOrFailureResponse · DataPoolResponse | FailureResponse

Show DataPoolResponse

The result of a mutation which creates or modifies a Data Pool.

dataPool · DataPool

The Data Pool which was created or modified.

Show DataPool

The Data Pool object. Data Pools are Propel’s high-speed data store and cache

id · ID · required

The Data Pool’s unique identifier.

uniqueName · String · required

The Data Pool’s unique name.

description · String · required

The Data Pool’s description.

account · Account · required

The Data Pool’s Account.

See Account

environment · Environment · required

The Data Pool’s Environment.

See Environment

createdAt · DateTime · required

The Data Pool’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool’s last modification date and time in UTC.

createdBy · String · required

The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataSource · DataSource · required

The Data Pool’s Data Source. See DataSource

status · DataPoolStatus · required

The Data Pool’s status.

See DataPoolStatus

dataRetentionInDays · Int · required

The Data Pool’s data retention in days (not yet supported).

table · String · required

The name of the Data Pool’s table.

timestamp · Timestamp

The Data Pool’s primary timestamp column, if any.

See Timestamp

recordCount · String

The number of records in the Data Pool.

sizeInTerabytes · Float

The amount of storage in terabytes used by the Data Pool.

columns · DataPoolColumnConnection

The Data Pool’s columns.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolColumnConnection

availableMeasures · DataPoolColumnConnection

The list of measures (numeric columns) in the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolColumnConnection

setupTasks · [DataPoolSetupTask!]

A list of setup tasks performed on the Data Pool during its most recent setup attempt.

See DataPoolSetupTask

syncing · DataPoolSyncing · required

Settings related to Data Pool syncing.

See DataPoolSyncing

syncs · SyncConnection

The list of Syncs of the Data Pool.

Arguments

filter · SyncsFilter

See SyncsFilter

first · Int

after · String

last · Int

before · String

See SyncConnection

metrics · MetricConnection

The list of Metrics powered by the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See MetricConnection

deletionJobs · DeletionJobConnection

The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See DeletionJobConnection

addColumnToDataPoolJobs · AddColumnToDataPoolJobConnection

The Add Column Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See AddColumnToDataPoolJobConnection

updateDataPoolRecordsJobs · UpdateDataPoolRecordsJobConnection

The UpdateDataPoolRecords Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See UpdateDataPoolRecordsJobConnection

accessControlEnabled · Boolean · required

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.

dataPoolAccessPolicies · DataPoolAccessPolicyConnection · required

A paginated list of Data Pool Access Policies available on the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolAccessPolicyConnection

validateExpression · ValidateExpressionResult · required

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

expression · String · required

See ValidateExpressionResult

tableSettings · TableSettings · required

The Data Pool’s table settings.

See TableSettings

partitionByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PARTITION BY clause.

See DataPoolColumn

primaryKeyColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PRIMARY KEY clause.

See DataPoolColumn

orderByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its ORDER BY clause.

See DataPoolColumn

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to setupTasks instead

See Error

tenant · Tenant · deprecated

The Data Pool’s tenant ID, if configured.

deprecated: Will be removed; use Data Pool Access Policies instead

See Tenant

uniqueId · UniqueId · deprecated

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

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

MetricSettings

A Metric’s settings, depending on its type.

MetricSettings · CountMetricSettings | SumMetricSettings | CountDistinctMetricSettings | AverageMetricSettings | MinMetricSettings | MaxMetricSettings | CustomMetricSettings

Show CountMetricSettings

Settings for Count Metrics.

filterSql · String

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

filters · [Filter!] · deprecated

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 instead

Show Filter

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [Filter!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [Filter!]

Additional filters to OR with this one. AND takes precedence over OR.

Show SumMetricSettings

Settings for Sum Metrics.

filterSql · String

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.

measure · Dimension · required

The Dimension to be summed.

Show Dimension

The Dimension object that represents a column in a table.

columnName · String · required

The column name it represents.

type · String · required

The column data type.

isNullable · Boolean

Whether the column is nullable.

Show Deprecated Fields

isUniqueKey · Boolean · deprecated

Whether the column is a unique key.

deprecated: This is Snowflake-specific, and will be removed

stats · DimensionStatistics · deprecated

The statistics for the dimension values. Fetching statistics incurs query costs.

deprecated: Issue normal queries for calculating stats

See DimensionStatistics

Show Deprecated Fields

filters · [Filter!] · deprecated

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 instead

Show Filter

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [Filter!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [Filter!]

Additional filters to OR with this one. AND takes precedence over OR.

Show CountDistinctMetricSettings

Settings for Count Distinct Metrics.

filterSql · String

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.

dimension · Dimension · required

The Dimension where the count distinct operation is going to be performed.

Show Dimension

The Dimension object that represents a column in a table.

columnName · String · required

The column name it represents.

type · String · required

The column data type.

isNullable · Boolean

Whether the column is nullable.

Show Deprecated Fields

isUniqueKey · Boolean · deprecated

Whether the column is a unique key.

deprecated: This is Snowflake-specific, and will be removed

stats · DimensionStatistics · deprecated

The statistics for the dimension values. Fetching statistics incurs query costs.

deprecated: Issue normal queries for calculating stats

See DimensionStatistics

Show Deprecated Fields

filters · [Filter!] · deprecated

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 instead

Show Filter

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [Filter!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [Filter!]

Additional filters to OR with this one. AND takes precedence over OR.

Show AverageMetricSettings

Settings for Average Metrics.

filterSql · String

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.

measure · Dimension · required

The Dimension to be averaged.

Show Dimension

The Dimension object that represents a column in a table.

columnName · String · required

The column name it represents.

type · String · required

The column data type.

isNullable · Boolean

Whether the column is nullable.

Show Deprecated Fields

isUniqueKey · Boolean · deprecated

Whether the column is a unique key.

deprecated: This is Snowflake-specific, and will be removed

stats · DimensionStatistics · deprecated

The statistics for the dimension values. Fetching statistics incurs query costs.

deprecated: Issue normal queries for calculating stats

See DimensionStatistics

Show Deprecated Fields

filters · [Filter!] · deprecated

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 instead

Show Filter

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [Filter!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [Filter!]

Additional filters to OR with this one. AND takes precedence over OR.

Show MinMetricSettings

Settings for Min Metrics.

filterSql · String

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.

measure · Dimension · required

The Dimension to select the minimum from.

Show Dimension

The Dimension object that represents a column in a table.

columnName · String · required

The column name it represents.

type · String · required

The column data type.

isNullable · Boolean

Whether the column is nullable.

Show Deprecated Fields

isUniqueKey · Boolean · deprecated

Whether the column is a unique key.

deprecated: This is Snowflake-specific, and will be removed

stats · DimensionStatistics · deprecated

The statistics for the dimension values. Fetching statistics incurs query costs.

deprecated: Issue normal queries for calculating stats

See DimensionStatistics

Show Deprecated Fields

filters · [Filter!] · deprecated

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 instead

Show Filter

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [Filter!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [Filter!]

Additional filters to OR with this one. AND takes precedence over OR.

Show MaxMetricSettings

Settings for Max Metrics.

filterSql · String

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.

measure · Dimension · required

The Dimension to select the maximum from.

Show Dimension

The Dimension object that represents a column in a table.

columnName · String · required

The column name it represents.

type · String · required

The column data type.

isNullable · Boolean

Whether the column is nullable.

Show Deprecated Fields

isUniqueKey · Boolean · deprecated

Whether the column is a unique key.

deprecated: This is Snowflake-specific, and will be removed

stats · DimensionStatistics · deprecated

The statistics for the dimension values. Fetching statistics incurs query costs.

deprecated: Issue normal queries for calculating stats

See DimensionStatistics

Show Deprecated Fields

filters · [Filter!] · deprecated

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 instead

Show Filter

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [Filter!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [Filter!]

Additional filters to OR with this one. AND takes precedence over OR.

Show CustomMetricSettings

Settings for Custom Metrics.

filterSql · String

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.

expression · String · required

The expression that defines the aggregation function for this Metric.

Show Deprecated Fields

filters · [Filter!] · deprecated

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 instead

Show Filter

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [Filter!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [Filter!]

Additional filters to OR with this one. AND takes precedence over OR.