Get Started
Monitors
Monitors Types
Incidents
Analytics
Data Warehouse Integrations
dbt Integrations
SQLMesh Integrations
Orchestration Tool Integrations
Alerting Integrations
Catalogs
Support
Developer API
curl --request POST \
--url https://developer.synq.io/api/changes/v1/by-id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changeIds": [
"<string>"
]
}
'{
"changes": {}
}BatchChange
BatchChange retrieves multiple entity changes by their IDs in a single request. This is an optimized endpoint for fetching specific changes when you already know their IDs, rather than listing changes for an entity.
curl --request POST \
--url https://developer.synq.io/api/changes/v1/by-id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"changeIds": [
"<string>"
]
}
'{
"changes": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
BatchChangeRequest contains the parameters needed to retrieve multiple changes by their IDs.
List of change IDs to retrieve. Each ID uniquely identifies a specific change in the system.
Response
Success
BatchChangeResponse contains the requested changes mapped by their IDs.
Map of change ID to EntityChange. Only includes changes that were found and accessible. Missing changes are omitted from the response.
Show child attributes
Show child attributes
EntityChange represents a change detected in an entity within the system. It tracks modifications to entities like Git commits, SQL definitions, and database schemas.
- value
- value
- value
Show child attributes
Show child attributes
Identifier of the entity on which the change was detected when available.
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
- entity_id
Show child attributes
Show child attributes
Internal identifier of the change event.
Timestamp when the change was detected by SYNQ.
GitCommitChange represents a change detected in a Git repository.
Show child attributes
Show child attributes
Hash of the Git commit.
Committer information of the Git commit.
Commit message describing the changes.
First non-empty line of the message
Statistics about changes made to each modified file.
Show child attributes
Show child attributes
ChangeStats contains statistics about changes made to a single file.
All changed file paths in the Commit
File paths which are related with the entities for which changes are requested. When no paths are present it means that is impossible to determine most relevant file changes. This field will be empty when retrieving change by id.
Name of the branch associated with the commit, if any.
URL of the Git repository where the commit was made.
URL to e.g. Github which opens the Commit
SYNQ path representing entity on which the change was detected when available,
Identifiers of entities directly affected by this change.
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.
- airflow_dag
- airflow_task
- bigquery_table
- clickhouse_table
- custom
- databricks_table
- dataproduct
- dbt_cloud_node
- dbt_core_node
- monitor
- mysql_table
- postgres_table
- redshift_table
- snowflake_table
- sql_mesh_audit
- sql_mesh_model
- synq_path
- trino_table
Show child attributes
Show child attributes
SYNQ paths of entities directly affected by this change.