curl --request GET \
--url https://developer.synq.io/api/schema/v1 \
--header 'Authorization: Bearer <token>'import requests
url = "https://developer.synq.io/api/schema/v1"
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/schema/v1', 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/schema/v1",
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/schema/v1"
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/schema/v1")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/schema/v1")
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{
"schema": {
"id": {
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
},
"entityId": "<string>"
},
"workspace": "<string>",
"synqPath": "<string>",
"stateAt": "2023-01-15T01:30:15.01Z",
"description": "<string>",
"columns": [
{
"name": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 500,
"isStruct": true,
"isRepeated": true,
"fields": [
{
"name": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 500,
"isStruct": true,
"isRepeated": true,
"fields": "<array>"
}
],
"precision": "<unknown>",
"scale": "<unknown>",
"numericCategory": "NUMERIC_CATEGORY_UNSPECIFIED",
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>",
"kind": "SCHEMA_TAG_KIND_UNSPECIFIED"
}
],
"isNullable": true
}
],
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>",
"kind": "SCHEMA_TAG_KIND_UNSPECIFIED"
}
]
}
}GetSchema
Get the schema of an entity by its identifier.
curl --request GET \
--url https://developer.synq.io/api/schema/v1 \
--header 'Authorization: Bearer <token>'import requests
url = "https://developer.synq.io/api/schema/v1"
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/schema/v1', 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/schema/v1",
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/schema/v1"
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/schema/v1")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/schema/v1")
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{
"schema": {
"id": {
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
},
"entityId": "<string>"
},
"workspace": "<string>",
"synqPath": "<string>",
"stateAt": "2023-01-15T01:30:15.01Z",
"description": "<string>",
"columns": [
{
"name": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 500,
"isStruct": true,
"isRepeated": true,
"fields": [
{
"name": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 500,
"isStruct": true,
"isRepeated": true,
"fields": "<array>"
}
],
"precision": "<unknown>",
"scale": "<unknown>",
"numericCategory": "NUMERIC_CATEGORY_UNSPECIFIED",
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>",
"kind": "SCHEMA_TAG_KIND_UNSPECIFIED"
}
],
"isNullable": true
}
],
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>",
"kind": "SCHEMA_TAG_KIND_UNSPECIFIED"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Opaque id of the entity, set on every identifier the API returns. Round-trip it verbatim; the format is not part of this contract and may change, and it is never constructed by hand.
OUTPUT ONLY. On a request this field is ignored — the structured variant is
what resolves. That is what lets you hand an identifier straight back
unchanged, or edit its structured fields, without the two disagreeing about
which entity you meant. To name an entity BY opaque id on a request, set the
synq_path variant to that id: it carries exactly this string, and it is
also how an entity whose platform has no structured variant is named.
1024Opaque 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.
Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)
Your dbt Cloud project id
Your dbt Cloud account id
Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)
BigQuery project
BigQuery dataset id
BigQuery table name
Snowflake account
Snowflake database
Snowflake schema
Snowflake table
Required. Host of the Redshift endpoint, as in the connection, for example
my-cluster.abc123.eu-west-1.redshift.amazonaws.com. A port suffix is
accepted and ignored. The bare cluster name (my-cluster) is not enough,
because one name can exist in more than one account or region. A response
returns the host in its normalized form, which is also accepted on input.
The rule below also refuses an empty value. It is not required, because
required stops the other rules and its error does not say what to send.
Required. Host of the Redshift endpoint, as in the connection, for example
my-cluster.abc123.eu-west-1.redshift.amazonaws.com. A port suffix is
accepted and ignored. The bare cluster name (my-cluster) is not enough,
because one name can exist in more than one account or region. A response
returns the host in its normalized form, which is also accepted on input.
The rule below also refuses an empty value. It is not required, because
required stops the other rules and its error does not say what to send.
redshift_table.cluster.full_host // cluster must be the full host of the Redshift endpoint from the connection, for example my-cluster.abc123.eu-west-1.redshift.amazonaws.com
Redshift database
Redshift schema
Redshift table
Postgres hostname without port
Postgres database
Postgres schema
Postgres table
Mysql hostname without port
Mysql database
Mysql table
Clickhouse hostname without port
Clickhouse database
Clickhouse table
Coalesce Quality integration_id that identifies the Airflow instance
Airflow dag_id that identifies the DAG
Coalesce Quality integration_id that identifies the Airflow instance
Airflow dag_id that identifies the DAG
Airflow task_id that identifies the task within the DAG
Id that identifies the custom entity The Id should be unique within the custom entity Identifier.
Dataproduct id that identifies the Dataproduct
Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths
URL of Databricks workspace
Databricks catalog
Databricks schema
Databricks table or view
Hostname of the Trino instance
Trino catalog
Trino schema
Trino table or view
Coalesce Quality integration_id that identifies the dbt Core project
SQLMesh model fully qualified name
Coalesce Quality integration_id that identifies the dbt Core project
SQLMesh model fully qualified name
Identifier of the audit
Hostname of the SQL Server instance
SQL Server database
SQL Server schema (e.g. "dbo")
SQL Server table or view
Hostname of the Oracle instance
Oracle service name (PDB)
Oracle schema (= owning user)
Oracle table or view
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.
Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog.
Glue database (the namespace users typically filter on).
Glue table or view name.
Saved view id (client-supplied UUID) that identifies the saved view
Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com".
Fabric warehouse / lakehouse (database).
Schema within the database.
Table or view name.
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.
Entra (Azure AD) tenant GUID, decoded from the endpoint host in instance.
Optional and informational, like workspace_id.
Host name of the Db2 server
Database name or alias, as in CONNECT TO <database>
Db2 schema (e.g. "DB2INST1")
Db2 table or view
Identifier of the monitor
Optional monitor segmentation identifier
Coalesce Quality integration_id of the monitored identifier
Response
Success
GetEntityResponse is the response message for the GetEntity method.
Schema of the entity, might be empty
Show child attributes
Show child attributes