GET
/
api
/
changes
/
v1
curl --request GET \
  --url https://developer.synq.io/api/changes/v1 \
  --header 'Authorization: Bearer <token>'
{
  "changes": [
    {
      "entityId": {
        "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>"
        }
      },
      "entitySynqPath": "<string>",
      "affectedEntities": [
        {
          "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>"
          }
        }
      ],
      "affectedEntitiesSynqPaths": [
        "<string>"
      ],
      "changeId": "<string>",
      "changeDetectedAt": "2023-11-07T05:31:56Z",
      "gitCommit": {
        "hash": "<string>",
        "author": {
          "name": "<string>",
          "email": "<string>",
          "createdAt": "2023-11-07T05:31:56Z"
        },
        "committer": {
          "name": "<string>",
          "email": "<string>",
          "createdAt": "2023-11-07T05:31:56Z"
        },
        "message": "<string>",
        "shortMessage": "<string>",
        "fileChangeStats": {},
        "changedFilePaths": [
          "<string>"
        ],
        "relatedChangedFilePaths": [
          "<string>"
        ],
        "branchName": "<string>",
        "cloneUrl": "<string>",
        "webCommitUrl": "<string>"
      },
      "sqlDefinition": {
        "previousSql": "<string>",
        "previousSqlStateAt": "2023-11-07T05:31:56Z",
        "currentSql": "<string>",
        "currentSqlStateAt": "2023-11-07T05:31:56Z",
        "sqlDiff": "<string>"
      },
      "schema": {
        "columnChanges": [
          {
            "columnAddition": {
              "columnId": "<string>",
              "nativeType": "<string>",
              "ordinalPosition": 123
            },
            "columnNativeType": {
              "columnId": "<string>",
              "previousNativeType": "<string>",
              "currentNativeType": "<string>"
            },
            "columnRemoval": {
              "columnId": "<string>",
              "nativeType": "<string>",
              "ordinalPosition": 123
            }
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

id.dbtCoreNode.integrationId
string

SYNQ integration_id that identifies the dbt Core project

id.dbtCoreNode.nodeId
string

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

id.dbtCloudNode.projectId
string

Your dbt Cloud project id

id.dbtCloudNode.accountId
string

Your dbt Cloud account id

id.dbtCloudNode.nodeId
string

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

id.bigqueryTable.project
string

BigQuery project

id.bigqueryTable.dataset
string

BigQuery dataset id

id.bigqueryTable.table
string

BigQuery table name

id.snowflakeTable.account
string

Snowflake account

id.snowflakeTable.database
string

Snowflake database

id.snowflakeTable.schema
string

Snowflake schema

id.snowflakeTable.table
string

Snowflake table

id.redshiftTable.cluster
string

Redshift cluster

id.redshiftTable.database
string

Redshift database

id.redshiftTable.schema
string

Redshift schema

id.redshiftTable.table
string

Redshift table

id.postgresTable.host
string

Postgres hostname without port

id.postgresTable.database
string

Postgres database

id.postgresTable.schema
string

Postgres schema

id.postgresTable.table
string

Postgres table

id.mysqlTable.host
string

Mysql hostname without port

id.mysqlTable.schema
string

Mysql database

id.mysqlTable.table
string

Mysql table

id.clickhouseTable.host
string

Clickhouse hostname without port

id.clickhouseTable.schema
string

Clickhouse database

id.clickhouseTable.table
string

Clickhouse table

id.airflowDag.integrationId
string

SYNQ integration_id that identifies the Airflow instance

id.airflowDag.dagId
string

Airflow dag_id that identifies the DAG

id.airflowTask.integrationId
string

SYNQ integration_id that identifies the Airflow instance

id.airflowTask.dagId
string

Airflow dag_id that identifies the DAG

id.airflowTask.taskId
string

Airflow task_id that identifies the task within the DAG

id.custom.id
string

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

id.dataproduct.id
string

Dataproduct id that identifies the Dataproduct

id.synqPath.path
string

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

id.databricksTable.workspace
string

URL of Databricks workspace

id.databricksTable.catalog
string

Databricks catalog

id.databricksTable.schema
string

Databricks schema

id.databricksTable.table
string

Databricks table or view

id.trinoTable.host
string

Hostname of the Trino instance

id.trinoTable.catalog
string

Trino catalog

id.trinoTable.schema
string

Trino schema

id.trinoTable.table
string

Trino table or view

id.sqlMeshModel.integrationId
string

SYNQ integration_id that identifies the dbt Core project

id.sqlMeshModel.fqn
string

SQLMesh model fully qualified name

id.sqlMeshAudit.integrationId
string

SYNQ integration_id that identifies the dbt Core project

id.sqlMeshAudit.fqn
string

SQLMesh model fully qualified name

id.sqlMeshAudit.auditId
string

Identifier of the audit

id.monitor.monitoredId.dbtCoreNode.integrationId
string

SYNQ integration_id that identifies the dbt Core project

id.monitor.monitoredId.dbtCoreNode.nodeId
string

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

id.monitor.monitoredId.dbtCloudNode.projectId
string

Your dbt Cloud project id

id.monitor.monitoredId.dbtCloudNode.accountId
string

Your dbt Cloud account id

id.monitor.monitoredId.dbtCloudNode.nodeId
string

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

id.monitor.monitoredId.bigqueryTable.project
string

BigQuery project

id.monitor.monitoredId.bigqueryTable.dataset
string

BigQuery dataset id

id.monitor.monitoredId.bigqueryTable.table
string

BigQuery table name

id.monitor.monitoredId.snowflakeTable.account
string

Snowflake account

id.monitor.monitoredId.snowflakeTable.database
string

Snowflake database

id.monitor.monitoredId.snowflakeTable.schema
string

Snowflake schema

id.monitor.monitoredId.snowflakeTable.table
string

Snowflake table

id.monitor.monitoredId.redshiftTable.cluster
string

Redshift cluster

id.monitor.monitoredId.redshiftTable.database
string

Redshift database

id.monitor.monitoredId.redshiftTable.schema
string

Redshift schema

id.monitor.monitoredId.redshiftTable.table
string

Redshift table

id.monitor.monitoredId.postgresTable.host
string

Postgres hostname without port

id.monitor.monitoredId.postgresTable.database
string

Postgres database

id.monitor.monitoredId.postgresTable.schema
string

Postgres schema

id.monitor.monitoredId.postgresTable.table
string

Postgres table

id.monitor.monitoredId.mysqlTable.host
string

Mysql hostname without port

id.monitor.monitoredId.mysqlTable.schema
string

Mysql database

id.monitor.monitoredId.mysqlTable.table
string

Mysql table

id.monitor.monitoredId.clickhouseTable.host
string

Clickhouse hostname without port

id.monitor.monitoredId.clickhouseTable.schema
string

Clickhouse database

id.monitor.monitoredId.clickhouseTable.table
string

Clickhouse table

id.monitor.monitoredId.airflowDag.integrationId
string

SYNQ integration_id that identifies the Airflow instance

id.monitor.monitoredId.airflowDag.dagId
string

Airflow dag_id that identifies the DAG

id.monitor.monitoredId.airflowTask.integrationId
string

SYNQ integration_id that identifies the Airflow instance

id.monitor.monitoredId.airflowTask.dagId
string

Airflow dag_id that identifies the DAG

id.monitor.monitoredId.airflowTask.taskId
string

Airflow task_id that identifies the task within the DAG

id.monitor.monitoredId.custom.id
string

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

id.monitor.monitoredId.dataproduct.id
string

Dataproduct id that identifies the Dataproduct

id.monitor.monitoredId.synqPath.path
string

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

id.monitor.monitoredId.databricksTable.workspace
string

URL of Databricks workspace

id.monitor.monitoredId.databricksTable.catalog
string

Databricks catalog

id.monitor.monitoredId.databricksTable.schema
string

Databricks schema

id.monitor.monitoredId.databricksTable.table
string

Databricks table or view

id.monitor.monitoredId.trinoTable.host
string

Hostname of the Trino instance

id.monitor.monitoredId.trinoTable.catalog
string

Trino catalog

id.monitor.monitoredId.trinoTable.schema
string

Trino schema

id.monitor.monitoredId.trinoTable.table
string

Trino table or view

id.monitor.monitoredId.sqlMeshModel.integrationId
string

SYNQ integration_id that identifies the dbt Core project

id.monitor.monitoredId.sqlMeshModel.fqn
string

SQLMesh model fully qualified name

id.monitor.monitoredId.sqlMeshAudit.integrationId
string

SYNQ integration_id that identifies the dbt Core project

id.monitor.monitoredId.sqlMeshAudit.fqn
string

SQLMesh model fully qualified name

id.monitor.monitoredId.sqlMeshAudit.auditId
string

Identifier of the audit

id.monitor.monitoredId.monitor.monitorId
string

Identifier of the monitor

id.monitor.monitoredId.monitor.segment
string

Optional monitor segmentation identifier

id.monitor.monitoredId.monitor.integrationId
string

SYNQ integration_id of the monitored identifier

id.monitor.monitorId
string

Identifier of the monitor

id.monitor.segment
string

Optional monitor segmentation identifier

id.monitor.integrationId
string

SYNQ integration_id of the monitored identifier

changeBefore
string

Return changes older than or on before. Defaults to now().

changeAfter
string

Return changes newer than until. Defaults to before - 7days,

limitToChangeTypes
integer[]

Return only changes of specific types.

Response

200
application/json

OK

ListResponse contains the list of changes made to the requested entity.