curl --request GET \
--url https://developer.synq.io/api/monitors/info/v1/{id} \
--header 'Authorization: Bearer <token>'
{
"monitorInfo": {
"id": {
"monitoredId": {},
"monitorId": "<string>",
"segment": "<string>",
"integrationId": "<string>"
},
"name": "<string>",
"segmentation": {
"column": "<string>"
},
"partitioning": {
"column": "<string>",
"period": "<string>"
},
"conditions": [
{
"expression": "<string>"
}
],
"metrics": [
{
"metricId": "<string>",
"freshness": {
"expression": "<string>",
"tableMetadata": {}
},
"volume": {
"expression": "<string>",
"countRows": {},
"tableMetadata": {}
},
"value": {
"expression": "<string>"
}
}
],
"monitored": {
"id": {
"dbtCoreNode": {
"integrationId": "<string>",
"nodeId": "<string>"
},
"dbtCloudNode": {
"projectId": "<string>",
"accountId": "<string>",
"nodeId": "<string>"
},
"bigqueryTable": {
"project": "<string>",
"dataset": "<string>",
"table": "<string>"
},
"snowflakeTable": {
"account": "<string>",
"database": "<string>",
"schema": "<string>",
"table": "<string>"
},
"redshiftTable": {
"cluster": "<string>",
"database": "<string>",
"schema": "<string>",
"table": "<string>"
},
"postgresTable": {
"host": "<string>",
"database": "<string>",
"schema": "<string>",
"table": "<string>"
},
"mysqlTable": {
"host": "<string>",
"schema": "<string>",
"table": "<string>"
},
"clickhouseTable": {
"host": "<string>",
"schema": "<string>",
"table": "<string>"
},
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
},
"airflowTask": {
"integrationId": "<string>",
"dagId": "<string>",
"taskId": "<string>"
},
"custom": {
"id": "<string>"
},
"dataproduct": {
"id": "<string>"
},
"synqPath": {
"path": "<string>"
},
"databricksTable": {
"workspace": "<string>",
"catalog": "<string>",
"schema": "<string>",
"table": "<string>"
},
"trinoTable": {
"host": "<string>",
"catalog": "<string>",
"schema": "<string>",
"table": "<string>"
},
"sqlMeshModel": {
"integrationId": "<string>",
"fqn": "<string>"
},
"sqlMeshAudit": {
"integrationId": "<string>",
"fqn": "<string>",
"auditId": "<string>"
},
"monitor": {
"monitoredId": {},
"monitorId": "<string>",
"segment": "<string>",
"integrationId": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"integrationId": "<string>",
"objectFqn": {
"instance": "<string>",
"databaseName": "<string>",
"schemaName": "<string>",
"objectName": "<string>"
},
"sqlDialect": 123
}
}
}
curl --request GET \
--url https://developer.synq.io/api/monitors/info/v1/{id} \
--header 'Authorization: Bearer <token>'
{
"monitorInfo": {
"id": {
"monitoredId": {},
"monitorId": "<string>",
"segment": "<string>",
"integrationId": "<string>"
},
"name": "<string>",
"segmentation": {
"column": "<string>"
},
"partitioning": {
"column": "<string>",
"period": "<string>"
},
"conditions": [
{
"expression": "<string>"
}
],
"metrics": [
{
"metricId": "<string>",
"freshness": {
"expression": "<string>",
"tableMetadata": {}
},
"volume": {
"expression": "<string>",
"countRows": {},
"tableMetadata": {}
},
"value": {
"expression": "<string>"
}
}
],
"monitored": {
"id": {
"dbtCoreNode": {
"integrationId": "<string>",
"nodeId": "<string>"
},
"dbtCloudNode": {
"projectId": "<string>",
"accountId": "<string>",
"nodeId": "<string>"
},
"bigqueryTable": {
"project": "<string>",
"dataset": "<string>",
"table": "<string>"
},
"snowflakeTable": {
"account": "<string>",
"database": "<string>",
"schema": "<string>",
"table": "<string>"
},
"redshiftTable": {
"cluster": "<string>",
"database": "<string>",
"schema": "<string>",
"table": "<string>"
},
"postgresTable": {
"host": "<string>",
"database": "<string>",
"schema": "<string>",
"table": "<string>"
},
"mysqlTable": {
"host": "<string>",
"schema": "<string>",
"table": "<string>"
},
"clickhouseTable": {
"host": "<string>",
"schema": "<string>",
"table": "<string>"
},
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
},
"airflowTask": {
"integrationId": "<string>",
"dagId": "<string>",
"taskId": "<string>"
},
"custom": {
"id": "<string>"
},
"dataproduct": {
"id": "<string>"
},
"synqPath": {
"path": "<string>"
},
"databricksTable": {
"workspace": "<string>",
"catalog": "<string>",
"schema": "<string>",
"table": "<string>"
},
"trinoTable": {
"host": "<string>",
"catalog": "<string>",
"schema": "<string>",
"table": "<string>"
},
"sqlMeshModel": {
"integrationId": "<string>",
"fqn": "<string>"
},
"sqlMeshAudit": {
"integrationId": "<string>",
"fqn": "<string>",
"auditId": "<string>"
},
"monitor": {
"monitoredId": {},
"monitorId": "<string>",
"segment": "<string>",
"integrationId": "<string>"
}
},
"name": "<string>",
"description": "<string>",
"integrationId": "<string>",
"objectFqn": {
"instance": "<string>",
"databaseName": "<string>",
"schemaName": "<string>",
"objectName": "<string>"
},
"sqlDialect": 123
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Identifier is a unique reference to an entity in SYNQ system. Entity identifiers are designed to closely mimic identifiers used by data platforms and tools. To construct an identifier, you need to know the kind of the entity and the ids that you would normally use to identify it in the data platform or tool. For example, to identify a table in BigQuery, you would need to know the project, dataset, and table names.
OK
The response is of type object
.