# Coalesce Quality Documentation - [Introduction](https://docs.synq.io/introduction.md): How to set up and get the most out of Coalesce Quality - [Command-line tools](https://docs.synq.io/cli.md): Install any of the Coalesce Quality CLIs, and find the reference for each - [Alerts overview](https://docs.synq.io/alerts/alert-overview.md): Get notified about the issues that matter, on the channels your teams already use - [Setting up alerts](https://docs.synq.io/alerts/setting-up-alerts.md) - [Tagging owners](https://docs.synq.io/alerts/tagging-owners.md) - [Routing alerts](https://docs.synq.io/alerts/routing-alerts.md) - [Business alerts](https://docs.synq.io/alerts/business-alerts.md) - [Writing alert templates](https://docs.synq.io/alerts/templates.md): Customize the content and wording of your Coalesce Quality alerts - [Monitors overview](https://docs.synq.io/monitors/monitors-overview.md): Monitors are a core concept in Coalesce Quality, helping you proactively detect issues through self-learning and powerful anomaly detection - [Setting up monitors](https://docs.synq.io/monitors/setting-up-monitors.md) - [Setting up deployment rules](https://docs.synq.io/monitors/deployment-rules.md) - [Configuring monitor sensitivity](https://docs.synq.io/monitors/monitor-sensitivity.md) - [Monitor feedback](https://docs.synq.io/monitors/monitor-feedback.md) - [Muting monitors](https://docs.synq.io/monitors/muting-monitors.md) - [Defining monitors in code](https://docs.synq.io/monitors/monitors-as-code.md) - [Agent workflow](https://docs.synq.io/monitors/agent-workflow.md): The operating guide for a coding agent driving the synqcli CLI - [Monitors CLI reference](https://docs.synq.io/monitors/cli.md): Every synqcli command, argument and flag, generated from the CLI itself. - [SQL Tests](https://docs.synq.io/monitors/sql-tests.md) - [Running checks from your pipeline](https://docs.synq.io/monitors/on-demand-checks.md): Run on-demand monitors and SQL tests from your pipeline when new data lands, and get the results back in the same call - [Working with time dimensions and scheduling for monitors](https://docs.synq.io/monitors/time-dimensions.md) - [What monitoring costs in your warehouse](https://docs.synq.io/monitors/warehouse-cost.md): Which Coalesce Quality queries run in your data warehouse, what they cost, and how to keep the cost low - [Table stats monitor](https://docs.synq.io/monitor-types/table-stats-monitor.md) - [Volume monitor](https://docs.synq.io/monitor-types/volume-monitor.md) - [Freshness monitor](https://docs.synq.io/monitor-types/freshness-monitor.md) - [Custom SQL monitor](https://docs.synq.io/monitor-types/custom-sql-monitor.md) - [Field stats monitor](https://docs.synq.io/monitor-types/fieldstats.md) - [Schema monitor](https://docs.synq.io/monitor-types/schema-monitor.md): Schema changes and SQL definition changes are tracked automatically for every warehouse table and view. Set up a schema change alert to be notified about them. - [Reconciliation overview](https://docs.synq.io/reconciliation/overview.md): Prove that two datasets agree, across databases and clouds, without moving the data - [Getting started](https://docs.synq.io/reconciliation/getting-started.md): Install the CLI, write your first suite, and locate a real difference in under ten minutes - [Concepts and vocabulary](https://docs.synq.io/reconciliation/concepts.md): The words used in the CLI, the app and the API, and what each one means - [Authoring suites](https://docs.synq.io/reconciliation/authoring-suites.md): The YAML anatomy of a suite, choosing key columns, and validating before you spend a query - [Comparison modes](https://docs.synq.io/reconciliation/comparison-modes.md): Row counts, row checksums and aggregate measures: which one answers your question - [Time windows and cutoffs](https://docs.synq.io/reconciliation/time-windows-and-cutoffs.md): Comparing two live systems without inventing differences that are not there - [Running locally](https://docs.synq.io/reconciliation/running-locally.md): Running a suite against databases you can reach: output, audit logs, cost gates and exit codes - [Workspace suites](https://docs.synq.io/reconciliation/workspace-suites.md): From a local file to a scheduled Production deployment: Development, Production, and what each step keeps - [Investigating results](https://docs.synq.io/reconciliation/investigating-results.md): Reading a run, following a finding to the rows, and confirming a fix worked - [CI/CD and automation](https://docs.synq.io/reconciliation/cicd-and-automation.md): Using a reconciliation as a release gate, and the credentials an unattended caller needs - [How comparison works](https://docs.synq.io/reconciliation/how-comparison-works.md): The checksum, the bisection, the segmentation strategies, and what each one reveals - [Agent workflow](https://docs.synq.io/reconciliation/agent-workflow.md): The operating guide for a coding agent driving the synq-recon CLI - [Reconciliation CLI reference](https://docs.synq.io/reconciliation/cli.md): Every synq-recon command, argument and flag, generated from the CLI itself. - [Data products overview](https://docs.synq.io/data-products/data-products-overview.md): Coalesce Quality enables you to deploy relevant monitors, track uptime, and manage ownership of your business-critical data assets through Data Products - [Creating a data product](https://docs.synq.io/data-products/creating-a-data-product.md) - [BI Status Badge](https://docs.synq.io/data-products/bi-badge.md) - [Scout overview](https://docs.synq.io/scout/scout.md): Autonomous AI-powered data quality agent that proactively monitors and resolves data issues - [Setting up and configuring Scout](https://docs.synq.io/scout/setting-up-scout.md): Enable Scout AI for your workspace and give it the context, data access and models it needs - [Scout on-premise setup](https://docs.synq.io/scout/on-premise.md): Run the Scout AI agent in your own infrastructure, with your own LLM endpoint - [MCP](https://docs.synq.io/scout/mcp.md): Model Context Protocol - Connecting Coalesce Quality to AI applications - [Agent workflow](https://docs.synq.io/scout/agent-workflow.md): The operating guide for a coding agent driving Scout - [Scout CLI reference](https://docs.synq.io/scout/cli.md): Every synq-scout command, argument and flag, generated from the CLI itself. - [Ownership overview](https://docs.synq.io/ownership/ownership-overview.md): Owners make it clear who is responsible for which data assets, and keep them informed about the health of their data - [Creating an owner](https://docs.synq.io/ownership/creating-an-owner.md) - [Domains](https://docs.synq.io/ownership/domains.md) - [Incidents overview](https://docs.synq.io/incidents/incident-overview.md): Incident management helps you manage the issue resolution from start to finish and avoid anything getting lost when the stakes are high. - [Analytics overview](https://docs.synq.io/analytics/analytics-overview.md): Coalesce Quality analytics gives you a bird's-eye view of the health of your data stack so you can systematically improve what matters most - [How metrics are calculated](https://docs.synq.io/analytics/how-metrics-are-calculated.md): How Coalesce Quality calculates the Analytics metrics, the data quality dimensions, and the data product quality score - [Check categories](https://docs.synq.io/analytics/check-categories.md): Classify every check into governance and technical categories so analytics, coverage, and reporting stay consistent across your data stack - [Query activity](https://docs.synq.io/query-activity/overview.md): See who queries your warehouse and through which tool, how each table is built and read, and how popular every asset is - [Lineage overview](https://docs.synq.io/lineage/lineage.md) - [Column-level lineage](https://docs.synq.io/lineage/column-level-lineage.md) - [Looker](https://docs.synq.io/bi-integrations/looker.md): Integrating Looker with Coalesce Quality - [Tableau](https://docs.synq.io/bi-integrations/tableau.md): Integrating Tableau with Coalesce Quality - [Omni](https://docs.synq.io/bi-integrations/omni.md): Integrating Omni with Coalesce Quality - [BigQuery](https://docs.synq.io/dw-integrations/bigquery.md): Integrating BigQuery with Coalesce Quality - [ClickHouse](https://docs.synq.io/dw-integrations/clickhouse.md): Integrating ClickHouse with Coalesce Quality - [Databricks](https://docs.synq.io/dw-integrations/databricks.md): Integrating Databricks with Coalesce Quality - [Microsoft Fabric](https://docs.synq.io/dw-integrations/fabric.md): Integrating Microsoft Fabric with Coalesce Quality - [Redshift](https://docs.synq.io/dw-integrations/redshift.md): Integrating Redshift with Coalesce Quality - [Snowflake](https://docs.synq.io/dw-integrations/snowflake.md): Integrating Snowflake with Coalesce Quality - [Trino](https://docs.synq.io/dw-integrations/trino.md): Integrating Trino and Starburst with Coalesce Quality - [DWH Agent](https://docs.synq.io/dw-integrations/agent.md): Integrating to databases via on-premise installed Coalesce Quality agent - [MotherDuck](https://docs.synq.io/dw-integrations/motherduck.md): Integrating MotherDuck with Coalesce Quality - [Postgres](https://docs.synq.io/transactional-databases/postgres.md): Integrating Postgres with Coalesce Quality - [MySQL](https://docs.synq.io/transactional-databases/mysql.md): Integrating MySQL and MariaDB with Coalesce Quality - [Microsoft SQL Server](https://docs.synq.io/transactional-databases/mssql.md): Integrating Microsoft SQL Server with Coalesce Quality - [Oracle](https://docs.synq.io/transactional-databases/oracle.md): Integrating Oracle Database with Coalesce Quality - [IBM Db2](https://docs.synq.io/transactional-databases/db2.md): Integrating IBM Db2 for Linux, UNIX and Windows with Coalesce Quality - [Code Integration Requirements](https://docs.synq.io/code-integrations/overview.md): Requirements and supported Git providers for code integrations - [GitHub Integration](https://docs.synq.io/code-integrations/github.md): Connect GitHub repositories to Coalesce Quality with the GitHub App or a deploy key - [GitLab Integration](https://docs.synq.io/code-integrations/gitlab.md): Add deploy keys to GitLab projects for Coalesce Quality - [Bitbucket Integration](https://docs.synq.io/code-integrations/bitbucket.md): Add deploy keys to Bitbucket repositories for Coalesce Quality - [Azure DevOps Integration](https://docs.synq.io/code-integrations/azure-devops.md): Add SSH keys to Azure DevOps Repos for Coalesce Quality - [Other Git Providers](https://docs.synq.io/code-integrations/ssh-git.md): Add deploy keys to self-hosted and other SSH-based Git providers - [dbt Core](https://docs.synq.io/dbt-integrations/dbt-core.md): Integrating dbt Core with Coalesce Quality - [dbt Cloud](https://docs.synq.io/dbt-integrations/dbt-cloud.md): Integrating dbt Cloud with Coalesce Quality - [Coalesce Quality options for dbt](https://docs.synq.io/dbt-integrations/synq-options.md): Customize how dbt resources appear in Coalesce Quality using meta configuration - [SQLMesh](https://docs.synq.io/sqlmesh-integrations/sqlmesh.md): Integrating SQLMesh with Coalesce Quality - [Coalesce Transform](https://docs.synq.io/coalesce-integrations/coalesce-transform.md): Connect Coalesce Quality with your Transform workspace for pipeline monitoring and lineage - [Coalesce Catalog](https://docs.synq.io/coalesce-integrations/coalesce-catalog.md): Connect Coalesce Quality with your Catalog workspace for bidirectional metadata sync - [Airflow](https://docs.synq.io/orchestration-integrations/airflow.md): Integrating Airflow with Coalesce Quality - [Airflow + dbt Core Linking](https://docs.synq.io/orchestration-integrations/airflow-dbt-core.md): Link dbt models to Airflow tasks and view orchestration context - [Slack](https://docs.synq.io/alert-integrations/slack.md): Integrating Slack with Coalesce Quality - [Email](https://docs.synq.io/alert-integrations/email.md): Integrating Email with Coalesce Quality - [Microsoft Teams](https://docs.synq.io/alert-integrations/ms-teams.md) - [PagerDuty](https://docs.synq.io/alert-integrations/pagerduty.md): Integrating PagerDuty with Coalesce Quality - [Opsgenie](https://docs.synq.io/alert-integrations/opsgenie.md) - [Atlan](https://docs.synq.io/catalogs/atlan.md): Integrating Atlan with Coalesce Quality - [Google Cloud Storage](https://docs.synq.io/gcp-integrations/cloud-storage.md): Automatically discover and track GCS buckets in Coalesce Quality - [Google Cloud Pub/Sub](https://docs.synq.io/gcp-integrations/pubsub.md): Automatically discover and track Pub/Sub topics and subscriptions in Coalesce Quality - [Single Sign-On (SSO)](https://docs.synq.io/admin/sso.md): Connect your identity provider so your team signs in to Coalesce Quality with your organization’s credentials - [Inviting new users](https://docs.synq.io/admin/invite_user.md) - [User roles](https://docs.synq.io/admin/user_roles.md) - [Monitor Usage](https://docs.synq.io/admin/monitor-usage.md) - [Security Policy](https://docs.synq.io/security/security.md) - [Subprocessors](https://docs.synq.io/security/subprocessors.md) - [Data Warehouse Access](https://docs.synq.io/security/dwh-access.md): How queries from Coalesce Quality authenticate to your data warehouse, and the per-capability toggles that gate them - [Private Connectivity](https://docs.synq.io/security/private-connectivity.md): Connect Coalesce Quality to your data warehouse over AWS PrivateLink or Azure Private Link instead of the public internet - [IP Whitelist](https://docs.synq.io/security/ip.md): Egress IP addresses that need to be whitelisted in your firewall for database connectivity - [Coalesce Quality Support](https://docs.synq.io/support/support.md) - [Getting Started](https://docs.synq.io/api-reference/getting-started.md): Getting started with the Coalesce Quality developer API - [API Scopes](https://docs.synq.io/api-reference/scopes.md): Scopes for Coalesce Quality API clients and API tokens, and the public API methods each scope allows - [ParseYaml](https://docs.synq.io/api-reference/synqagentreconv1yamlservice/parseyaml.md): Parse a YAML config string into a ReconciliationSuite proto. Only the suite configuration fields are extracted (connections are ignored). - [RenderYaml](https://docs.synq.io/api-reference/synqagentreconv1yamlservice/renderyaml.md): Render a ReconciliationSuite proto as a YAML config string. - [ValidateSuite](https://docs.synq.io/api-reference/synqagentreconv1yamlservice/validatesuite.md): Check a suite and give all the problems that it finds. Each problem has the path of its field. ValidateSuite does not save the suite, so an editor can call it after each change. - [Update](https://docs.synq.io/api-reference/synqalertsservicesv1alertsservice/update.md): Update an existing alert configuration. The config can be identified by either ID or FQN. - [Create](https://docs.synq.io/api-reference/synqalertsservicesv1alertsservice/create.md): Create a new alert configuration. - [Delete](https://docs.synq.io/api-reference/synqalertsservicesv1alertsservice/delete.md): Delete an existing alert configuration. The config can be identified by either ID or FQN. - [BatchGet](https://docs.synq.io/api-reference/synqalertsservicesv1alertsservice/batchget.md): Get multiple alert configurations by their identifiers. - [List](https://docs.synq.io/api-reference/synqalertsservicesv1alertsservice/list.md): Retrieves a list of alert configurations based on filters. - [ToggleEnabled](https://docs.synq.io/api-reference/synqalertsservicesv1alertsservice/toggleenabled.md): Enables or disables an existing alert configuration. The config can be identified by either ID or FQN. - [Upsert](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/upsert.md): Creates the alert when no alert holds `fqn`, otherwise replaces the stored alert with the state given here in a single write. Use it to make a stored alert match a declared state, e.g. when deploying alerts from configuration as code. See UpsertRequest for which fields cannot change. - [Create](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/create.md): Create a new alert configuration. - [Delete](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/delete.md): Delete an existing alert configuration. The config can be identified by either ID or FQN. - [BatchGet](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/batchget.md): Get multiple alert configurations by their identifiers. - [GetIncidentOwnerAlert](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/getincidentowneralert.md): Reports whether the workspace's incident-owner alert is on. This alert has no other configuration and does not appear in List or BatchGet; turn it on or off with ToggleIncidentOwnerAlert. - [ToggleIncidentOwnerAlert](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/toggleincidentowneralert.md): Turns the workspace's incident-owner alert on or off. This alert notifies each incident's owner on its configured channels and has no other configuration, so it is managed here rather than through Create / Delete and does not appear in List or BatchGet. Read its current state with GetIncidentOwn… - [List](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/list.md): Retrieves a list of alert configurations based on filters. - [Rename](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/rename.md): Rename an existing alert configuration. The config can be identified by either ID or FQN. - [UpdateSettings](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/updatesettings.md): Update the trigger and/or the kind-specific settings of an alert. The config can be identified by either ID or FQN. - [UpdateTargets](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/updatetargets.md): Replace the delivery targets of an existing alert configuration. The config can be identified by either ID or FQN. - [UpdateTemplate](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/updatetemplate.md): Set or clear the message template of an existing alert configuration. The config can be identified by either ID or FQN. - [SendTestAlert](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/sendtestalert.md): Delivers a static test message to the given targets so you can confirm that delivery reaches each channel before relying on a real alert. Nothing is stored and the targets need not belong to a saved alert, so this can be called while an alert is still being authored. - [ToggleEnabled](https://docs.synq.io/api-reference/synqalertsservicesv2alertsservice/toggleenabled.md): Enables or disables an existing alert configuration. The config can be identified by either ID or FQN. - [List](https://docs.synq.io/api-reference/synqentitieschangesv1changesservice/list.md): Retrieves the complete change history for specified entities. Returns all change types (git commits, schema changes, SQL changes) in chronological order (newest first). Changes include lineage context showing upstream_distance when changes affect dependencies. - [BatchChange](https://docs.synq.io/api-reference/synqentitieschangesv1changesservice/batchchange.md): Get 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. - [ListCode](https://docs.synq.io/api-reference/synqentitiescodev1codeservice/listcode.md): List all code artifacts associated with a specific entity. This includes SQL queries, Python scripts, dbt models, and other code configurations that define or are part of the entity's functionality. - [GetTableConstraints](https://docs.synq.io/api-reference/synqentitiesconstraintsv1tableconstraintsservice/gettableconstraints.md): Get table constraints (primary keys, foreign keys, indexes, etc.) for a given entity. - [BatchIdsByCoordinates](https://docs.synq.io/api-reference/synqentitiescoordinatesv1databasecoordinatesservice/batchidsbycoordinates.md): Given database FQN return possible entity ids. - [BatchDatabaseCoordinates](https://docs.synq.io/api-reference/synqentitiescoordinatesv1databasecoordinatesservice/batchdatabasecoordinates.md): Get multiple DatabaseCoordinates for identifiers. - [TriggerDatachecks](https://docs.synq.io/api-reference/synqdatachecksv1triggerservice/triggerdatachecks.md): Run the datachecks of the specified entities. - [ListSqlTestDeploymentRules](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsdeploymentrulesservice/listsqltestdeploymentrules.md) - [BatchDeleteSqlTestDeploymentRules](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsdeploymentrulesservice/batchdeletesqltestdeploymentrules.md) - [BatchDeploySqlTestDeploymentRules](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsdeploymentrulesservice/batchdeploysqltestdeploymentrules.md) - [BatchGetSqlTestDeploymentRules](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsdeploymentrulesservice/batchgetsqltestdeploymentrules.md) - [DeploySqlTestDeploymentRule](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsdeploymentrulesservice/deploysqltestdeploymentrule.md): Deploy (create or update) a SqlTestDeploymentRule and immediately sync tests onto its current match set. - [GetSqlTestDeployOverview](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsdeploymentrulesservice/getsqltestdeployoverview.md): Preview the effect of deploying a rule (which have not yet been saved), without deploying it. - [DeleteSqlTestDeploymentRule](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsdeploymentrulesservice/deletesqltestdeploymentrule.md) - [GetSqlTestDeployDeleteOverview](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsdeploymentrulesservice/getsqltestdeploydeleteoverview.md): Preview the effect of deleting a rule, without deleting it. - [ListSqlTests](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsservice/listsqltests.md): List SqlTests for given annotations. - [BatchUpsertSqlTests](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsservice/batchupsertsqltests.md): Upsert SqlTests based on a unique ID. - [BatchDeleteSqlTests](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsservice/batchdeletesqltests.md): Delete SqlTests by their IDs. - [BatchGetSqlTests](https://docs.synq.io/api-reference/synqdatacheckssqltestsv1sqltestsservice/batchgetsqltests.md): Get SqlTests by their IDs. - [BatchGetTestSuggestionsForEntities](https://docs.synq.io/api-reference/synqdatacheckstestsuggestionsv1testsuggestionsservice/batchgettestsuggestionsforentities.md) - [BatchCreateTestSuggestions](https://docs.synq.io/api-reference/synqdatacheckstestsuggestionsv1testsuggestionsservice/batchcreatetestsuggestions.md) - [BatchAcceptTestSuggestions](https://docs.synq.io/api-reference/synqdatacheckstestsuggestionsv1testsuggestionsservice/batchaccepttestsuggestions.md) - [BatchRejectTestSuggestions](https://docs.synq.io/api-reference/synqdatacheckstestsuggestionsv1testsuggestionsservice/batchrejecttestsuggestions.md) - [List](https://docs.synq.io/api-reference/synqdataproductsv1dataproductsservice/list.md): List all the dataproducts in the current scope. - [Upsert](https://docs.synq.io/api-reference/synqdataproductsv1dataproductsservice/upsert.md): Create or update a dataproduct. - [SetDefinition](https://docs.synq.io/api-reference/synqdataproductsv1dataproductsservice/setdefinition.md): Set the definition for an existing dataproduct. - [UpsertDefinitionPart](https://docs.synq.io/api-reference/synqdataproductsv1dataproductsservice/upsertdefinitionpart.md): Upsert definition part to the definition of an existing dataproduct. - [RemoveDefinitionPart](https://docs.synq.io/api-reference/synqdataproductsv1dataproductsservice/removedefinitionpart.md): Remove definition part from the definition of an existing dataproduct. - [Delete](https://docs.synq.io/api-reference/synqdataproductsv1dataproductsservice/delete.md): Delete a dataproduct by its identifier. Soft deletes by default. Optionally purge the dataproduct to release the identifier. - [Get](https://docs.synq.io/api-reference/synqdataproductsv1dataproductsservice/get.md): Get multiple dataproducts by their identifiers. - [List](https://docs.synq.io/api-reference/synqdataproductsv2dataproductsservice/list.md): List the data products in the workspace, paginated. Narrow with `folder` and `priorities`. - [Upsert](https://docs.synq.io/api-reference/synqdataproductsv2dataproductsservice/upsert.md): Create or update a data product. The id is supplied by the caller (a UUID); repeating the same request converges to the same product. Mutable fields are optional: a set field is written, an omitted field is left unchanged. Pass `etag` to guard against overwriting a concurrent edit. - [BatchGet](https://docs.synq.io/api-reference/synqdataproductsv2dataproductsservice/batchget.md): Fetch multiple data products by id. Ids that do not exist (or, unless `include_deleted` is set, are deleted) are omitted from the response rather than causing an error. - [Delete](https://docs.synq.io/api-reference/synqdataproductsv2dataproductsservice/delete.md): Delete a data product. Idempotent — deleting an already-deleted or unknown product succeeds. Soft-deletes by default; set `purge` to hard-delete and release the id. Pass `etag` to guard against deleting a concurrently-edited product. - [SetDefinition](https://docs.synq.io/api-reference/synqdataproductsv2dataproductsservice/setdefinition.md): Replace the entire membership definition of a data product. - [UpsertDefinitionPart](https://docs.synq.io/api-reference/synqdataproductsv2dataproductsservice/upsertdefinitionpart.md): Add or replace a single definition part (matched by its part id). - [RemoveDefinitionPart](https://docs.synq.io/api-reference/synqdataproductsv2dataproductsservice/removedefinitionpart.md): Remove a single definition part by its part id. Idempotent. - [ListMembers](https://docs.synq.io/api-reference/synqdataproductsv2dataproductsservice/listmembers.md): List the assets that currently belong to a data product, resolved from its definition and returned as opaque entity ids. Paginated. - [IngestTaskResults](https://docs.synq.io/api-reference/synqingestdwhv1dwhservice/ingesttaskresults.md) - [IngestLineage](https://docs.synq.io/api-reference/synqingestdwhv1dwhservice/ingestlineage.md): Push data-flow lineage between warehouse objects (and, optionally, between their columns) into the platform. Send the lineage you extract from the warehouse — for example from Snowflake's GET_LINEAGE — as a batch of directed edges. Use `replace_mode` to choose between an incremental update (MERG… - [IngestObjectInformation](https://docs.synq.io/api-reference/synqingestdwhv1dwhservice/ingestobjectinformation.md) - [IngestObjectMetrics](https://docs.synq.io/api-reference/synqingestdwhv1dwhservice/ingestobjectmetrics.md) - [IngestQueryLogs](https://docs.synq.io/api-reference/synqingestdwhv1dwhservice/ingestquerylogs.md) - [IngestSchemas](https://docs.synq.io/api-reference/synqingestdwhv1dwhservice/ingestschemas.md) - [IngestSqlDefinitions](https://docs.synq.io/api-reference/synqingestdwhv1dwhservice/ingestsqldefinitions.md) - [IngestTableConstraints](https://docs.synq.io/api-reference/synqingestdwhv1dwhservice/ingesttableconstraints.md) - [ListDeliveries](https://docs.synq.io/api-reference/synqdeliveriesv1deliveriesservice/listdeliveries.md): List deliveries, newest event first. With no `integration_id` this is the whole workspace's feed; with one it is that integration's. - [BatchGetDeliveries](https://docs.synq.io/api-reference/synqdeliveriesv1deliveriesservice/batchgetdeliveries.md): Fetch deliveries by id. Ids that do not exist, or have passed out of the retention window, are omitted from the response rather than causing an error. Unlike `ListDeliveries`, this always returns the routing provenance. - [SummariseDeliveries](https://docs.synq.io/api-reference/synqdeliveriesv1deliveriesservice/summarisedeliveries.md): Count deliveries over a window, bucketed by outcome, by skip reason and by HTTP status class. Use it to watch your own delivery failure rate without paging through the feed. - [SendTestDelivery](https://docs.synq.io/api-reference/synqdeliveriesv1deliveriesservice/sendtestdelivery.md): Send a test delivery to an integration, to confirm the endpoint is reachable and that it accepts what is sent. It is always sent, whatever event types the integration subscribes to — a test that silently matches nothing would report the same as a broken endpoint. - [ListAttempts](https://docs.synq.io/api-reference/synqdeliveriesv1deliveriesservice/listattempts.md): List every attempt made for one delivery, oldest first. A delivery is attempted at most ten times, so the result is small and is not paginated. - [Redeliver](https://docs.synq.io/api-reference/synqdeliveriesv1deliveriesservice/redeliver.md): Send an earlier delivery again, to the same integration, with the same event. The replay is a new delivery with its own id, linked to the original through `redelivery_of`, and appears in `ListDeliveries` like any other. - [ListUserDomains](https://docs.synq.io/api-reference/synqdomainsmembersv1domainmembersservice/listuserdomains.md): List domains for the given user. - [SetDefaultUserDomain](https://docs.synq.io/api-reference/synqdomainsmembersv1domainmembersservice/setdefaultuserdomain.md): Set default domain for user. - [ListDomainMembers](https://docs.synq.io/api-reference/synqdomainsmembersv1domainmembersservice/listdomainmembers.md): List domain members. - [AddDomainMembers](https://docs.synq.io/api-reference/synqdomainsmembersv1domainmembersservice/adddomainmembers.md): Add domain members. - [RemoveDomainMembers](https://docs.synq.io/api-reference/synqdomainsmembersv1domainmembersservice/removedomainmembers.md): Remove domain members. - [List](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/list.md): List all the domains in the current workspace. - [Upsert](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/upsert.md): Create or update a domain. - [BatchGet](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/batchget.md): Get multiple domains by their identifiers. - [Delete](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/delete.md): Delete a domain by its identifier. - [GetUsage](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/getusage.md): Report how many domains the workspace uses, split into top-level and sub-domains. - [SetDefinition](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/setdefinition.md): Set the definition for an existing domain. - [UpsertDefinitionPart](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/upsertdefinitionpart.md): Upsert definition part to the definition of an existing domain. - [RemoveDefinitionPart](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/removedefinitionpart.md): Remove definition part from the definition of an existing domain. - [FetchDomainWithSubDomains](https://docs.synq.io/api-reference/synqdomainsv1domainsservice/fetchdomainwithsubdomains.md): Get a domain with its sub-domains - [List](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/list.md): List the domains in the workspace, paginated. Narrow to one level of the hierarchy with `parent_id`. - [Upsert](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/upsert.md): Create or update a domain. The id is supplied by the caller (a UUID); repeating the same request converges to the same domain. Mutable fields are optional: a set field is written, an omitted field is left unchanged. Pass `etag` to guard against overwriting a concurrent edit. - [BatchGet](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/batchget.md): Fetch multiple domains by id. Ids that do not exist (or, unless `include_deleted` is set, are deleted) are omitted from the response rather than causing an error. - [Delete](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/delete.md): Delete a domain. Idempotent — deleting an already-deleted or unknown domain succeeds. Soft-deletes by default; set `purge` to hard-delete and release the id, which is refused while the domain still has sub-domains. Pass `etag` to guard against deleting a concurrently-edited domain. - [GetUsage](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/getusage.md): Report how many domains the workspace uses, split into top-level and sub-domains. - [SetDefinition](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/setdefinition.md): Replace the entire membership definition of a domain. - [UpsertDefinitionPart](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/upsertdefinitionpart.md): Add or replace a single definition part (matched by its part id). - [RemoveDefinitionPart](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/removedefinitionpart.md): Remove a single definition part by its part id. Idempotent. - [ListMembers](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/listmembers.md): List the assets that currently belong to a domain, resolved from its definition — including everything contributed by the data products and domains it references, and by its own sub-domains — and returned as opaque entity ids. Paginated. - [FetchDomainWithSubDomains](https://docs.synq.io/api-reference/synqdomainsv2domainsservice/fetchdomainwithsubdomains.md): Fetch a domain together with its direct sub-domains, keyed by id. - [ListActors](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/listactors.md): List the workspace's actors, the service accounts, tools, people, logins nothing classifies and Coalesce Quality, each with the totals GetActorSummary has for it: its queries and their weights, its reads, inputs and writes, and the entities it read and wrote. A login can be in several actors, suc… - [GetActorSummary](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/getactorsummary.md): Read what one actor read, built and wrote over the window, what its queries cost per compute and platform, and when it works. The actor is asked for by name, so nothing is left out for being Coalesce Quality's own access, a writer's own read or a policy. - [ListEntityActors](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/listentityactors.md): Read who read and wrote each asked entity over the window: the jobs, the service accounts, the tools and the logins. Anyone who reads lineage, and the reliability agent, is served. Only a caller holding the platform users scope sees the logins: any other gets every logins list empty and logins_hid… - [GetActivityOverview](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/getactivityoverview.md): Read a workspace's queries and their cost per group of logins, per platform, and its most read entities. It names groups and entities, never a login or a person. - [ListPersonActivity](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/listpersonactivity.md): Read what one person's logins read and wrote over the window, per entity, direction and measure. What a colleague read is personal data, so a user caller needs the platform users scope from its role, which a Developer and an Admin have. Logins in a service account, and Coalesce Quality's own quer… - [BatchGetPopularity](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/batchgetpopularity.md): Read how popular each asked entity is over the window: its counted reads and writes per measure, and its rank in each pool it has reads in. An entity is answered with the entities it is the same as, such as a dbt model and the table it builds. Every asked id has an answer, an empty one when nothi… - [GetEntityActivitySeries](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/getentityactivityseries.md): Read how access to one entity moves over the window: per direction, a point per UTC hour, a point per day in the asked time zone, and a weekday and hour grid. A direction's total is the sum of its actors in ListEntityActors under the same lens. It names tools, never a login. - [ListAccessSignals](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/listaccesssignals.md): List the entities of the workspace, or of a selection, that one signal names, such as the tables a pipeline builds and nobody reads, or the tables nobody touched. A signal is computed from the window's access on each call, so a service account change shows on the next one. It names entities and t… - [BatchGetEntityUsage](https://docs.synq.io/api-reference/synqentitiesactivityv1alphaactivityservice/batchgetentityusage.md): Read how each asked entity is used over the window, in one line: what loads it, what runs and builds it, what else writes it, and who reads it, such as "loaded by Fivetran, orchestrated by Airflow, transformed by dbt, read by Looker Studio, 3 people and 12 logins". Each role names its actor at th… - [ListAnnotations](https://docs.synq.io/api-reference/synqentitiesannotationsv1annotationsservice/listannotations.md): List all available annotations with their usage counts across entities. - [BatchGetEntityAnnotations](https://docs.synq.io/api-reference/synqentitiesannotationsv1annotationsservice/batchgetentityannotations.md): Read the annotations carried by specific entities. - [ListCheckCategories](https://docs.synq.io/api-reference/synqentitieschecksv1checkscategoriesservice/listcheckcategories.md): List every explicit check category in the caller's workspace. - [DeleteCheckCategories](https://docs.synq.io/api-reference/synqentitieschecksv1checkscategoriesservice/deletecheckcategories.md): Clear the explicit category (both dimensions) for the given checks. Checks fall back to their rule-computed categories afterwards. - [UpsertCheckCategories](https://docs.synq.io/api-reference/synqentitieschecksv1checkscategoriesservice/upsertcheckcategories.md): Set (or replace) the explicit category for one or more checks. Each entry is the complete state for its check, on both dimensions, so an empty `category` / `governance_category` means "no explicit value for that dimension". - [UpsertExecution](https://docs.synq.io/api-reference/synqentitiescustomv1entityexecutionsservice/upsertexecution.md): Record a run of a custom entity, with its status. The status of the run counts toward the status of the entity. Sending a run with the same `created_at`, to the second, replaces it. - [UpsertLogEntry](https://docs.synq.io/api-reference/synqentitiescustomv1entityexecutionsservice/upsertlogentry.md): Record a log message for a custom entity. A log entry does not change the status of the entity. - [UpsertCheckRelationships](https://docs.synq.io/api-reference/synqentitiescustomv1checksrelationshipsservice/upsertcheckrelationships.md): Create or update relationships that attach a check (e.g. a SQL test) to the entities it validates. Idempotent per (check, checked) pair: an existing relationship is updated, otherwise it is created. - [DeleteCheckRelationships](https://docs.synq.io/api-reference/synqentitiescustomv1checksrelationshipsservice/deletecheckrelationships.md): Delete relationships between checks and the entities they validate. Relationships that do not exist are ignored. - [ListCheckRelationships](https://docs.synq.io/api-reference/synqentitiescustomv1checksrelationshipsservice/listcheckrelationships.md): List every relationship that attaches a check to the entities it validates, across the whole workspace. - [ListEntities](https://docs.synq.io/api-reference/synqentitiescustomv1entitiesservice/listentities.md): List the custom entities of the workspace. - [UpsertEntity](https://docs.synq.io/api-reference/synqentitiescustomv1entitiesservice/upsertentity.md): Create or update a custom entity. If the entity does not exist, it is created, otherwise it is updated. Entities are identified by their Identifier in the workspace. - [DeleteEntity](https://docs.synq.io/api-reference/synqentitiescustomv1entitiesservice/deleteentity.md): Delete a custom entity by its identifier. Deleting an entity that does not exist succeeds. - [UpsertEntityFeature](https://docs.synq.io/api-reference/synqentitiescustomv1featuresservice/upsertentityfeature.md): Create or update a feature of a custom entity. A feature is identified by the entity and its `feature_id`: an existing feature with the same pair is replaced, otherwise a new one is created. The custom entity must already exist, and so must any other custom entity that the feature names. - [DeleteEntityFeature](https://docs.synq.io/api-reference/synqentitiescustomv1featuresservice/deleteentityfeature.md): Delete one feature of a custom entity, by the entity and the `feature_id`. The entity itself is kept. Deleting a feature that does not exist succeeds. - [ListEntityFeatures](https://docs.synq.io/api-reference/synqentitiescustomv1featuresservice/listentityfeatures.md): List the features of one entity, or of every custom entity in the workspace when entity_id is left unset. - [UpsertEntitiesGroup](https://docs.synq.io/api-reference/synqentitiescustomv1groupsservice/upsertentitiesgroup.md): Set the entities of a group, and create the group if it does not exist. Every entity in the group must be a custom entity. The entities that were in the group before and are not in the new list are deleted. - [DeleteEntitiesGroup](https://docs.synq.io/api-reference/synqentitiescustomv1groupsservice/deleteentitiesgroup.md): Delete a group by its identifier. The entities of the group are kept. Deleting a group that does not exist succeeds. - [ListEntityGroups](https://docs.synq.io/api-reference/synqentitiescustomv1groupsservice/listentitygroups.md): List the entity groups of the workspace, each with the ids of its entities. - [UpsertRelationships](https://docs.synq.io/api-reference/synqentitiescustomv1relationshipsservice/upsertrelationships.md): Create or update relationships between entities. If the relationship already exists, it will be updated, otherwise it will be created. - [DeleteRelationships](https://docs.synq.io/api-reference/synqentitiescustomv1relationshipsservice/deleterelationships.md): Delete relationships between entities. If the relationship does not exist, it will be ignored. - [ListRelationships](https://docs.synq.io/api-reference/synqentitiescustomv1relationshipsservice/listrelationships.md): List relationships touching the given entities, or every relationship in the workspace when ids is left empty. - [UpsertType](https://docs.synq.io/api-reference/synqentitiescustomv1typesservice/upserttype.md): Create or update a custom entity type. A type is identified by its `type_id` in the workspace: an existing type with the same id and name is replaced, otherwise a new one is created. Upserting a deleted type restores it, under any name. If a live type already uses the `type_id` under another name… - [DeleteType](https://docs.synq.io/api-reference/synqentitiescustomv1typesservice/deletetype.md): Delete a custom entity type by its `type_id`. The request is refused while an entity still uses the type. Deleting a type that does not exist succeeds. - [ListTypes](https://docs.synq.io/api-reference/synqentitiescustomv1typesservice/listtypes.md): List the custom entity types of the workspace. - [Browse](https://docs.synq.io/api-reference/synqentitiesfoldersv1foldersservice/browse.md): Browse the hierarchy one level at a time. With no `parent`, returns the roots (top-level integrations / containers). With a `parent` folder, returns that folder's direct sub-folders and the entity ids of its direct, non-folder members. - [GetFolderOf](https://docs.synq.io/api-reference/synqentitiesfoldersv1foldersservice/getfolderof.md): Given entity ids, return the folder breadcrumb(s) each entity lives in — ordered root first, leaf (immediate parent) last. An entity may appear in more than one hierarchy; the response carries every folder along its containing chain. Compose with `ListMembers` on an entity's immediate parent to… - [ListMembers](https://docs.synq.io/api-reference/synqentitiesfoldersv1foldersservice/listmembers.md): List the entity ids contained in a folder, paginated. Direct members only by default; set `deep = true` to include members of all nested sub-folders. Narrow with `types` and/or `filter`. - [BatchGetPlatformUsers](https://docs.synq.io/api-reference/synqentitiesplatformusersv1alphaplatformusersservice/batchgetplatformusers.md): Read logins by platform user id. Ids no integration declared and with no activity in the window are left out. - [ListLinkSuggestions](https://docs.synq.io/api-reference/synqentitiesplatformusersv1alphaplatformusersservice/listlinksuggestions.md): Suggest which workspace member each unclassified login may belong to, by matching the login against the members the caller passes. Accept a suggestion with synq.users.v1 UsersService.UpsertUserAliases. A login already linked is skipped only when the caller lists its platform_user_id among a membe… - [ListPlatformUsers](https://docs.synq.io/api-reference/synqentitiesplatformusersv1alphaplatformusersservice/listplatformusers.md): List the workspace's logins by their share of the workspace's queries, highest first, then by their share of its activity. The first page carries a summary of the whole window. - [ApplyServiceAccountChanges](https://docs.synq.io/api-reference/synqentitiesplatformusersv1alphaserviceaccountsservice/applyserviceaccountchanges.md): Write a planned change set, all of it or nothing. It is refused with FAILED_PRECONDITION when the token is not from a plan of exactly this change set against the workspace as it is now: plan it again. A change to an account or person link whose etag no longer matches is refused with ABORTED, and… - [BatchGetServiceAccounts](https://docs.synq.io/api-reference/synqentitiesplatformusersv1alphaserviceaccountsservice/batchgetserviceaccounts.md): Read service accounts by id, built-in ids included. Ids that do not exist are left out. - [ListServiceAccounts](https://docs.synq.io/api-reference/synqentitiesplatformusersv1alphaserviceaccountsservice/listserviceaccounts.md): List every workspace service account, then every built-in one, in the order they apply, and the person links in a second list. - [PlanServiceAccountChanges](https://docs.synq.io/api-reference/synqentitiesplatformusersv1alphaserviceaccountsservice/planserviceaccountchanges.md): Report what a change set would change, without writing it: every login slice whose classification moves, how many counted reads each adds or removes, and the entities whose rank moves most. The plan_token it returns is what ApplyServiceAccountChanges takes. - [ListServiceAccountSuggestions](https://docs.synq.io/api-reference/synqentitiesplatformusersv1alphaserviceaccountsservice/listserviceaccountsuggestions.md): Suggest service accounts for the logins the evidence says are not a person, each as a change set with its evidence. A login a workspace account, a person link or Coalesce Quality takes is left out, and so is a login with no queries in the window. A login a built-in account holds is suggested only… - [BatchGetTableInfo](https://docs.synq.io/api-reference/synqentitiestableinfov1alphatableinfoservice/batchgettableinfo.md): Warehouse facts about tables and views: owner, creation time, row count, size, last modification and a link to the object in the warehouse console. - [ListEntityTraitDefs](https://docs.synq.io/api-reference/synqentitiestypedefsv1typedefsservice/listentitytraitdefs.md): List every trait a selection query can filter entities by. - [ListEntityTypeDefs](https://docs.synq.io/api-reference/synqentitiestypedefsv1typedefsservice/listentitytypedefs.md): List every kind of entity in your workspace, the built-in types and your own. - [ListExecutionTypeDefs](https://docs.synq.io/api-reference/synqentitiestypedefsv1typedefsservice/listexecutiontypedefs.md): List every kind of run Coalesce Quality records against an entity. - [ListPlatformDefs](https://docs.synq.io/api-reference/synqentitiestypedefsv1typedefsservice/listplatformdefs.md): List every platform Coalesce Quality connects to, with its display name. - [ListEntities](https://docs.synq.io/api-reference/synqentitiesentitiesv1entitiesservice/listentities.md): List entities matching the given filter - [BatchGetEntities](https://docs.synq.io/api-reference/synqentitiesentitiesv1entitiesservice/batchgetentities.md): Get multiple entities by their identifiers. - [SearchEntities](https://docs.synq.io/api-reference/synqentitiesentitiesv1entitiesservice/searchentities.md): Search for entities. - [UpsertCheckCategories](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategoriesservice/upsertcheckcategories.md): Set the category of one or more checks explicitly. An explicit category is authoritative for its check: it overrides both the producer-declared category and anything the categorisation rules compute, and it survives every later rule change. - [BatchGetCheckCategories](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategoriesservice/batchgetcheckcategories.md): Read the categories of specific checks. Ids that do not exist are omitted from the response rather than causing an error, so a partially-stale list of ids still returns what it can. - [DeleteCheckCategories](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategoriesservice/deletecheckcategories.md): Clear the explicit categories of one or more checks, on both dimensions. Each check falls back to its producer-declared or rule-computed category. Idempotent — clearing a check that has no explicit category succeeds. - [ListCategorisationFilters](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategoriesservice/listcategorisationfilters.md): List the attribute values the workspace's checks actually have — the platforms, entity types, packages and kinds available to build a categorisation rule or a listing filter from. - [ListCheckCategories](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategoriesservice/listcheckcategories.md): List the workspace's checks with their resolved categories. Returns every check by default; the filters combine, so one call answers questions like "which dbt tests still have no governance category" or "which checks did this rule categorise". - [ListCategories](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategoriesservice/listcategories.md): List the workspace's category vocabulary: the category names in use on each dimension, whether a workspace or platform rule produces each one, and how many checks carry it. Use it to populate a category picker so a workspace converges on one spelling per concept, and to see how much of the works… - [UpsertRule](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategorisationrulesservice/upsertrule.md): Create or update a categorisation rule. - [BatchGetRules](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategorisationrulesservice/batchgetrules.md): Read specific rules by id — typically to resolve the `rule_id` a ResolvedCategory carries into the rule that produced it. Ids the caller cannot see, or that do not exist, are omitted from the response rather than causing an error. - [DeleteRule](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategorisationrulesservice/deleterule.md): Delete a categorisation rule. Checks the rule categorised fall back to the next rule that matches them, or become uncategorised. Idempotent — deleting an already-deleted or unknown rule succeeds. Pass `etag` to guard against deleting a concurrently-edited rule. - [ListRules](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategorisationrulesservice/listrules.md): List the rules that apply to the caller's workspace — its own rules plus the platform-provided ones — in the order they are tried. Narrow with `dimension` and `scope`. - [ListRuleMatches](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategorisationrulesservice/listrulematches.md): Report how many checks each rule currently categorises, with a sample of them — the state already applied, not a projection. Use it to show "categorises N checks" next to each rule, and to spot a rule that has stopped matching anything. For the full, paginated list of one rule's checks, call Che… - [PreviewRule](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategorisationrulesservice/previewrule.md): Report what a candidate rule would change, without saving it. - [GetRecategorisationStatus](https://docs.synq.io/api-reference/synqentitieschecksv2checkscategorisationrulesservice/getrecategorisationstatus.md): Progress of the re-categorisation sweep a rule change schedules. The sweep normally completes in seconds, so this is how to confirm that the workspace's existing checks have caught up with the new rules — not something a client has to wait on. - [UpsertExecution](https://docs.synq.io/api-reference/synqentitiesexecutionsv1entityexecutionsservice/upsertexecution.md): Record a run of a custom entity, with its status. The status of the run counts toward the status of the entity. Sending a run with the same `created_at`, to the second, replaces it. - [UpsertLogEntry](https://docs.synq.io/api-reference/synqentitiesexecutionsv1entityexecutionsservice/upsertlogentry.md): Record a log message for a custom entity. A log entry does not change the status of the entity. - [BatchGetExecutions](https://docs.synq.io/api-reference/synqentitiesexecutionsv2entityexecutionsservice/batchgetexecutions.md): Get multiple executions by their IDs. This is useful when you already know the execution IDs and want to fetch their details. - [GetLatestExecutions](https://docs.synq.io/api-reference/synqentitiesexecutionsv2entityexecutionsservice/getlatestexecutions.md): Get the most recent execution of each specified entity. IMPORTANT: Only returns executions where the entity appears in EntityExecution.entities (what executed). This means it returns executions OF the entity (e.g., model runs, monitor runs, task runs), NOT executions that merely reference the ent… - [ListExecutions](https://docs.synq.io/api-reference/synqentitiesexecutionsv2entityexecutionsservice/listexecutions.md): List the executions of one or more entities, paginated. Executions are returned in reverse chronological order (newest first). - [GetExecutionsSummary](https://docs.synq.io/api-reference/synqentitiesexecutionsv2entityexecutionsservice/getexecutionssummary.md): Get aggregated statistics about the executions of the specified entities. This is useful for quickly understanding execution patterns without fetching all execution details. - [Get](https://docs.synq.io/api-reference/synqextensionsatlanintegrationsv1atlanintegrationservice/get.md) - [Upsert](https://docs.synq.io/api-reference/synqextensionsatlanintegrationsv1atlanintegrationservice/upsert.md): Upserts an integration and validates it by checking if the provided API URL and token are valid. - [Remove](https://docs.synq.io/api-reference/synqextensionsatlanintegrationsv1atlanintegrationservice/remove.md) - [Activate](https://docs.synq.io/api-reference/synqextensionsatlanintegrationsv1atlanintegrationservice/activate.md): Activate or deactivate the integration. - [Ping](https://docs.synq.io/api-reference/synqextensionsatlanintegrationsv1atlanintegrationservice/ping.md): Pings Atlan with the given connection credentials. - [GetAtlanConnections](https://docs.synq.io/api-reference/synqextensionsatlanproviderv1atlanproviderservice/getatlanconnections.md) - [GetAtlanDataProducts](https://docs.synq.io/api-reference/synqextensionsatlanproviderv1atlanproviderservice/getatlandataproducts.md) - [GetAtlanDomains](https://docs.synq.io/api-reference/synqextensionsatlanproviderv1atlanproviderservice/getatlandomains.md) - [GetConnectionMappings](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/getconnectionmappings.md) - [SetConnectionMappings](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/setconnectionmappings.md) - [RemoveConnectionMappings](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/removeconnectionmappings.md) - [GetDomainMappings](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/getdomainmappings.md) - [GetMappingToggles](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/getmappingtoggles.md) - [SetMappingToggles](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/setmappingtoggles.md) - [GetProductMappings](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/getproductmappings.md) - [FetchRuns](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/fetchruns.md) - [Synchronize](https://docs.synq.io/api-reference/synqextensionsatlanworkflowsv1atlanworkflowservice/synchronize.md): Run a synchronization job for the integration. - [SubmitFeatureRequest](https://docs.synq.io/api-reference/synqagentsrev1featurerequestservice/submitfeaturerequest.md): Submit a feature request to the Coalesce Quality product team. This method should only be called as a last resort when the user's request cannot be fulfilled by any existing tool. It logs the request for product team review. - [GetDiffByChangeId](https://docs.synq.io/api-reference/synqgitcommitsv1commitsservice/getdiffbychangeid.md) - [GetDiffByCommit](https://docs.synq.io/api-reference/synqgitcommitsv1commitsservice/getdiffbycommit.md) - [Iam](https://docs.synq.io/api-reference/synqauthiamv1iamservice/iam.md): Return information about how the caller is authenticated. - [GetImpact](https://docs.synq.io/api-reference/synqentitiesimpactv1impactservice/getimpact.md) - [ListIncidents](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/listincidents.md) - [CreateIncident](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/createincident.md) - [BatchGetIncidents](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/batchgetincidents.md) - [AssignIncidentOwner](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/assignincidentowner.md) - [CancelIncident](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/cancelincident.md): Cancel an incident - [CloseIncident](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/closeincident.md): Close an incident - [PostComment](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/postcomment.md): Post a comment on an incident. - [DeleteComment](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/deletecomment.md): Delete a comment on an incident. Only the actor who posted the comment may delete it. Deleting an already-deleted comment succeeds. - [AddIssuesToIncident](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/addissuestoincident.md) - [RemoveIssuesFromIncident](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/removeissuesfromincident.md) - [MergeIncidents](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/mergeincidents.md) - [RenameIncident](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/renameincident.md) - [SplitIncident](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/splitincident.md) - [UpdateIncidentState](https://docs.synq.io/api-reference/synqincidentsv1incidentsservice/updateincidentstate.md) - [IngestDatahubAspects](https://docs.synq.io/api-reference/synqingestairflowv1airflowlogsservice/ingestdatahubaspects.md): Accepts what a DataHub REST emitter sends when its server is set to `/api/ingest/airflow/v1`: it posts to `{server}/aspects?action=ingestProposal`. - [IngestLog](https://docs.synq.io/api-reference/synqingestairflowv1airflowlogsservice/ingestlog.md) - [IngestCloudwatchLogsData](https://docs.synq.io/api-reference/synqingestcloudwatchv1cloudwatchservice/ingestcloudwatchlogsdata.md) - [Ingest](https://docs.synq.io/api-reference/synqingestopenlineagev1openlineageservice/ingest.md) - [ListIntegrations](https://docs.synq.io/api-reference/synqintegrationsv1integrationsservice/listintegrations.md): List all integrations in the workspace (optionally filtered by enabled state). Secret config fields are masked. The full set is returned in one response — a workspace has only a handful of integrations. - [CreateIntegration](https://docs.synq.io/api-reference/synqintegrationsv1integrationsservice/createintegration.md): Create a new integration. The server assigns the id and returns the created integration including any generated outputs. - [BatchGetIntegrations](https://docs.synq.io/api-reference/synqintegrationsv1integrationsservice/batchgetintegrations.md): Fetch multiple integrations by id in one call. Ids not found (or not in the workspace) are omitted from the response rather than erroring. - [UpdateIntegration](https://docs.synq.io/api-reference/synqintegrationsv1integrationsservice/updateintegration.md): Update an integration. The `config` is replaced wholesale — send the complete desired config (omitted secrets are preserved; see the service-level secret semantics). `title` is patch-style: omit it to leave it unchanged. - [DeleteIntegration](https://docs.synq.io/api-reference/synqintegrationsv1integrationsservice/deleteintegration.md): Delete an integration. The integration stops being scheduled and is removed from listings. Safe to retry (deleting an already-deleted id is a no-op). - [DisableIntegration](https://docs.synq.io/api-reference/synqintegrationsv1integrationsservice/disableintegration.md): Disable an integration without deleting it. The configuration is kept but the integration is no longer scheduled or refreshed. No-op if already disabled. - [EnableIntegration](https://docs.synq.io/api-reference/synqintegrationsv1integrationsservice/enableintegration.md): Enable a previously disabled integration. No-op if already enabled. - [RefreshIntegration](https://docs.synq.io/api-reference/synqintegrationsv1integrationsservice/refreshintegration.md): Trigger an immediate, ad-hoc refresh of an integration. Available only for types whose `Capabilities.can_refresh` is true; otherwise rejected with FAILED_PRECONDITION. - [ListIssues](https://docs.synq.io/api-reference/synqissuesissuesv1issuesservice/listissues.md) - [BatchGetIssues](https://docs.synq.io/api-reference/synqissuesissuesv1issuesservice/batchgetissues.md) - [PostComment](https://docs.synq.io/api-reference/synqissuesissuesv1issuesservice/postcomment.md): Post a comment on an issue. - [MarkExpected](https://docs.synq.io/api-reference/synqissuesissuesv1issuesservice/markexpected.md): Mark issue as expected. - [MarkFixed](https://docs.synq.io/api-reference/synqissuesissuesv1issuesservice/markfixed.md): Mark issue as fixed. - [MarkInvestigating](https://docs.synq.io/api-reference/synqissuesissuesv1issuesservice/markinvestigating.md): Mark issue as being investigated. - [MarkNoActionNeeded](https://docs.synq.io/api-reference/synqissuesissuesv1issuesservice/marknoactionneeded.md): Mark issue as no action needed. - [ListIssues](https://docs.synq.io/api-reference/synqissuesv2issuesservice/listissues.md) - [BatchGetIssues](https://docs.synq.io/api-reference/synqissuesv2issuesservice/batchgetissues.md) - [ClearStatus](https://docs.synq.io/api-reference/synqissuesv2issuesservice/clearstatus.md): Clear the triage status of an issue, returning it to an untriaged state. Reverses a previous MarkInvestigating / MarkFixed / MarkExpected / MarkNoActionNeeded so the issue shows up again in open/untriaged views. - [PostComment](https://docs.synq.io/api-reference/synqissuesv2issuesservice/postcomment.md): Post a comment on an issue. - [DeleteComment](https://docs.synq.io/api-reference/synqissuesv2issuesservice/deletecomment.md): Delete a comment on an issue. Only the actor who posted the comment may delete it. Deleting an already-deleted comment succeeds. - [MarkExpected](https://docs.synq.io/api-reference/synqissuesv2issuesservice/markexpected.md): Mark issue as expected. - [MarkFixed](https://docs.synq.io/api-reference/synqissuesv2issuesservice/markfixed.md): Mark issue as fixed. - [MarkInvestigating](https://docs.synq.io/api-reference/synqissuesv2issuesservice/markinvestigating.md): Mark issue as being investigated. - [MarkNoActionNeeded](https://docs.synq.io/api-reference/synqissuesv2issuesservice/marknoactionneeded.md): Mark issue as no action needed. - [BatchGetEntityKnowledge](https://docs.synq.io/api-reference/synqknowledgev1alphaknowledgeservice/batchgetentityknowledge.md): Read the knowledge held about entities: the description people wrote for each one, and the knowledge pages pinned to it. - [ListKnowledgePages](https://docs.synq.io/api-reference/synqknowledgev1alphaknowledgeservice/listknowledgepages.md): List the ids of knowledge pages, ordered by name, optionally narrowed by a part of their name and by certification. Deprecated pages are left out unless asked for. Read the pages with `BatchGetKnowledgePages`. - [BatchGetKnowledgePages](https://docs.synq.io/api-reference/synqknowledgev1alphaknowledgeservice/batchgetknowledgepages.md): Read knowledge pages by id: their content, where they sit in the tree, who owns them and how they are tagged. A page that does not exist, or was deleted, is absent from the response. Set `skip_content` to read everything but the content, for showing a listing. - [ListKnowledgePageLinks](https://docs.synq.io/api-reference/synqknowledgev1alphaknowledgeservice/listknowledgepagelinks.md): List what is pinned to a knowledge page, in either direction: the ids of the entities and of the other knowledge pages. - [ListFolds](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/listfolds.md): List the ids of every fold in the workspace, switched off ones included, oldest first. Read the folds with `BatchGetFolds`. - [CreateFold](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/createfold.md): Create a fold. Repeating the same request returns the fold it created; creating a different fold under an id already in use is refused with ALREADY_EXISTS. - [BatchGetFolds](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/batchgetfolds.md): Read folds by id. An id with no fold is absent from the response. - [BatchGetFoldNodes](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/batchgetfoldnodes.md): Read fold nodes by entity id: which fold a node in a lineage response stands for, and which entities it showed. An id is answered for as long as lineage may still return it; an id with nothing to answer is absent from the response. - [PreviewFold](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/previewfold.md): Show what a matcher would fold, before it is saved: how many entities and lineage edges it matches, a sample of them, and the entities that stop being shown on the same node as a folded one. Answered from the lineage the workspace has now, without any fold applied. - [DeleteFold](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/deletefold.md): Delete a fold. Deleting a fold that does not exist succeeds. - [SetFoldEnabled](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/setfoldenabled.md): Switch a fold on or off. A fold switched off is kept and listed, and lineage shows the entities it matched as their own nodes again. - [UpdateFoldMatcher](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/updatefoldmatcher.md): Change which entities a fold matches. The fold's node keeps its entity id. - [RenameFold](https://docs.synq.io/api-reference/synqentitieslineagefoldsv1alphalineagefoldsservice/renamefold.md): Change the name shown on a fold's node. - [GetLineage](https://docs.synq.io/api-reference/synqentitieslineagev1lineageservice/getlineage.md) - [GetDeployOverview](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/getdeployoverview.md) - [DeleteDeploymentRule](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/deletedeploymentrule.md) - [GetDeployDeleteOverview](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/getdeploydeleteoverview.md) - [ListDeploymentRules](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/listdeploymentrules.md) - [UpsertDeploymentRule](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/upsertdeploymentrule.md) - [BatchUpdateDeploymentRuleTitle](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/batchupdatedeploymentruletitle.md) - [BatchGetDeploymentRules](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/batchgetdeploymentrules.md) - [BatchUpsertDeploymentRules](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/batchupsertdeploymentrules.md) - [BatchDeleteDeploymentRules](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/batchdeletedeploymentrules.md) - [BatchDeployDeploymentRules](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/batchdeploydeploymentrules.md) - [DeployDeploymentRule](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/deploydeploymentrule.md) - [ListDeploymentRulesForAsset](https://docs.synq.io/api-reference/synqmonitorsautomated_monitorsv1deploymentrulesservice/listdeploymentrulesforasset.md) - [ListMonitors](https://docs.synq.io/api-reference/synqmonitorscustom_monitorsv1custommonitorsservice/listmonitors.md) - [BatchUpdateMonitor](https://docs.synq.io/api-reference/synqmonitorscustom_monitorsv1custommonitorsservice/batchupdatemonitor.md) - [BatchCreateMonitor](https://docs.synq.io/api-reference/synqmonitorscustom_monitorsv1custommonitorsservice/batchcreatemonitor.md) - [ListConfigsMonitors](https://docs.synq.io/api-reference/synqmonitorscustom_monitorsv1custommonitorsservice/listconfigsmonitors.md) - [ConfigChangesOverview](https://docs.synq.io/api-reference/synqmonitorscustom_monitorsv1custommonitorsservice/configchangesoverview.md) - [BatchDeleteMonitor](https://docs.synq.io/api-reference/synqmonitorscustom_monitorsv1custommonitorsservice/batchdeletemonitor.md) - [BatchUpdateMonitorMode](https://docs.synq.io/api-reference/synqmonitorscustom_monitorsv1custommonitorsservice/batchupdatemonitormode.md) - [BatchUpdateMonitorSeverity](https://docs.synq.io/api-reference/synqmonitorscustom_monitorsv1custommonitorsservice/batchupdatemonitorseverity.md) - [History](https://docs.synq.io/api-reference/synqmonitorshistoryv1historyservice/history.md) - [MonitorInfo](https://docs.synq.io/api-reference/synqmonitorsinfov1monitorinfoservice/monitorinfo.md) - [GetMonitorPredictions](https://docs.synq.io/api-reference/synqmonitorspredictionsv1monitorpredictionsservice/getmonitorpredictions.md): Returns prediction timeseries for a monitor. The monitor must exist and not be deleted. Defaults to the monitor's current metrics_version. - [GetEntityMetrics](https://docs.synq.io/api-reference/synqmonitorspredictionsv1monitorpredictionsservice/getentitymetrics.md): Returns raw metric timeseries for an entity. Identity-aware: resolves logical assets (e.g., dbt models) to their underlying physical tables. - [BatchGetLatestEntityMetrics](https://docs.synq.io/api-reference/synqmonitorspredictionsv1monitorpredictionsservice/batchgetlatestentitymetrics.md): Returns the most recent observed table-stats sample (row count, freshness) for each requested entity. Identity-aware: resolves logical assets to their underlying physical tables. Paths with no recent sample are omitted from the response rather than returned with empty values — callers should trea… - [ListMonitorSegments](https://docs.synq.io/api-reference/synqmonitorssegmentsv1monitorsegmentsservice/listmonitorsegments.md): Lists the segments a monitor has ingested so far, with their raw value and current label. A segment appears only once data has been observed for it, so a monitor that has not run yet lists none. - [BatchUpdateMonitorSegmentLabels](https://docs.synq.io/api-reference/synqmonitorssegmentsv1monitorsegmentsservice/batchupdatemonitorsegmentlabels.md): Sets or clears the label of one or more segments. - [BatchOrchestration](https://docs.synq.io/api-reference/synqentitiesorchestrationv1orchestrationservice/batchorchestration.md): Return, for each requested entity, the jobs, job steps and tasks that ran it in the last 31 days (upstream), and the entities it ran (downstream). - [BatchGetEntityOverlays](https://docs.synq.io/api-reference/synqoverlaysv1overlaysservice/batchgetentityoverlays.md): For each entity, list every overlay that claims it. - [ListEntityCoverage](https://docs.synq.io/api-reference/synqoverlaysv1overlaysservice/listentitycoverage.md): List the candidate assets together with the overlays claiming each, and narrow them to what is or is not covered. - [GetCoverageSummary](https://docs.synq.io/api-reference/synqoverlaysv1overlaysservice/getcoveragesummary.md): Count coverage over one or more named candidate sets, without listing the assets themselves. - [BatchGetOverlayMemberCounts](https://docs.synq.io/api-reference/synqoverlaysv1overlaysservice/batchgetoverlaymembercounts.md): Count the members of each named overlay. - [ListOwners](https://docs.synq.io/api-reference/synqownersv1ownersservice/listowners.md): List the owners in the workspace, paginated. - [UpsertOwner](https://docs.synq.io/api-reference/synqownersv1ownersservice/upsertowner.md): Create or update an owner. The id is supplied by the caller (a UUID); repeating the same request converges to the same owner. Mutable fields are optional: a set field is written, an omitted field is left unchanged. Pass `etag` to guard against overwriting a concurrent edit. - [BatchGetOwners](https://docs.synq.io/api-reference/synqownersv1ownersservice/batchgetowners.md): Fetch multiple owners by id. Ids that do not exist (or, unless `include_deleted` is set, are deleted) are omitted from the response rather than causing an error. - [DeleteOwner](https://docs.synq.io/api-reference/synqownersv1ownersservice/deleteowner.md): Delete an owner and all of its ownerships. Idempotent — deleting an already-deleted or unknown owner succeeds. Soft-deletes by default; set `purge` to hard-delete and release the id. Pass `etag` to guard against deleting a concurrently-edited owner. - [BatchGetOwnerships](https://docs.synq.io/api-reference/synqownersv1ownersservice/batchgetownerships.md): Fetch multiple ownerships by id (across owners). Ids that do not exist (or, unless `include_deleted` is set, are deleted) are omitted. - [DeleteOwnership](https://docs.synq.io/api-reference/synqownersv1ownersservice/deleteownership.md): Delete an ownership by id. Idempotent — deleting an already-deleted or unknown ownership succeeds. Pass `etag` to guard against deleting a concurrently-edited ownership. - [ListOwnerships](https://docs.synq.io/api-reference/synqownersv1ownersservice/listownerships.md): List the ownerships of an owner, paginated. - [UpsertOwnership](https://docs.synq.io/api-reference/synqownersv1ownersservice/upsertownership.md): Create or update an ownership under an owner. The ownership id is supplied by the caller (a UUID). Assigning a data product that is already owned by a different ownership moves it (the previous ownership of that product is removed), matching the app. - [SetPlatformAuthentication](https://docs.synq.io/api-reference/synqplatformsv1platformsservice/setplatformauthentication.md) - [DescribeResolverQl](https://docs.synq.io/api-reference/synqqueriesv1queriesservice/describeresolverql.md): Describe the ResolverQL this deployment accepts: every function with its arguments and documentation, the category order to group them by, and the accepted values of every enum-typed argument. - [ResolveQuery](https://docs.synq.io/api-reference/synqqueriesv1queriesservice/resolvequery.md): Evaluate a selection and return the matched entity ids, paginated. Pass a ResolverQL expression via `resolver_ql` (it is compiled server-side) or an already-structured `query`. Invalid ResolverQL fails with INVALID_ARGUMENT. - [TranslateResolverQl](https://docs.synq.io/api-reference/synqqueriesv1queriesservice/translateresolverql.md): Compile a ResolverQL expression into a structured public `Query`. Unlike `ResolveQuery`, it does not evaluate the query against the catalog. A syntactically invalid or uncompilable expression fails with INVALID_ARGUMENT. - [GenerateQuery](https://docs.synq.io/api-reference/synqqueriesv1nlqueryservice/generatequery.md): Generate a Query from a natural language description. - [ListRecommendations](https://docs.synq.io/api-reference/synqrecommendationsv1recommendationsservice/listrecommendations.md): List the ids of the workspace's recommendations, optionally limited by target and state. Fetch the recommendations themselves with `BatchGetRecommendations`. Ids are returned in a stable order, so paging is consistent while recommendations are added or removed. - [BatchGetRecommendations](https://docs.synq.io/api-reference/synqrecommendationsv1recommendationsservice/batchgetrecommendations.md): Fetch recommendations by id. Ids that are unknown, belong to another workspace, no longer exist because the condition cleared, concern an integration the credential cannot read, or are of a kind not released to the caller are omitted from the response rather than erroring. - [DismissRecommendation](https://docs.synq.io/api-reference/synqrecommendationsv1recommendationsservice/dismissrecommendation.md): Dismiss a recommendation until something new is found about it. Replaces an ignore. Dismissing again records the recommendation as it reads now, so it stays hidden until something newer than that is found. - [IgnoreRecommendation](https://docs.synq.io/api-reference/synqrecommendationsv1recommendationsservice/ignorerecommendation.md): Ignore a recommendation for good, whatever is found about it later. Replaces a dismissal. Ignoring an ignored recommendation succeeds without change. - [RestoreRecommendation](https://docs.synq.io/api-reference/synqrecommendationsv1recommendationsservice/restorerecommendation.md): Remove the dismissal or ignore standing against a recommendation, so it is open again. Restoring a recommendation nobody decided about succeeds without change. - [TriggerDeployment](https://docs.synq.io/api-reference/synqagentreconv1suitedeploymentservice/triggerdeployment.md): Trigger an on-demand execution of a promoted deployment. Enqueues a run using the frozen suite snapshot and connection mappings stored on the deployment row — execution uses platform integration credentials, not the caller's. Returns the freshly-allocated `run_id` so callers can poll RunStateSer… - [BatchResolveIdentifiers](https://docs.synq.io/api-reference/synqentitiesresolvev1identifierresolveservice/batchresolveidentifiers.md): Resolve multiple identifiers, returning their Coalesce Quality paths and identity groups. - [Upsert](https://docs.synq.io/api-reference/synqsavedviewsv1savedviewsservice/upsert.md): Create or update a saved view. - [BatchGet](https://docs.synq.io/api-reference/synqsavedviewsv1savedviewsservice/batchget.md): Fetch multiple saved views by id. Ids the caller cannot see, or that do not exist, are omitted from the response rather than causing an error. - [Delete](https://docs.synq.io/api-reference/synqsavedviewsv1savedviewsservice/delete.md): Delete a saved view. Idempotent — deleting an already-deleted or unknown view succeeds. Pass `etag` to guard against deleting a concurrently-edited view. - [List](https://docs.synq.io/api-reference/synqsavedviewsv1savedviewsservice/list.md): List the saved views the calling user can see. By default returns every visible view (their own, workspace-owned, shared-with-workspace and granted-to-them); narrow with `scopes`, `context` and `only_pinned`. - [SetPin](https://docs.synq.io/api-reference/synqsavedviewsv1savedviewsservice/setpin.md): Pin or unpin a saved view to the calling user's main screen. Pinning is a per-user preference: it applies only to the caller and does not modify the view or its version, so any user who can see a view may pin it. - [PreviewSchedules](https://docs.synq.io/api-reference/synqschedulev1scheduleservice/previewschedules.md): Return the next occurrences for one or more schedule expressions. Never fails at the RPC level; per-schedule errors are returned in the response items. Response items match request items by index. - [BatchSchemaMismatches](https://docs.synq.io/api-reference/synqentitiesschemasv1schemamismatchesservice/batchschemamismatches.md): Get schema mismatches for a batch of entities by their identifiers. - [GetSchema](https://docs.synq.io/api-reference/synqentitiesschemasv1schemasservice/getschema.md): Get the schema of an entity by its identifier. - [ListSqlConstructs](https://docs.synq.io/api-reference/synqentitiessql_insightsv1sqlinsightsservice/listsqlconstructs.md): Return the distribution of SQL constructs across all entities in the workspace. Every count is a number of entities, not a number of occurrences: an entity whose SQL contains five GROUP BY clauses adds one to the HAS_GROUP_BY count, not five. The result is workspace-scoped (derived from the auth… - [BatchSqlDetails](https://docs.synq.io/api-reference/synqentitiessql_insightsv1sqlinsightsservice/batchsqldetails.md): Return the SQL details for each of the requested entities, keyed by their Coalesce Quality path: the set of detected SQL constructs and, when the request asks for them, the joins that building the entity makes. Every requested path appears in the response, including a path with no SQL details an… - [ListJoinPatterns](https://docs.synq.io/api-reference/synqentitiessql_insightsv1sqlinsightsservice/listjoinpatterns.md): List how other SQL joins a table, or one of its columns: every join key that the SQL of a table, view or model in the workspace uses to join the requested entity, read from the requested entity's side, and which SQL makes it. It is the reverse of `BatchSqlDetails` joins, which say how building o… - [Evaluate](https://docs.synq.io/api-reference/synqagentsrev1llmservice/evaluate.md): Evaluates an LLM request with a structured output schema and message history. The main prompt should be constant as it will be cached for efficiency. - [BatchGetIncidents](https://docs.synq.io/api-reference/synqentitiesstatusv1entityincidentsservice/batchgetincidents.md): Get the open incidents of multiple entities, and optionally of their upstream entities. - [BatchGetIssuesStatus](https://docs.synq.io/api-reference/synqentitiesstatusv1entityissuesservice/batchgetissuesstatus.md): Get the issues status of multiple entities, and optionally of their upstream entities. - [BatchLatestConclusions](https://docs.synq.io/api-reference/synqagentsrev1triageservice/batchlatestconclusions.md): Retrieves the latest triage conclusion, with its evidence, for one or more issues. - [MarkFailed](https://docs.synq.io/api-reference/synqagentsrev1triageservice/markfailed.md): Marks an issue as failed triaging. This method is used by the LLM agent to indicate that it was unable to triage. - [MarkAsInProgress](https://docs.synq.io/api-reference/synqagentsrev1triageservice/markasinprogress.md): Marks an issue as in progress. This method is used by the LLM agent to indicate that it has started working on an issue. - [BatchTriageState](https://docs.synq.io/api-reference/synqagentsrev1triageservice/batchtriagestate.md): Retrieves the triage state for one or more issues. This method is used by the LLM agent to retrieve the current state of the issues it is working on. - [ListTriageState](https://docs.synq.io/api-reference/synqagentsrev1triageservice/listtriagestate.md): Lists the triage states of the workspace's issues that have one of the given statuses, newest first. - [Conclude](https://docs.synq.io/api-reference/synqagentsrev1triageservice/conclude.md): Concludes the triage investigation for one or more issues by providing a structured conclusion and supporting evidence. This method is used by the LLM agent to finalize its investigation. - [RecordEvidence](https://docs.synq.io/api-reference/synqagentsrev1triageservice/recordevidence.md): Records evidence collected during the triage investigation. This method allows the LLM agent to incrementally add evidence as it discovers information during the investigation process. - [ListUsers](https://docs.synq.io/api-reference/synqusersv1usersservice/listusers.md) - [GetUserAliases](https://docs.synq.io/api-reference/synqusersv1usersservice/getuseraliases.md) - [UpsertUserAliases](https://docs.synq.io/api-reference/synqusersv1usersservice/upsertuseraliases.md): Links aliases to users. A platform user alias needs SCOPE_PLATFORM_USER_LINK, every other alias type SCOPE_USER_EDIT. A request holding an alias the caller may not write is refused as a whole, and nothing is written. - [DeleteUserAliases](https://docs.synq.io/api-reference/synqusersv1usersservice/deleteuseraliases.md): Removes aliases from users. A platform user alias removes only that login, every other alias type removes the user's alias of that type. The scopes are checked per alias, as for UpsertUserAliases. - [BatchGetUsers](https://docs.synq.io/api-reference/synqusersv1usersservice/batchgetusers.md) - [GetByAlias](https://docs.synq.io/api-reference/synqusersv1usersservice/getbyalias.md) - [GetByEmail](https://docs.synq.io/api-reference/synqusersv1usersservice/getbyemail.md) - [GetUserIdentities](https://docs.synq.io/api-reference/synqusersv1usersservice/getuseridentities.md): Returns all canonical identity strings for a user. If user_id is omitted, returns identities for the currently authenticated user. These identity strings can be passed to ListIssues(interacted_by_identities) to filter issues the user has interacted with. Format: "synq:", "email:"… - [AddUserRole](https://docs.synq.io/api-reference/synqusersv1usersservice/adduserrole.md): Grants a role to a user in the workspace. Granting a role the user already holds succeeds without change. Granting a role to a user who is not a member of the workspace makes them a member; such a user can only be named by their synq or email identity. - [RemoveUserRole](https://docs.synq.io/api-reference/synqusersv1usersservice/removeuserrole.md): Withdraws a role from a user in the workspace. Withdrawing a role the user does not hold succeeds without change. Withdrawing the user's last role removes them from the workspace, together with their linked aliases. - [API](https://docs.synq.io/api-reference/api.md) - [Examples](https://docs.synq.io/api-reference/examples.md) - [Custom Integrations](https://docs.synq.io/custom-integrations/overview.md): Put a tool Coalesce Quality has no integration for into the catalog yourself, with lineage, schemas, checks and run status - [Modelling Your Tool](https://docs.synq.io/custom-integrations/modelling.md): Choosing entity types, traits and the right lineage mechanism for each hop in your tool's graph - [Building an Integration](https://docs.synq.io/custom-integrations/building-an-integration.md): From credentials to a verified graph: the steps a custom integration runs, in order, in Go and Python - [API Surface](https://docs.synq.io/custom-integrations/api-surface.md): Every service a custom integration calls, the scope each method needs, and the limits that apply - [Agent Workflow](https://docs.synq.io/custom-integrations/agent-workflow.md): A self-contained brief for a coding agent writing a custom integration against the Coalesce Quality API - [Using Webhooks](https://docs.synq.io/api-reference/webhook.md): Getting started with developer API at Coalesce Quality - [Debugging Deliveries](https://docs.synq.io/api-reference/webhook-deliveries.md): See what Coalesce Quality sent to your webhook, PagerDuty or Opsgenie integration, why a notification did not arrive, and replay it ## OpenAPI Specs - [openapi](/api-reference/openapi.yaml) ## Optional - [Blog](https://coalesce.io/resources/) - [Changelog](https://synq.io/changelog) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.