GetDeployOverview

GetDeployOverview

curl --request GET \
  --url https://developer.synq.io/api/monitors/automated/v1/deployment-rule \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.synq.io/api/monitors/automated/v1/deployment-rule"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.synq.io/api/monitors/automated/v1/deployment-rule', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/monitors/automated/v1/deployment-rule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://developer.synq.io/api/monitors/automated/v1/deployment-rule"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/monitors/automated/v1/deployment-rule")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/monitors/automated/v1/deployment-rule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "overview": {
    "monitorsToCreateFor": [
      "<string>"
    ],
    "monitorsToDeleteFor": [
      "<string>"
    ],
    "activeMonitorsFor": [
      "<string>"
    ],
    "monitorSettingsChanges": [
      {
        "monitoredAssetPath": "<string>",
        "originalSettings": {
          "metricIds": [],
          "metricOptions": [
            {}
          ]
        },
        "newSettings": {
          "metricIds": [],
          "metricOptions": [
            {}
          ]
        }
      }
    ],
    "customMonitorsToCreateFor": [
      "<string>"
    ],
    "customMonitorsToDeleteFor": [
      "<string>"
    ],
    "activeCustomMonitorsFor": [
      "<string>"
    ],
    "customMonitorSettingsChanges": [
      {
        "monitoredAssetPath": "<string>",
        "originalSettings": {
          "metricIds": [],
          "metricOptions": [
            {}
          ]
        },
        "newSettings": {
          "metricIds": [],
          "metricOptions": [
            {}
          ]
        },
        "resolvedFreshnessField": "<string>"
      }
    ],
    "skippedAssets": [
      {
        "assetPath": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

GET

api

monitors

automated

deployment-rule

GetDeployOverview

curl --request GET \
  --url https://developer.synq.io/api/monitors/automated/v1/deployment-rule \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.synq.io/api/monitors/automated/v1/deployment-rule"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.synq.io/api/monitors/automated/v1/deployment-rule', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/monitors/automated/v1/deployment-rule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://developer.synq.io/api/monitors/automated/v1/deployment-rule"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/monitors/automated/v1/deployment-rule")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/monitors/automated/v1/deployment-rule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "overview": {
    "monitorsToCreateFor": [
      "<string>"
    ],
    "monitorsToDeleteFor": [
      "<string>"
    ],
    "activeMonitorsFor": [
      "<string>"
    ],
    "monitorSettingsChanges": [
      {
        "monitoredAssetPath": "<string>",
        "originalSettings": {
          "metricIds": [],
          "metricOptions": [
            {}
          ]
        },
        "newSettings": {
          "metricIds": [],
          "metricOptions": [
            {}
          ]
        }
      }
    ],
    "customMonitorsToCreateFor": [
      "<string>"
    ],
    "customMonitorsToDeleteFor": [
      "<string>"
    ],
    "activeCustomMonitorsFor": [
      "<string>"
    ],
    "customMonitorSettingsChanges": [
      {
        "monitoredAssetPath": "<string>",
        "originalSettings": {
          "metricIds": [],
          "metricOptions": [
            {}
          ]
        },
        "newSettings": {
          "metricIds": [],
          "metricOptions": [
            {}
          ]
        },
        "resolvedFreshnessField": "<string>"
      }
    ],
    "skippedAssets": [
      {
        "assetPath": "<string>",
        "reason": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

deploymentRule.id

string<uuid>

deploymentRule.title

string

Required string length: 1 - 100

deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCoreNode.integrationId

string

required

Opaque identifier of the dbt Core project. Usually the Coalesce Quality integration id (a UUID), but may also be the dbt project name from manifest.json when the integration is configured to identify assets by project name. Treat it as an opaque string, not a UUID.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCoreNode.nodeId

string

required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.projectId

string

required

Your dbt Cloud project id

deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.accountId

string

Your dbt Cloud account id

deploymentRule.queryConfig.query.parts.identifierList.identifiers.dbtCloudNode.nodeId

string

required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.project

string

required

BigQuery project

deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.dataset

string

required

BigQuery dataset id

deploymentRule.queryConfig.query.parts.identifierList.identifiers.bigqueryTable.table

string

required

BigQuery table name

deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.account

string

required

Snowflake account

deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.database

string

required

Snowflake database

deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.schema

string

required

Snowflake schema

deploymentRule.queryConfig.query.parts.identifierList.identifiers.snowflakeTable.table

string

required

Snowflake table

deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.cluster

string

Redshift cluster

deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.database

string

required

Redshift database

deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.schema

string

required

Redshift schema

deploymentRule.queryConfig.query.parts.identifierList.identifiers.redshiftTable.table

string

required

Redshift table

deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.host

string

required

Postgres hostname without port

deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.database

string

required

Postgres database

deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.schema

string

required

Postgres schema

deploymentRule.queryConfig.query.parts.identifierList.identifiers.postgresTable.table

string

required

Postgres table

deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.host

string

required

Mysql hostname without port

deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.schema

string

required

Mysql database

deploymentRule.queryConfig.query.parts.identifierList.identifiers.mysqlTable.table

string

required

Mysql table

deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.host

string

required

Clickhouse hostname without port

deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.schema

string

required

Clickhouse database

deploymentRule.queryConfig.query.parts.identifierList.identifiers.clickhouseTable.table

string

required

Clickhouse table

deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowDag.integrationId

string

required

Coalesce Quality integration_id that identifies the Airflow instance

deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowDag.dagId

string

required

Airflow dag_id that identifies the DAG

deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.integrationId

string

required

Coalesce Quality integration_id that identifies the Airflow instance

deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.dagId

string

required

Airflow dag_id that identifies the DAG

deploymentRule.queryConfig.query.parts.identifierList.identifiers.airflowTask.taskId

string

required

Airflow task_id that identifies the task within the DAG

deploymentRule.queryConfig.query.parts.identifierList.identifiers.custom.id

string

required

Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.dataproduct.id

string<uuid>

required

Dataproduct id that identifies the Dataproduct

deploymentRule.queryConfig.query.parts.identifierList.identifiers.synqPath.path

string

required

Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths

deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.workspace

string

required

URL of Databricks workspace

deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.catalog

string

required

Databricks catalog

deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.schema

string

required

Databricks schema

deploymentRule.queryConfig.query.parts.identifierList.identifiers.databricksTable.table

string

required

Databricks table or view

deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.host

string

required

Hostname of the Trino instance

deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.catalog

string

required

Trino catalog

deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.schema

string

required

Trino schema

deploymentRule.queryConfig.query.parts.identifierList.identifiers.trinoTable.table

string

required

Trino table or view

deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshModel.integrationId

string<uuid>

required

Coalesce Quality integration_id that identifies the dbt Core project

deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshModel.fqn

string

required

SQLMesh model fully qualified name

deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.integrationId

string<uuid>

required

Coalesce Quality integration_id that identifies the dbt Core project

deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.fqn

string

required

SQLMesh model fully qualified name

deploymentRule.queryConfig.query.parts.identifierList.identifiers.sqlMeshAudit.auditId

string

required

Identifier of the audit

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.host

string

required

Hostname of the SQL Server instance

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.database

string

required

SQL Server database

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.schema

string

required

SQL Server schema (e.g. "dbo")

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.table

string

required

SQL Server table or view

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.host

string

required

Hostname of the Oracle instance

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.serviceName

string

required

Oracle service name (PDB)

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.schema

string

required

Oracle schema (= owning user)

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.table

string

required

Oracle table or view

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.instance

string

required

AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.catalog

string

required

Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.database

string

required

Glue database (the namespace users typically filter on).

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.table

string

required

Glue table or view name.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.savedView.id

string<uuid>

required

Saved view id (client-supplied UUID) that identifies the saved view

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.instance

string

required

Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com".

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.database

string

required

Fabric warehouse / lakehouse (database).

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.schema

string

required

Schema within the database.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.table

string

required

Table or view name.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.workspaceId

string

Fabric workspace GUID, decoded from the endpoint host in instance. Optional and informational: the table is addressed by instance/database/schema/table, so leave it empty if you don't have it — it does not affect how the identifier resolves.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.tenantId

string

Entra (Azure AD) tenant GUID, decoded from the endpoint host in instance. Optional and informational, like workspace_id.

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.monitorId

string

required

Identifier of the monitor

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.segment

string

Optional monitor segmentation identifier

deploymentRule.queryConfig.query.parts.identifierList.identifiers.monitor.integrationId

string

deprecated

Coalesce Quality integration_id of the monitored identifier

deploymentRule.queryConfig.query.parts.withNameSearch.searchQuery

string

deploymentRule.queryConfig.query.parts.withType.type.default

enum<string>

Default Coalesce Quality types

Available options:

ENTITY_TYPE_UNSPECIFIED,

ENTITY_TYPE_BQ_TABLE,

ENTITY_TYPE_BQ_VIEW,

ENTITY_TYPE_LOOKER_LOOK,

ENTITY_TYPE_LOOKER_EXPLORE,

ENTITY_TYPE_LOOKER_VIEW,

ENTITY_TYPE_LOOKER_DASHBOARD,

ENTITY_TYPE_DBT_MODEL,

ENTITY_TYPE_DBT_TEST,

ENTITY_TYPE_DBT_SOURCE,

ENTITY_TYPE_DBT_PROJECT,

ENTITY_TYPE_DBT_METRIC,

ENTITY_TYPE_DBT_SNAPSHOT,

ENTITY_TYPE_DBT_SEED,

ENTITY_TYPE_DBT_ANALYSIS,

ENTITY_TYPE_DBT_EXPOSURE,

ENTITY_TYPE_DBT_GROUP,

ENTITY_TYPE_DBT_SEMANTIC_MODEL,

ENTITY_TYPE_DBT_CLOUD_PROJECT,

ENTITY_TYPE_DBT_CLOUD_JOB,

ENTITY_TYPE_SNOWFLAKE_TABLE,

ENTITY_TYPE_SNOWFLAKE_VIEW,

ENTITY_TYPE_SNOWFLAKE_STREAM,

ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE,

ENTITY_TYPE_SNOWFLAKE_TASK,

ENTITY_TYPE_SNOWFLAKE_EXTERNAL_TABLE,

ENTITY_TYPE_SNOWFLAKE_MATERIALIZED_VIEW,

ENTITY_TYPE_SNOWFLAKE_PROCEDURE,

ENTITY_TYPE_SNOWFLAKE_FUNCTION,

ENTITY_TYPE_SNOWFLAKE_SEMANTIC_VIEW,

ENTITY_TYPE_REDSHIFT_TABLE,

ENTITY_TYPE_REDSHIFT_VIEW,

ENTITY_TYPE_REDSHIFT_PROCEDURE,

ENTITY_TYPE_REDSHIFT_FUNCTION,

ENTITY_TYPE_TABLEAU_EMBEDDED,

ENTITY_TYPE_TABLEAU_PUBLISHED,

ENTITY_TYPE_TABLEAU_CUSTOM_SQL,

ENTITY_TYPE_TABLEAU_TABLE,

ENTITY_TYPE_TABLEAU_SHEET,

ENTITY_TYPE_TABLEAU_DASHBOARD,

ENTITY_TYPE_AIRFLOW_DAG,

ENTITY_TYPE_AIRFLOW_TASK,

ENTITY_TYPE_CLICKHOUSE_TABLE,

ENTITY_TYPE_CLICKHOUSE_VIEW,

ENTITY_TYPE_ANOMALY_MONITOR,

ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT,

ENTITY_TYPE_SQLTEST_TEST,

ENTITY_TYPE_RECON_SUITE,

ENTITY_TYPE_RECON_CASE,

ENTITY_TYPE_POSTGRES_TABLE,

ENTITY_TYPE_POSTGRES_VIEW,

ENTITY_TYPE_MYSQL_TABLE,

ENTITY_TYPE_MYSQL_VIEW,

ENTITY_TYPE_DATABRICKS_WAREHOUSE,

ENTITY_TYPE_DATABRICKS_TABLE,

ENTITY_TYPE_DATABRICKS_VIEW,

ENTITY_TYPE_DATABRICKS_JOB,

ENTITY_TYPE_DATABRICKS_JOB_TASK,

ENTITY_TYPE_DATABRICKS_NOTEBOOK,

ENTITY_TYPE_DATABRICKS_QUERY,

ENTITY_TYPE_DATABRICKS_DASHBOARD,

ENTITY_TYPE_SQLMESH_PROJECT,

ENTITY_TYPE_SQLMESH_SQL_MODEL,

ENTITY_TYPE_SQLMESH_PYTHON_MODEL,

ENTITY_TYPE_SQLMESH_EXTERNAL,

ENTITY_TYPE_SQLMESH_SEED,

ENTITY_TYPE_SQLMESH_AUDIT,

ENTITY_TYPE_SQLMESH_UNIT_TEST,

ENTITY_TYPE_SQLMESH_ENVIRONMENT,

ENTITY_TYPE_SQLMESH_SNAPSHOT,

ENTITY_TYPE_DUCKDB_TABLE,

ENTITY_TYPE_DUCKDB_VIEW,

ENTITY_TYPE_TRINO_TABLE,

ENTITY_TYPE_TRINO_VIEW,

ENTITY_TYPE_ATLAN_ASSET,

ENTITY_TYPE_ATLAN_INTEGRATION,

ENTITY_TYPE_COALESCE_PROJECT,

ENTITY_TYPE_COALESCE_ENVIRONMENT,

ENTITY_TYPE_COALESCE_NODE,

ENTITY_TYPE_COALESCE_NODE_TEST,

ENTITY_TYPE_COALESCE_JOB,

ENTITY_TYPE_CASTORDOC_TABLE,

ENTITY_TYPE_CASTORDOC_DASHBOARD,

ENTITY_TYPE_CASTORDOC_VIEW,

ENTITY_TYPE_CASTORDOC_TILE,

ENTITY_TYPE_CASTORDOC_VIZ_MODEL,

ENTITY_TYPE_POWERBI_REPORT,

ENTITY_TYPE_POWERBI_TILE,

ENTITY_TYPE_POWERBI_DATASET,

ENTITY_TYPE_POWERBI_DASHBOARD,

ENTITY_TYPE_POWERBI_TENANT,

ENTITY_TYPE_THOUGHTSPOT_LIVEBOARD,

ENTITY_TYPE_THOUGHTSPOT_WORKSHEET,

ENTITY_TYPE_SIGMA_WORKBOOK,

ENTITY_TYPE_SIGMA_DATA_MODEL,

ENTITY_TYPE_DOMO_PAGE,

ENTITY_TYPE_DOMO_DATASET,

ENTITY_TYPE_MSSQL_TABLE,

ENTITY_TYPE_MSSQL_VIEW,

ENTITY_TYPE_ORACLE_TABLE,

ENTITY_TYPE_ORACLE_VIEW,

ENTITY_TYPE_ATHENA_TABLE,

ENTITY_TYPE_ATHENA_VIEW,

ENTITY_TYPE_FABRIC_TABLE,

ENTITY_TYPE_FABRIC_VIEW,

ENTITY_TYPE_CUSTOM_ENTITY_GENERIC,

ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN,

ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX

deploymentRule.queryConfig.query.parts.withType.type.custom

integer<int32>

Custom types as defined through synq.entities.custom.v1.TypesService

deploymentRule.queryConfig.query.parts.withAnnotation.name

string

deploymentRule.queryConfig.query.parts.withAnnotation.acceptedValue

string

deprecated

deploymentRule.queryConfig.query.parts.withAnnotation.acceptedValues

string[]

deploymentRule.queryConfig.query.parts.inFolder.path

string[]

Opaque folder identifiers (a folder's own entity id). folders is the structured, human-authorable alternative. When path is the only source set and deep is unset, deep defaults to true for back-compat with queries authored before deep existed.

deploymentRule.queryConfig.query.parts.inFolder.folders.rootEntityId

string

Opaque id of the entity the folder hierarchy hangs under — an integration root or container (for example a warehouse instance, a database, or a transformation project). Take it verbatim from FolderRef.root_entity_id of a folder you already read, or from an entity id returned elsewhere.

deploymentRule.queryConfig.query.parts.inFolder.folders.folders

string[]

Ordered folder names from the root down to this folder (root first, leaf last), for example ["staging", "sales"]. Empty means the ref points at the root entity itself. Folder names are kept as separate segments (not joined with "/") because some platforms allow "/" inside a single folder name.

deploymentRule.queryConfig.query.parts.inFolder.folderOf.entityIds

string[]

Simplified source: the assets named directly by opaque entity id. Use this for the common "same folder as these specific assets" case; equivalent to an input_query that lists the same ids.

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.bigquery.project

string

required

BigQuery project

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.clickhouse.host

string

required

Clickhouse host inclusive of port

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.clickhouse.schema

string

required

Clickhouse database

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.snowflake.account

string

required

Snowflake account

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.snowflake.database

string

required

Snowflake database

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.redshift.cluster

string

required

Redshift cluster

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.redshift.database

string

required

Redshift database

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.postgres.host

string

required

Postgres host inclusive of port

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.postgres.database

string

required

Postgres database

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.mysql.host

string

required

Mysql host inclusive of port

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.databricks.workspace

string

required

URL of the databricks workspace

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.dbtCloud.apiEndpoint

string

required

API endpoint for Dbt Cloud

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.dbtCloud.accountId

string

required

Account ID

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.dbtCloud.projectId

string

required

Project ID

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.sqlMesh.defaultDatabaseInstance

string

required

Default database instance for SQL Mesh

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.duckdb.motherduckAccount

string

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.trino.coordinator

string

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.mssql.host

string

required

SQL Server host

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.mssql.database

string

required

Database name

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.oracle.host

string

required

Oracle host

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.oracle.serviceName

string

required

Oracle service name (PDB)

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.athena.instance

string

required

AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived by SYNQ from sts:GetCallerIdentity at integration setup time.

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.athena.catalog

string

required

Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog.

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.fabric.instance

string

required

Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". Identifies the Fabric workspace the integration connects to. Fabric is workspace-scoped with cross-database queries, so the workspace host alone identifies the platform (like Databricks' workspace URL); a specific warehouse/table is addressed by FabricTableIdentifier.

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.fabric.workspaceId

string

Fabric workspace GUID — the identifier used by the Fabric REST API for workspace-scoped resources. The Fabric endpoint host in instance encodes the tenant and workspace GUIDs; this is the decoded workspace GUID, provided so you don't have to decode it yourself. instance remains the identifying value. Optional: empty when the host isn't a standard Fabric endpoint.

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.fabric.tenantId

string

Entra (Azure AD) tenant GUID, decoded from the endpoint host in instance alongside workspace_id. Optional: empty when the host isn't a standard Fabric endpoint.

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDataPlatform.identifier.synqIntegrationId

string

Coalesce Quality integration ID maps to the created integration on the Coalesce Quality platform.

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.withDataPlatformType.types

enum<string>[]

Available options:

DATA_PLATFORM_TYPE_UNSPECIFIED,

DATA_PLATFORM_TYPE_BIGQUERY,

DATA_PLATFORM_TYPE_LOOKER,

DATA_PLATFORM_TYPE_DBT,

DATA_PLATFORM_TYPE_DBT_CLOUD,

DATA_PLATFORM_TYPE_DBT_SELF_HOSTED,

DATA_PLATFORM_TYPE_SNOWFLAKE,

DATA_PLATFORM_TYPE_GCP,

DATA_PLATFORM_TYPE_GIT,

DATA_PLATFORM_TYPE_GITHUB,

DATA_PLATFORM_TYPE_REDSHIFT,

DATA_PLATFORM_TYPE_TABLEAU,

DATA_PLATFORM_TYPE_AIRFLOW,

DATA_PLATFORM_TYPE_CLICKHOUSE,

DATA_PLATFORM_TYPE_POSTGRES,

DATA_PLATFORM_TYPE_MYSQL,

DATA_PLATFORM_TYPE_DATABRICKS,

DATA_PLATFORM_TYPE_SQLMESH,

DATA_PLATFORM_TYPE_DUCKDB,

DATA_PLATFORM_TYPE_TRINO,

DATA_PLATFORM_TYPE_ATLAN,

DATA_PLATFORM_TYPE_COALESCE,

DATA_PLATFORM_TYPE_CASTORDOC,

DATA_PLATFORM_TYPE_POWERBI,

DATA_PLATFORM_TYPE_THOUGHTSPOT,

DATA_PLATFORM_TYPE_SIGMA,

DATA_PLATFORM_TYPE_DOMO,

DATA_PLATFORM_TYPE_MSSQL,

DATA_PLATFORM_TYPE_ORACLE,

DATA_PLATFORM_TYPE_ATHENA,

DATA_PLATFORM_TYPE_FABRIC,

DATA_PLATFORM_TYPE_SYNQ

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inFolder.deep

boolean

When false or unset, matches only the direct members of the folder(s). When true, matches the entire recursive subtree (members of subfolders too).

Exception: when only the legacy path source is set and deep is unset, it defaults to true (preserves the behaviour of queries authored before this flag existed). With folders or folder_of, unset means false (shallow).

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.inDomain.domainId

string<uuid>

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.identitiesOf.inputQuery.operand

enum<string>

Defaults to AND if not specified.

Available options:

QUERY_OPERAND_UNSPECIFIED,

QUERY_OPERAND_AND,

QUERY_OPERAND_OR,

QUERY_OPERAND_EXCEPT,

QUERY_OPERAND_UPSTREAM,

QUERY_OPERAND_DOWNSTREAM

deploymentRule.queryConfig.query.parts.inFolder.folderOf.inputQuery.parts.unsupported.queryJson

string

deploymentRule.queryConfig.query.parts.inFolder.folderOf.includeAllAncestors

boolean

When false (default): only each asset's immediate parent folder. When true: every ancestor folder up the hierarchy, so InFolder then also matches assets in those ancestor folders.

deploymentRule.queryConfig.query.parts.query.operand

enum<string>

QueryOperand defines how multiple QueryParts within a Query are combined.

Available options:

QUERY_OPERAND_UNSPECIFIED,

QUERY_OPERAND_AND,

QUERY_OPERAND_OR,

QUERY_OPERAND_EXCEPT,

QUERY_OPERAND_UPSTREAM,

QUERY_OPERAND_DOWNSTREAM

deploymentRule.queryConfig.severity

enum<string>

Available options:

SEVERITY_UNSPECIFIED,

SEVERITY_WARNING,

SEVERITY_ERROR,

SEVERITY_INFO

deploymentRule.queryConfig.sensitivity

enum<string>

Available options:

SENSITIVITY_UNSPECIFIED,

SENSITIVITY_PRECISE,

SENSITIVITY_BALANCED,

SENSITIVITY_RELAXED

deploymentRule.queryConfig.metricIds

enum<string>[]

Minimum array length: 1

Available options:

METRIC_ID_UNSPECIFIED,

METRIC_ID_ROW_COUNT,

METRIC_ID_DELAY,

METRIC_ID_VOLUME_CHANGE_DELAY

deploymentRule.queryConfig.keepDeletedMonitors

boolean

deploymentRule.queryConfig.metricOptions.sensitivity

enum<string>

Available options:

SENSITIVITY_UNSPECIFIED,

SENSITIVITY_PRECISE,

SENSITIVITY_BALANCED,

SENSITIVITY_RELAXED

deploymentRule.queryConfig.metricOptions.metricId

enum<string>

Available options:

METRIC_ID_UNSPECIFIED,

METRIC_ID_ROW_COUNT,

METRIC_ID_DELAY,

METRIC_ID_VOLUME_CHANGE_DELAY

deploymentRule.queryConfig.resolverQl

string

ResolverQL selection string — an advanced, more expressive alternative to query. ResolverQL is a superset of the structured query: use it for selections query cannot express (e.g. lineage walks, column predicates). When set (non-empty) on write, resolver_ql is the source of truth and the structured query is ignored. On read it is echoed back VERBATIM (exactly as written, not normalized) for rules authored via ResolverQL, and is empty for rules authored via the structured query — so writing a read response back unchanged preserves the rule's authored form (a structured rule stays structured rather than being silently rewritten to ResolverQL). To read the ResolverQL form of a structured rule, use rendered_resolver_ql. query is always populated regardless.

deploymentRule.queryConfig.renderedResolverQl

string

Canonical ResolverQL rendering of this rule's selection, populated for every query rule regardless of how it was authored. OUTPUT ONLY — it is ignored on write; set resolver_ql to author a selection in ResolverQL. Use it to read the ResolverQL form of a rule authored via the structured query; for ResolverQL-authored rules it equals resolver_ql. Empty only for selections that have no ResolverQL representation.

deploymentRule.exclusiveQueryConfig.resolverQl

string

ResolverQL selection string for the exclusion set. Same semantics as QueryConfig.resolver_ql: when set on write it takes precedence over query; on read it is echoed back VERBATIM for ResolverQL-authored rules and is empty for structured-query rules (whose ResolverQL form is in rendered_resolver_ql). query is always populated.

deploymentRule.exclusiveQueryConfig.renderedResolverQl

string

Canonical ResolverQL rendering of the exclusion selection. Same semantics as QueryConfig.rendered_resolver_ql: OUTPUT ONLY, populated for every rule, ignored on write.

deploymentRule.staticConfig.path

string

deploymentRule.staticConfig.severity

enum<string>

Available options:

SEVERITY_UNSPECIFIED,

SEVERITY_WARNING,

SEVERITY_ERROR,

SEVERITY_INFO

deploymentRule.staticConfig.sensitivity

enum<string>

Available options:

SENSITIVITY_UNSPECIFIED,

SENSITIVITY_PRECISE,

SENSITIVITY_BALANCED,

SENSITIVITY_RELAXED

deploymentRule.staticConfig.metricIds

enum<string>[]

Minimum array length: 1

Available options:

METRIC_ID_UNSPECIFIED,

METRIC_ID_ROW_COUNT,

METRIC_ID_DELAY,

METRIC_ID_VOLUME_CHANGE_DELAY

deploymentRule.exclusiveStaticConfig.path

string

deploymentRule.productConfig.productId

string

deploymentRule.productConfig.severity

enum<string>

Available options:

SEVERITY_UNSPECIFIED,

SEVERITY_WARNING,

SEVERITY_ERROR,

SEVERITY_INFO

deploymentRule.productConfig.sensitivity

enum<string>

Available options:

SENSITIVITY_UNSPECIFIED,

SENSITIVITY_PRECISE,

SENSITIVITY_BALANCED,

SENSITIVITY_RELAXED

deploymentRule.productConfig.metricIds

enum<string>[]

Minimum array length: 1

Available options:

METRIC_ID_UNSPECIFIED,

METRIC_ID_ROW_COUNT,

METRIC_ID_DELAY,

METRIC_ID_VOLUME_CHANGE_DELAY

deploymentRule.productConfig.keepDeletedMonitors

boolean

deploymentRule.source

enum<string>

Available options:

SOURCE_APP,

SOURCE_API

deploymentRule.configId

string

Response

200 - application/json

Success

overview

MonitorsDeploymentOverview · object

Show child attributes

GetLineage DeleteDeploymentRule

Get Started

Alerts

Monitors

Monitors Types

Reconciliations

Data Products

Scout AI

Ownership

Incidents

Analytics

Lineage

BI Integrations

Data Warehouse Integrations

Transactional databases

Code Integrations

dbt Integrations

SQLMesh Integrations

Coalesce Integrations

Orchestration Tool Integrations

Alerting Integrations

Catalogs

Google Cloud Integrations

Admin

Security

Support

Developer API

Authorizations

Query Parameters

Response