Available mutations in the Management API
Show EnvironmentResponse
Show Environment
Show EnvironmentResponse
Show Environment
Show CreateDataPoolAccessPolicyInput
["*"]
, all columns will be available for querying.Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show DataPoolAccessPolicyResponse
Show DataPoolAccessPolicy
Show ModifyDataPoolAccessPolicyInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show DataPoolAccessPolicyResponse
Show DataPoolAccessPolicy
accessControlEnabled
set to true, the Application
must have a Data Pool Access Policy assigned in order to query the Data Pool.An Application can have at most one Data Pool Access Policy assigned for a given Data Pool. If
an Application already has a Data Pool Access Policy for a given Data Pool, and you call this
mutation with another Data Pool Access Policy for the same Data Pool, the Application’s Data Pool Access
Policy will be replaced.accessControlEnabled
property. If
accessControlEnabled
is true, the Application will no longer be able to query the
Data Pool. If accessControlEnabled
is false, the Application will be able to query
all data in the Data Pool, unrestricted.mutation {
createApplication(
input: {
uniqueName: "example_sample_application"
description: "My dashboard app"
scopes: [DATA_POOL_QUERY]
propeller: P1_X_SMALL
}
) {
... on ApplicationResponse {
application {
id
uniqueName
}
}
... on FailureResponse {
error {
code
message
}
}
}
}
Show createApplicationInput
P1_X_SMALL
.Show Propeller
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 secondShow ApplicationScope
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 ApplicationOrFailureResponse
ApplicationResponse
will be returned; otherwise, a
FailureResponse
will be returned.Show ApplicationResponse
Show modifyApplicationInput
Show Propeller
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 secondShow ApplicationScope
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 ApplicationOrFailureResponse
ApplicationResponse
will be returned; otherwise, a
FailureResponse
will be returned.Show ApplicationResponse
Show createSnowflakeDataSourceInput
Show SnowflakeConnectionSettingsInput
Show DataSourceOrFailureResponse
DataSourceResponse
will be returned; otherwise, a
FailureResponse
will be returned.Show DataSourceResponse
Show modifySnowflakeDataSourceInput
Show PartialSnowflakeConnectionSettingsInput
Show DataSourceOrFailureResponse
DataSourceResponse
will be returned; otherwise, a
FailureResponse
will be returned.Show DataSourceResponse
Show DataSource
Show Account
Show Environment
Show DataSourceType
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.Show DataSourceStatus
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.Show ConnectionSettings
Show DataSourceCheck
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
.Show TableIntrospection
Show TableIntrospectionStatus
NOT_STARTED
: The table introspection has not started.STARTED
: The table introspection has started.SUCCEEDED
: The table introspection succeeded.FAILED
: The table introspection failed.Show DataSourceOrFailureResponse
DataSourceResponse
will be returned; otherwise, a
FailureResponse
will be returned.Show DataSourceResponse
mutation {
createDataPoolV2(input: {
dataSource: "DSOXXXXX"
table: "tacosoft_sales_analytics"
timestamp: { columnName: "timestamp" }
columns: [
{
columnName: "timestamp",
type: TIMESTAMP,
isNullable: true
},
{
columnName: "order_id",
type: STRING,
isNullable: true
},
{
columnName: "taco_name",
type: STRING,
isNullable: true
},
{
columnName: "toppings",
type: JSON,
isNullable: true
},
{
columnName: "quantity",
type: INT32,
isNullable: true
},
{
columnName: "taco_unit_price",
type: INT32,
isNullable: true
},
{
columnName: "taco_total_price",
type: INT32,
isNullable: true
}
]
}) {
dataPool {
id
uniqueName
tableSettings {
orderBy
engine {
... on MergeTreeTableEngine {
type
}
... on ReplacingMergeTreeTableEngine {
type
ver
}
... on SummingMergeTreeTableEngine {
type
columns
}
... on AggregatingMergeTreeTableEngine {
type
}
... on PostgreSqlTableEngine {
type
}
}
}
}
}
}
Show CreateDataPoolInputV2
Show TimestampInput
Show DataPoolColumnInput
type
is set to CLICKHOUSE
.Show DataPoolSyncingInput
timestamp
and uniqueId
values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.Show TableSettingsInput
timestamp
and uniqueId
values, if specified.See TableEngineInputtimestamp
and uniqueId
values, if specified.timestamp
and uniqueId
values, if specified.timestamp
and uniqueId
values, if specified.Show Deprecated Fields
Show TenantInput
Show UniqueIdInput
Show DataPoolResponse
Show DataPool
Show Deprecated Fields
Show modifyDataPoolInput
Show DataPoolSyncingInput
Show TimestampInput
Show DataPoolOrFailureResponse
DataPoolResponse
will be returned; otherwise, a
FailureResponse
will be returned.Show DataPool
Show Account
Show Environment
Show DataPoolStatus
CREATED
: The Data Pool has been created and will be set up soon.PENDING
: Propel is attempting to set up the Data Pool.LIVE
: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.SETUP_FAILED
: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.CONNECTING
CONNECTED
BROKEN
PAUSING
PAUSED
DELETING
: Propel is deleting the Data Pool and all of its associated data.Show Timestamp
Show DataPoolColumnConnection
Show DataPoolColumnConnection
Show DataPoolSetupTask
Show DataPoolSyncing
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 DataPoolSyncIntervalShow SyncsFilter
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.Show ValidateExpressionResult
Show TableSettings
Show DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow Deprecated Fields
Show UniqueId
Show DataPool
Show Account
Show Environment
Show DataPoolStatus
CREATED
: The Data Pool has been created and will be set up soon.PENDING
: Propel is attempting to set up the Data Pool.LIVE
: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.SETUP_FAILED
: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.CONNECTING
CONNECTED
BROKEN
PAUSING
PAUSED
DELETING
: Propel is deleting the Data Pool and all of its associated data.Show Timestamp
Show DataPoolColumnConnection
Show DataPoolColumnConnection
Show DataPoolSetupTask
Show DataPoolSyncing
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 DataPoolSyncIntervalShow SyncsFilter
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.Show ValidateExpressionResult
Show TableSettings
Show DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow Deprecated Fields
Show UniqueId
Show DataPoolOrFailureResponse
DataPoolResponse
will be returned; otherwise, a
FailureResponse
will be returned.Show DataPoolOrFailureResponse
DataPoolResponse
will be returned; otherwise, a
FailureResponse
will be returned.Show DataPool
Show Account
Show Environment
Show DataPoolStatus
CREATED
: The Data Pool has been created and will be set up soon.PENDING
: Propel is attempting to set up the Data Pool.LIVE
: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.SETUP_FAILED
: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.CONNECTING
CONNECTED
BROKEN
PAUSING
PAUSED
DELETING
: Propel is deleting the Data Pool and all of its associated data.Show Timestamp
Show DataPoolColumnConnection
Show DataPoolColumnConnection
Show DataPoolSetupTask
Show DataPoolSyncing
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 DataPoolSyncIntervalShow SyncsFilter
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.Show ValidateExpressionResult
Show TableSettings
Show DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow Deprecated Fields
Show UniqueId
Show DataPool
Show Account
Show Environment
Show DataPoolStatus
CREATED
: The Data Pool has been created and will be set up soon.PENDING
: Propel is attempting to set up the Data Pool.LIVE
: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.SETUP_FAILED
: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.CONNECTING
CONNECTED
BROKEN
PAUSING
PAUSED
DELETING
: Propel is deleting the Data Pool and all of its associated data.Show Timestamp
Show DataPoolColumnConnection
Show DataPoolColumnConnection
Show DataPoolSetupTask
Show DataPoolSyncing
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 DataPoolSyncIntervalShow SyncsFilter
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.Show ValidateExpressionResult
Show TableSettings
Show DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow Deprecated Fields
Show UniqueId
Show CreateCountMetricInput
Show DimensionInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show MetricResponse
Show Metric
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.See Dimensioncounter
query insteadtimeSeries
query insteadleaderboard
query insteadShow CreateCountDistinctMetricInput
Show DimensionInput
Show DimensionInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show MetricResponse
Show Metric
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.See Dimensioncounter
query insteadtimeSeries
query insteadleaderboard
query insteadShow CreateSumMetricInput
Show DimensionInput
Show DimensionInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show MetricResponse
Show Metric
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.See Dimensioncounter
query insteadtimeSeries
query insteadleaderboard
query insteadShow CreateAverageMetricInput
Show DimensionInput
Show DimensionInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show MetricResponse
Show Metric
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.See Dimensioncounter
query insteadtimeSeries
query insteadleaderboard
query insteadShow CreateMinMetricInput
Show DimensionInput
Show DimensionInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show MetricResponse
Show Metric
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.See Dimensioncounter
query insteadtimeSeries
query insteadleaderboard
query insteadShow CreateMaxMetricInput
Show DimensionInput
Show DimensionInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show MetricResponse
Show Metric
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.See Dimensioncounter
query insteadtimeSeries
query insteadleaderboard
query insteadShow CreateCustomMetricInput
Show DimensionInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show MetricResponse
Show Metric
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.See Dimensioncounter
query insteadtimeSeries
query insteadleaderboard
query insteadShow ModifyMetricInput
Show DimensionInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show MetricResponse
Show Metric
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.See Dimensioncounter
query insteadtimeSeries
query insteadleaderboard
query insteadShow Metric
Show Account
Show Environment
Show Dimension
Show Deprecated Fields
Show Dimension
Show Deprecated Fields
Show MetricType
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.Show MetricSettings
Show Deprecated Fields
settings
object instead.deprecated: Use the Metric settings
object instead.Show Dimension
Show Deprecated Fields
counter
query insteadShow CounterInput
Show Deprecated Fields
metricName
is not specified.deprecated: Use metric
metricId
is not specified.deprecated: Use metric
filterSql
insteadSee FilterInputtimeSeries
query insteadShow TimeSeriesInput
Show Deprecated Fields
metricName
is not specified.deprecated: Use metric
metricId
is not specified.deprecated: Use metric
filterSql
insteadSee FilterInputShow TimeSeriesResponse
groupBy
, if specified.See TimeSeriesResponseGroupleaderboard
query insteadShow LeaderboardInput
ASC
) or descending (DESC
) order. Defaults to descending (DESC
) order when not provided.See SortShow Deprecated Fields
metricName
is not specified.deprecated: Use metric
metricId
is not specified.deprecated: Use metric
filterSql
insteadSee FilterInputShow LeaderboardResponse
Show CreateBoosterInput
dimensions
)Show DimensionInput
Show BoosterResponse
Show Booster
dimensions
)Show CreateDeletionJobInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show DeletionJobResponse
Show DeletionJob
Show CreateAddColumnToDataPoolJobInput
Show ColumnType
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.columnType
is set to CLICKHOUSE
.Show AddColumnToDataPoolJobResponse
Show AddColumnToDataPoolJob
columnType
is set to CLICKHOUSE
.Show CreateUpdateDataPoolRecordsJobInput
Show UpdateDataPoolRecordsJobSetColumnInput
{
"column": "status",
"expression": "'completed'"
}
{
"column": "counter",
"expression": "counter + 1"
}
{
"column": "full_name",
"expression": "concat(first_name, ' ', last_name)"
}
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show UpdateDataPoolRecordsJobResponse
Show UpdateDataPoolRecordsJob
Show Sync
Show Account
Show Environment
Show DataSource
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
.Show SyncStatus
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.Show Deprecated Fields
processedRecords
insteadprocessedRecords
insteadprocessedRecords
insteadprocessedRecords
insteadShow Sync
Show Account
Show Environment
Show DataSource
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
.Show SyncStatus
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.Show Deprecated Fields
processedRecords
insteadprocessedRecords
insteadprocessedRecords
insteadprocessedRecords
insteadShow CreateMaterializedViewInput
Show CreateMaterializedViewDestinationInput
Show BackfillOptionsInput
OLDEST_FIRST
if not specified.See PartitionOrderShow MaterializedViewResponse
Show MaterializedView
Show MaterializedViewResponse
Show MaterializedView
Show CreateAmazonDataFirehoseDataSourceInput
Show AmazonDataFirehoseConnectionSettingsInput
X-Amz-Firehose-Access-Key
header when Amazon Data Firehose issues requests to its custom HTTP endpoint.See HttpBasicAuthInputtimestamp
value, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsInputShow DataSourceResponse
Show DataSource
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
.Show ModifyAmazonDataFirehoseDataSourceInput
Show PartialAmazonDataFirehoseConnectionSettingsInput
X-Amz-Firehose-Access-Key
header when Amazon Data Firehose issues requests to its custom HTTP endpoint. If not provided this property will not be modified.See HttpBasicAuthInputShow DataSourceResponse
Show DataSource
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
.Show CreateAmazonDynamoDBDataSourceInput
Show AmazonDynamoDBConnectionSettingsInput
X-Amz-Firehose-Access-Key
header when Amazon Data Firehose transmits records from your DynamoDB table to its
custom HTTP endpoint.See HttpBasicAuthInputtimestamp
value, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsInputShow DataSourceResponse
Show DataSource
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
.Show ModifyAmazonDynamoDBDataSourceInput
Show PartialAmazonDynamoDBConnectionSettingsInput
X-Amz-Firehose-Access-Key
header when Amazon Data Firehose transmits records from your DynamoDB table to its
custom HTTP endpoint. If not provided this property will not be modified.See HttpBasicAuthInputShow DataSourceResponse
Show DataSource
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
.Show CreateClickHouseDataSourceInput
Show ClickHouseConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.Show ModifyClickHouseDataSourceInput
Show PartialClickHouseConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.Show CreateHttpDataSourceInput
Show HttpConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.Show ModifyHttpDataSourceInput
Show PartialHttpConnectionSettingsInput
false
to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.Show DataSourceResponse
Show DataSource
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
.Show CreateKafkaDataSourceInput
Show KafkaConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.Show ModifyKafkaDataSourceInput
Show PartialKafkaConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.mutation {
createPostgreSqlDataSource(input: {
uniqueName: "example_postgresql_data_source"
description: "My PostgreSQL Data Source"
connectionSettings: {
database: "example_database"
schema: "public"
host: "postgresql.example.com"
port: 5432
user: "user"
password: "password"
}
}) {
dataSource {
id
uniqueName
}
}
}
Show CreatePostgreSqlDataSourceInput
Show PostgreSqlConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.Show ModifyPostgreSqlDataSourceInput
Show PartialPostgreSqlConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.Show CreateS3DataSourceInput
Show S3ConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.Show ModifyS3DataSourceInput
Show PartialS3ConnectionSettingsInput
Show DataSourceResponse
Show DataSource
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
.Show CreateTwilioSegmentDataSourceInput
Show TwilioSegmentConnectionSettingsInput
timestamp
and uniqueId
values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsInputShow DataSourceResponse
Show DataSource
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
.Show ModifyTwilioSegmentDataSourceInput
Show PartialTwilioSegmentConnectionSettingsInput
false
to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.Show DataSourceResponse
Show DataSource
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
.Show CreateWebhookDataSourceInput
Show WebhookConnectionSettingsInput
timestamp
and uniqueId
values, if any. You can override these
defaults in order to specify a custom table engine, custom ORDER BY, etc.See TableSettingsInputShow DataSourceResponse
Show DataSource
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
.Show ModifyWebhookDataSourceInput
Show PartialWebhookConnectionSettingsInput
false
to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.Show DataSourceResponse
Show DataSource
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
.Show Deprecated Fields
retryDataPoolSetup
instead.deprecated: Use retryDataPoolSetup
insteadShow DataPool
Show Account
Show Environment
Show DataPoolStatus
CREATED
: The Data Pool has been created and will be set up soon.PENDING
: Propel is attempting to set up the Data Pool.LIVE
: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.SETUP_FAILED
: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.CONNECTING
CONNECTED
BROKEN
PAUSING
PAUSED
DELETING
: Propel is deleting the Data Pool and all of its associated data.Show Timestamp
Show DataPoolColumnConnection
Show DataPoolColumnConnection
Show DataPoolSetupTask
Show DataPoolSyncing
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 DataPoolSyncIntervalShow SyncsFilter
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.Show ValidateExpressionResult
Show TableSettings
Show DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow DataPoolColumn
Show Deprecated Fields
columnName
insteadShow Deprecated Fields
Show UniqueId
Show CreatePolicyInput
Show PolicyType
ALL_ACCESS
: Grants access to all Metric data.TENANT_ACCESS
: Grants access to a specified tenant’s Metric data.Show PolicyResponse
Show Policy
Show ModifyPolicyInput
Show PolicyResponse
Show Policy
createDeletionJob
Show DeletionRequestInput
Show Deprecated Fields
filterSql
insteadShow FilterInput
and
and or
. For example, to construct a filter equivalent to(value > 0 AND value <= 100) OR status = "confirmed"
{
"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
.Show RequestDeleteResponse
Show DeletionJob