GET
/
api
/
changes
/
v1
List
curl --request GET \
  --url https://developer.synq.io/api/changes/v1 \
  --header 'Authorization: Bearer <token>'
{
  "changes": [
    {
      "gitCommit": {
        "hash": "<string>",
        "author": {
          "name": "<string>",
          "email": "<string>",
          "createdAt": "1s"
        },
        "committer": {
          "name": "<string>",
          "email": "<string>",
          "createdAt": "1s"
        },
        "message": "<string>",
        "shortMessage": "<string>",
        "fileChangeStats": {},
        "changedFilePaths": [
          "<string>"
        ],
        "relatedChangedFilePaths": [
          "<string>"
        ],
        "branchName": "<string>",
        "cloneUrl": "<string>",
        "webCommitUrl": "<string>"
      },
      "entityId": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "entitySynqPath": "<string>",
      "affectedEntities": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "affectedEntitiesSynqPaths": [
        "<string>"
      ],
      "changeId": "<string>",
      "changeDetectedAt": "1s"
    }
  ]
}

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
required

SYNQ integration_id that identifies the dbt Core project

​
id.dbtCoreNode.nodeId
string
required

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

​
id.dbtCloudNode.projectId
string
required

Your dbt Cloud project id

​
id.dbtCloudNode.accountId
string

Your dbt Cloud account id

​
id.dbtCloudNode.nodeId
string
required

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

​
id.bigqueryTable.project
string
required

BigQuery project

​
id.bigqueryTable.dataset
string
required

BigQuery dataset id

​
id.bigqueryTable.table
string
required

BigQuery table name

​
id.snowflakeTable.account
string
required

Snowflake account

​
id.snowflakeTable.database
string
required

Snowflake database

​
id.snowflakeTable.schema
string
required

Snowflake schema

​
id.snowflakeTable.table
string
required

Snowflake table

​
id.redshiftTable.cluster
string

Redshift cluster

​
id.redshiftTable.database
string
required

Redshift database

​
id.redshiftTable.schema
string
required

Redshift schema

​
id.redshiftTable.table
string
required

Redshift table

​
id.postgresTable.host
string
required

Postgres hostname without port

​
id.postgresTable.database
string
required

Postgres database

​
id.postgresTable.schema
string
required

Postgres schema

​
id.postgresTable.table
string
required

Postgres table

​
id.mysqlTable.host
string
required

Mysql hostname without port

​
id.mysqlTable.schema
string
required

Mysql database

​
id.mysqlTable.table
string
required

Mysql table

​
id.clickhouseTable.host
string
required

Clickhouse hostname without port

​
id.clickhouseTable.schema
string
required

Clickhouse database

​
id.clickhouseTable.table
string
required

Clickhouse table

​
id.airflowDag.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
id.airflowDag.dagId
string
required

Airflow dag_id that identifies the DAG

​
id.airflowTask.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
id.airflowTask.dagId
string
required

Airflow dag_id that identifies the DAG

​
id.airflowTask.taskId
string
required

Airflow task_id that identifies the task within the DAG

​
id.custom.id
string
required

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

​
id.dataproduct.id
string
required

Dataproduct id that identifies the Dataproduct

​
id.synqPath.path
string
required

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

​
id.databricksTable.workspace
string
required

URL of Databricks workspace

​
id.databricksTable.catalog
string
required

Databricks catalog

​
id.databricksTable.schema
string
required

Databricks schema

​
id.databricksTable.table
string
required

Databricks table or view

​
id.trinoTable.host
string
required

Hostname of the Trino instance

​
id.trinoTable.catalog
string
required

Trino catalog

​
id.trinoTable.schema
string
required

Trino schema

​
id.trinoTable.table
string
required

Trino table or view

​
id.sqlMeshModel.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
id.sqlMeshModel.fqn
string
required

SQLMesh model fully qualified name

​
id.sqlMeshAudit.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
id.sqlMeshAudit.fqn
string
required

SQLMesh model fully qualified name

​
id.sqlMeshAudit.auditId
string
required

Identifier of the audit

​
id.monitor.monitorId
string
required

Identifier of the monitor

​
id.monitor.segment
string

Optional monitor segmentation identifier

​
id.monitor.integrationId
string
deprecated

SYNQ integration_id of the monitored identifier

​
changeBefore.seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

​
changeBefore.nanos
integer

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

​
limitToChangeTypes
enum<string>[]

Return only changes of specific types.

Response

200
application/json

Success

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