Services

ScheduleService

(synq.schedule.v1.ScheduleService) ScheduleService provides schedule evaluation utilities.

PreviewSchedules

PreviewSchedules (PreviewSchedulesRequest) PreviewSchedulesResponse PreviewSchedules returns 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.

PlatformsService

(synq.platforms.v1.PlatformsService) PlatformsService is a service for managing Platforms and Integrations.

SetPlatformAuthentication

SetPlatformAuthentication (SetPlatformAuthenticationRequest) SetPlatformAuthenticationResponse

CommitsService

(synq.git.commits.v1.CommitsService)

GetDiffByChangeId

GetDiffByChangeId (GetDiffByChangeIdRequest) GetDiffByChangeIdResponse

GetDiffByCommit

GetDiffByCommit (GetDiffByCommitRequest) GetDiffByCommitResponse

OwnersService

(synq.owners.v1.OwnersService) OwnersService manages owners and their ownerships — the “alert routing as code” surface. An owner is a named responsible party with notification channels (contacts); an ownership assigns a set of assets to an owner and configures the alerts routed to it. Owner is the resource, ownership its sub-resource: an ownership is meaningless without its owner, and deleting an owner deletes its ownerships. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on the Upsert calls: a set field is written, an omitted field is left unchanged. Pass the etag you last read to guard against overwriting a concurrent edit. Related: synq.dataproducts.v2.DataproductsService (an ownership can own a whole data product), synq.alerts.v1.AlertsService (how the configured alerts are reported), and synq.users.v1.UsersService (resolve the users behind UserContact and Slack/Teams mentions).

UpsertOwner

UpsertOwner (UpsertOwnerRequest) UpsertOwnerResponse 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

BatchGetOwners (BatchGetOwnersRequest) BatchGetOwnersResponse 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.

ListOwners

ListOwners (ListOwnersRequest) ListOwnersResponse List the owners in the workspace, paginated.

DeleteOwner

DeleteOwner (DeleteOwnerRequest) DeleteOwnerResponse 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.

UpsertOwnership

UpsertOwnership (UpsertOwnershipRequest) UpsertOwnershipResponse 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.

ListOwnerships

ListOwnerships (ListOwnershipsRequest) ListOwnershipsResponse List the ownerships of an owner, paginated.

BatchGetOwnerships

BatchGetOwnerships (BatchGetOwnershipsRequest) BatchGetOwnershipsResponse Fetch multiple ownerships by id (across owners). Ids that do not exist (or, unless include_deleted is set, are deleted) are omitted.

DeleteOwnership

DeleteOwnership (DeleteOwnershipRequest) DeleteOwnershipResponse Delete an ownership by id. Idempotent — deleting an already-deleted or unknown ownership succeeds. Pass etag to guard against deleting a concurrently-edited ownership.

NLQueryService

(synq.queries.v1.NLQueryService) NLQueryService generates structured Query protos from natural language descriptions using an LLM.

GenerateQuery

GenerateQuery (GenerateQueryRequest) GenerateQueryResponse GenerateQuery generates a Query from a natural language description.

IntegrationsService

(synq.integrations.v1.IntegrationsService) IntegrationsService manages connections from Coalesce Quality to your data systems (warehouses, databases, and transformation tools). Concurrency: every integration carries an opaque etag. Read it from GetIntegration / ListIntegrations, then pass it back on UpdateIntegration / DeleteIntegration to ensure you modify the version you last saw. A stale etag is rejected with ABORTED (HTTP 409). Omit the etag for last-write-wins. Quota: each workspace has a limit on the number of integrations. Creating beyond the limit is rejected with RESOURCE_EXHAUSTED. Secrets: credential fields (passwords, tokens, keys) are write-only. They are masked (returned empty) on every read. On update, omit a secret to keep it, send a new value to rotate it, or send an explicit empty string to clear it (where the field is optional).

CreateIntegration

CreateIntegration (CreateIntegrationRequest) CreateIntegrationResponse Create a new integration. The server assigns the id and returns the created integration including any generated outputs. The integration type is fixed by the populated config variant and cannot be changed later. Counts against the per-workspace quota. Not safe to blindly retry: the server mints a new id on each call, so a retried create produces a second integration. On a transport error, list / look up before retrying.

GetIntegration

GetIntegration (GetIntegrationRequest) GetIntegrationResponse Fetch a single integration by id. Secret config fields are masked.

ListIntegrations

ListIntegrations (ListIntegrationsRequest) ListIntegrationsResponse 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.

BatchGetIntegrations

BatchGetIntegrations (BatchGetIntegrationsRequest) BatchGetIntegrationsResponse 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

UpdateIntegration (UpdateIntegrationRequest) UpdateIntegrationResponse 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. The config variant must match the existing integration’s type; changing the type is rejected with FAILED_PRECONDITION. Safe to retry: addresses an existing id and converges to the same state. With an etag set, a retry after success returns ABORTED (the version moved) — treat that as “already applied”.

DeleteIntegration

DeleteIntegration (DeleteIntegrationRequest) DeleteIntegrationResponse 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).

EnableIntegration

EnableIntegration (EnableIntegrationRequest) EnableIntegrationResponse Enable a previously disabled integration. No-op if already enabled.

DisableIntegration

DisableIntegration (DisableIntegrationRequest) DisableIntegrationResponse Disable an integration without deleting it. The configuration is kept but the integration is no longer scheduled or refreshed. No-op if already disabled.

RefreshIntegration

RefreshIntegration (RefreshIntegrationRequest) RefreshIntegrationResponse Trigger an immediate, ad-hoc refresh of an integration. Available only for types whose Capabilities.can_refresh is true; otherwise rejected with FAILED_PRECONDITION. Not idempotent: each call enqueues a new refresh.

GetIntegrationHealth

GetIntegrationHealth (GetIntegrationHealthRequest) GetIntegrationHealthResponse Return current health plus a paginated history of recent runs for an integration. When pagination is omitted, a bounded recent window is returned (the most recent runs from the last 7 days).

IamService

(synq.auth.iam.v1.IamService)

Iam

Iam (IamRequest) IamResponse Iam returns information about caller authentication

AtlanProviderService

(synq.extensions.atlan.provider.v1.AtlanProviderService)

AtlanWorkflowService

(synq.extensions.atlan.workflows.v1.AtlanWorkflowService)

SetConnectionMappings

SetConnectionMappings (SetConnectionMappingsRequest) SetConnectionMappingsResponse

RemoveConnectionMappings

RemoveConnectionMappings (RemoveConnectionMappingsRequest) RemoveConnectionMappingsResponse

GetConnectionMappings

GetConnectionMappings (GetConnectionMappingsRequest) GetConnectionMappingsResponse

GetProductMappings

GetProductMappings (GetProductMappingsRequest) GetProductMappingsResponse

GetDomainMappings

GetDomainMappings (GetDomainMappingsRequest) GetDomainMappingsResponse

Synchronize

Synchronize (SynchronizeRequest) SynchronizeResponse Run a synchronization job for the integration.

FetchRuns

FetchRuns (FetchRunsRequest) FetchRunsResponse

SetMappingToggles

SetMappingToggles (SetMappingTogglesRequest) SetMappingTogglesResponse

GetMappingToggles

GetMappingToggles (GetMappingTogglesRequest) GetMappingTogglesResponse

AtlanIntegrationService

(synq.extensions.atlan.integrations.v1.AtlanIntegrationService)

Upsert

Upsert (UpsertRequest) UpsertResponse Upserts an integration and validates it by checking if the provided API URL and token are valid.

Ping

Ping (PingRequest) PingResponse Pings Atlan with the given connection credentials.

Get

Get (GetRequest) GetResponse

Remove

Remove (RemoveRequest) RemoveResponse

Activate

Activate (ActivateRequest) ActivateResponse Activate or deactivate the integration.

IssuesService

(synq.issues.v2.IssuesService) IssuesService is a service for managing Issues.

BatchGetIssues

BatchGetIssues (BatchGetIssuesRequest) BatchGetIssuesResponse

ListIssues

ListIssues (ListIssuesRequest) ListIssuesResponse

MarkInvestigating

MarkInvestigating (MarkInvestigatingRequest) MarkInvestigatingResponse Mark issue as being investigated.

MarkFixed

MarkFixed (MarkFixedRequest) MarkFixedResponse Mark issue as fixed.

MarkExpected

MarkExpected (MarkExpectedRequest) MarkExpectedResponse Mark issue as expected.

MarkNoActionNeeded

MarkNoActionNeeded (MarkNoActionNeededRequest) MarkNoActionNeededResponse Mark issue as no action needed.

ClearStatus

ClearStatus (ClearStatusRequest) ClearStatusResponse 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

PostComment (PostCommentRequest) PostCommentResponse Post a comment on an issue.

IssuesService

(synq.issues.issues.v1.IssuesService) IssuesService is a service for managing Issues.

BatchGetIssues

BatchGetIssues (BatchGetIssuesRequest) BatchGetIssuesResponse

ListIssues

ListIssues (ListIssuesRequest) ListIssuesResponse

MarkInvestigating

MarkInvestigating (MarkInvestigatingRequest) MarkInvestigatingResponse Mark issue as being investigated.

MarkFixed

MarkFixed (MarkFixedRequest) MarkFixedResponse Mark issue as fixed.

MarkExpected

MarkExpected (MarkExpectedRequest) MarkExpectedResponse Mark issue as expected.

MarkNoActionNeeded

MarkNoActionNeeded (MarkNoActionNeededRequest) MarkNoActionNeededResponse Mark issue as no action needed.

PostComment

PostComment (PostCommentRequest) PostCommentResponse Post a comment on an issue.

AlertsService

(synq.alerts.services.v1.AlertsService) AlertsService provides operations for managing alert configurations.

Create

Create (CreateRequest) CreateResponse Create a new alert configuration.

List

List (ListRequest) ListResponse Retrieves a list of alert configurations based on filters.

BatchGet

BatchGet (BatchGetRequest) BatchGetResponse Get multiple alert configurations by their identifiers.

Update

Update (UpdateRequest) UpdateResponse Update an existing alert configuration. The config can be identified by either ID or FQN.

Delete

Delete (DeleteRequest) DeleteResponse Delete an existing alert configuration. The config can be identified by either ID or FQN.

ToggleEnabled

ToggleEnabled (ToggleEnabledRequest) ToggleEnabledResponse Enables or disables an existing alert configuration. The config can be identified by either ID or FQN.

ConnectionsService

(synq.agent.dwh.v1.ConnectionsService) ConnectionsService provides methods for managing data warehouse connections. These connections represent data warehouse integrations configured in Coalesce Quality that can be used by:

DWH Agent: For metadata extraction and data quality monitoring
Coalesce Quality Scout: On-premise AI agent for data exploration and analysis Both agents share the same or very similar configuration file format.

ListConnections

ListConnections (ListConnectionsRequest) ListConnectionsResponse ListConnections retrieves data warehouse connections for a workspace. Converts Coalesce Quality integration configurations to a standardized connection format. Requires workspace context in the request metadata.

GenerateConnectionsYaml

GenerateConnectionsYaml (GenerateConnectionsYamlRequest) GenerateConnectionsYamlResponse GenerateConnectionsYaml converts data warehouse connections to YAML configuration format. The generated YAML can be used directly as a config file for DWH Agent or Coalesce Quality Scout. Secret fields are replaced with environment variable placeholders (e.g., ${CONNECTION_ID_PASSWORD}). Documentation: https://docs.synq.io/dw-integrations/agent#config-file-schema

DwhAgentService

(synq.agent.dwh.v1.DwhAgentService)

Connect

Connect (ConnectRequest) ConnectResponse buf:lint:ignore RPC_NO_CLIENT_STREAMING

AuditLogService

(synq.agent.recon.v1.AuditLogService) AuditLogService provides methods to ingest and query reconciliation audit logs.

IngestAuditLog

IngestAuditLog (IngestAuditLogRequest) IngestAuditLogResponse IngestAuditLog stores a reconciliation run audit log.

ListAuditLogs

ListAuditLogs (ListAuditLogsRequest) ListAuditLogsResponse ListAuditLogs returns audit logs ordered from newest to oldest, optionally filtered by suite and time range.

GetAuditLog

GetAuditLog (GetAuditLogRequest) GetAuditLogResponse GetAuditLog returns a single audit log by invocation ID.

SuiteDeploymentService

(synq.agent.recon.v1.SuiteDeploymentService) SuiteDeploymentService is the platform plane of reconciliation. SuiteConfigService is the developer/authoring sandbox (edit, version, run ad-hoc with your own credentials — preview-only, no Entity, no Run, no Issue). A deployment is what SYNQ actually runs on the workspace’s behalf: a frozen snapshot of a suite config, mapped to workspace-level SYNQ integrations, optionally scheduled or triggerable by API. Identity: every deployment has a stable deployment_id (UUIDv7) assigned on first promote. It survives re-promotes, schedule/mapping changes, and pause/resume. Downstream AssetCommand / RunCommand publication keys off deployment_id so Entity identity does not fragment on promote churn.

PromoteSuite

PromoteSuite (PromoteSuiteRequest) PromoteSuiteResponse Promote a suite config into production. Freezes a snapshot of the config and stores the connection → integration mapping. Creates a new deployment on first call; re-promotes the same suite_id (reusing its deployment_id) on subsequent calls.

UnpromoteSuite

UnpromoteSuite (UnpromoteSuiteRequest) UnpromoteSuiteResponse Unpromote a deployment. Marks it inactive; scheduler and API triggers stop. Deployment history is preserved; re-promoting the same suite_id reuses the original deployment_id.

UpdateDeploymentSchedule

UpdateDeploymentSchedule (UpdateDeploymentScheduleRequest) UpdateDeploymentScheduleResponse Change schedule and/or triggerable_by_api on an existing deployment without re-promoting the config snapshot or touching mappings.

UpdateDeploymentMappings

UpdateDeploymentMappings (UpdateDeploymentMappingsRequest) UpdateDeploymentMappingsResponse Rewire connection → integration mappings on an existing deployment without re-promoting the config snapshot.

UpdateDeploymentAnnotations

UpdateDeploymentAnnotations (UpdateDeploymentAnnotationsRequest) UpdateDeploymentAnnotationsResponse Replace the deployment-level annotation overlay on an existing deployment. Annotations are merged with suite-level and case-level annotations from the frozen suite snapshot at promote/update time, then surfaced on PromotedReconSuiteMetadata / PromotedReconCaseMetadata for every asset under the deployment.

UpdateDeploymentCaseImpacts

UpdateDeploymentCaseImpacts (UpdateDeploymentCaseImpactsRequest) UpdateDeploymentCaseImpactsResponse Patch the per-case CaseFailureImpact map on an existing deployment without re-promoting the suite snapshot. Useful for “apply to all” FE actions and one-off toggles between RAISE_ISSUE_ON_TABLES and SHOW_ON_TABLES. Re-renders PromotedReconCaseMetadata so the error_tables / shown_tables split reflects the new policy immediately. Merge semantics: keys present in the request overwrite the stored value for that case. Keys absent from the request are left untouched (no implicit reset). Sending CASE_FAILURE_IMPACT_UNSPECIFIED clears the override for that case (falls back to the default RAISE_ISSUE_ON_TABLES). Unknown case names are rejected with INVALID_ARGUMENT so the FE catches typos before the deployment is mutated.

PauseDeployment

PauseDeployment (PauseDeploymentRequest) PauseDeploymentResponse Pause a deployment. Scheduled and API-triggered runs are suppressed until until is reached, or indefinitely when until is absent.

ResumeDeployment

ResumeDeployment (ResumeDeploymentRequest) ResumeDeploymentResponse Resume a paused deployment.

GetSuiteDeployment

GetSuiteDeployment (GetSuiteDeploymentRequest) GetSuiteDeploymentResponse Fetch a deployment by suite_id or deployment_id.

ListSuiteDeployments

ListSuiteDeployments (ListSuiteDeploymentsRequest) ListSuiteDeploymentsResponse List deployments for the caller’s workspace. Filters support answering “what is SYNQ running on behalf of this workspace?” and “which deployments use this SYNQ integration?”.

ListSuiteDeploymentHistory

ListSuiteDeploymentHistory (ListSuiteDeploymentHistoryRequest) ListSuiteDeploymentHistoryResponse List the append-only history of a deployment (every promote, re-promote, schedule/mapping change, pause/resume, unpromote).

TriggerDeployment

TriggerDeployment (TriggerDeploymentRequest) TriggerDeploymentResponse 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 RunStateService for status. Preconditions:

Deployment must exist and be active.
Deployment must have triggerable_by_api = true (FAILED_PRECONDITION otherwise).
Deployment must not be paused (FAILED_PRECONDITION when paused_until is set and in the future).

YamlService

(synq.agent.recon.v1.YamlService) YamlService provides stateless conversion between YAML config format and proto. This is useful for UI editors that need to display/edit suite configs as YAML.

ParseYaml

ParseYaml (ParseYamlRequest) ParseYamlResponse ParseYaml parses a YAML config string into a ReconcilationSuite proto. Only the suite configuration fields are extracted (connections are ignored).

RenderYaml

RenderYaml (RenderYamlRequest) RenderYamlResponse RenderYaml renders a ReconcilationSuite proto as a YAML config string.

SuiteConfigService

(synq.agent.recon.v1.SuiteConfigService) SuiteConfigService manages reconciliation suite configurations. Managed suites are long-lived, optionally scheduled configs identified by suite_name. Ad-hoc suites are one-off configs that get a generated UUID as suite_id.

UpsertSuiteConfig

UpsertSuiteConfig (UpsertSuiteConfigRequest) UpsertSuiteConfigResponse Upsert a managed suite config. Creates if new, updates with new version if exists. The suite_id equals the suite name (from ReconcilationSuite.name). Validates the ReconcilationSuite proto. Does NOT validate connections exist.

SubmitAdhocSuite

SubmitAdhocSuite (SubmitAdhocSuiteRequest) SubmitAdhocSuiteResponse Submit an ad-hoc suite for one-off execution. Provide either an inline suite or a suite_id referencing an existing managed suite. Optionally apply environment overrides before execution. The client-provided invocation_id ensures idempotency.

GetSuiteConfig

GetSuiteConfig (GetSuiteConfigRequest) GetSuiteConfigResponse Get the latest version of a suite config by suite_id. Works for both managed (suite_id = suite_name) and ad-hoc (suite_id = UUID) configs.

ListSuiteConfigs

ListSuiteConfigs (ListSuiteConfigsRequest) ListSuiteConfigsResponse List latest suite configs with filtering and pagination. By default returns only managed suites. Set include_adhoc to also include ad-hoc configs.

DeleteSuiteConfig

DeleteSuiteConfig (DeleteSuiteConfigRequest) DeleteSuiteConfigResponse Delete a managed suite config (soft delete — inserts a deleted version).

ListSuiteConfigVersions

ListSuiteConfigVersions (ListSuiteConfigVersionsRequest) ListSuiteConfigVersionsResponse Get version history for a suite config.

GetSuiteConfigVersion

GetSuiteConfigVersion (GetSuiteConfigVersionRequest) GetSuiteConfigVersionResponse Get a specific historical version of a suite config.

RunStateService

(synq.agent.recon.v1.RunStateService) RunStateService exposes lifecycle status of reconciliation runs. Polling-based read API — clients fetch the current state for one or more suites and display progress. No notifications are emitted; clients re-poll to observe transitions.

BatchReconciliationRunState

BatchReconciliationRunState (BatchReconciliationRunStateRequest) BatchReconciliationRunStateResponse BatchReconciliationRunState returns the latest concluded run and any ongoing (SCHEDULED or IN_PROGRESS) run for each suite_id. Returned map is keyed by suite_id. Suites with no recorded runs are omitted from the response map.

ListReconciliationRunState

ListReconciliationRunState (ListReconciliationRunStateRequest) ListReconciliationRunStateResponse ListReconciliationRunState returns runs filtered by status and/or suite_id. Sorted newest-first by scheduled_at.

CancelReconciliationRun

CancelReconciliationRun (CancelReconciliationRunRequest) CancelReconciliationRunResponse CancelReconciliationRun marks a SCHEDULED or IN_PROGRESS run as CANCELLED so the suite is no longer “occupied” by a stuck occurrence — used to recover from local-dev / executor outages where a run was queued but never executed. Already-terminal runs are returned unchanged. Idempotent: calling on an already-cancelled run is a no-op. Note: this only updates the run-state row. The corresponding execution-job row is independent — when an executor eventually wakes up to that job it will see the run is CANCELLED and skip.

SreAgentService

(synq.agent.sre.v1.SreAgentService)

Connect

Connect (ConnectRequest) ConnectResponse buf:lint:ignore RPC_NO_CLIENT_STREAMING

GetConfig

GetConfig (GetConfigRequest) GetConfigResponse GetConfig returns the Scout configuration (system prompts + DWH connection summary) for the caller’s workspace. Authorized for the agent itself (SCOPE_SRE_AGENT), for any caller with workspace integration-read access (SCOPE_INTEGRATION_READ) so admins / owners can inspect the live prompts via synqctl / fe-app without an agent token, and for MCP read tokens (SCOPE_MCP_READ) — matches the sibling DWH ConnectionsService scope shape.

ListPromptSuggestions

ListPromptSuggestions (ListPromptSuggestionsRequest) ListPromptSuggestionsResponse ListPromptSuggestions returns prompt-improvement suggestions recorded for the caller’s workspace. Default scope is pending suggestions only; set statuses to include accepted / dismissed / superseded rows. Sorted newest first.

AcceptPromptSuggestion

AcceptPromptSuggestion (AcceptPromptSuggestionRequest) AcceptPromptSuggestionResponse AcceptPromptSuggestion applies a pending suggestion to the matching SRE agent prompt field. The applied value is suggested_value unless edited_value is set. Returns FAILED_PRECONDITION when the live prompt has drifted from the suggestion’s baseline_value since it was produced — the client should re-fetch and re-render.

DismissPromptSuggestion

DismissPromptSuggestion (DismissPromptSuggestionRequest) DismissPromptSuggestionResponse DismissPromptSuggestion marks a pending suggestion as dismissed with an optional free-text reason. The SRE agent configuration is left untouched.

RecordPromptSuggestion

RecordPromptSuggestion (RecordPromptSuggestionRequest) RecordPromptSuggestionResponse RecordPromptSuggestion is the producer-side endpoint used by the offline analyser to register a new suggestion for a workspace. The server snapshots the current value of the targeted prompt field as baseline_value. Any pending suggestion for the same (workspace, field) pair is marked as superseded before the new row is inserted. Returns the recorded suggestion, or an empty response when the baseline already matches suggested_value (no-op). Authorized for the agent / offline analyser (SCOPE_SRE_AGENT) and for admins / owners with workspace integration-edit access (SCOPE_INTEGRATION_EDIT), so an admin running synqctl can publish a suggestion against a customer workspace via x-synq-workspace-override without minting an agent token.

LlmService

(synq.agent.sre.v1.LlmService) Service for evaluating LLM requests and producing structured output.

Evaluate

Evaluate (EvaluateRequest) EvaluateResponse 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.

TriageService

(synq.agent.sre.v1.TriageService) Service for managing issue triage operations, allowing LLM agents to conclude investigations and record evidence during the triage process.

Conclude

Conclude (ConcludeRequest) ConcludeResponse 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

RecordEvidence (RecordEvidenceRequest) RecordEvidenceResponse 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.

BatchLatestConclusions

BatchLatestConclusions (BatchLatestConclusionsRequest) BatchLatestConclusionsResponse Retrieves the latest 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.

BatchTriageState

BatchTriageState (BatchTriageStateRequest) BatchTriageStateResponse 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

ListTriageState (ListTriageStateRequest) ListTriageStateResponse 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.

MarkAsInProgress

MarkAsInProgress (MarkAsInProgressRequest) MarkAsInProgressResponse Marks an issue as in progress. This method is used by the LLM agent to indicate that it has started working on an issue.

MarkFailed

MarkFailed (MarkFailedRequest) MarkFailedResponse Marks an issue as failed triaging. This method is used by the LLM agent to indicate that it was unable to triage.

FeatureRequestService

(synq.agent.sre.v1.FeatureRequestService) FeatureRequestService allows MCP clients to submit feature requests when users encounter missing capabilities. This is a last-resort service — it should only be used when no existing tool can fulfill the user’s request.

SubmitFeatureRequest

SubmitFeatureRequest (SubmitFeatureRequestRequest) SubmitFeatureRequestResponse SubmitFeatureRequest submits 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.

TestsSuggestionStateService

(synq.agent.sre.v1.TestsSuggestionStateService)

SuggestFor

SuggestFor (SuggestForRequest) SuggestForResponse

GetActiveSuggestionStatesFor

GetActiveSuggestionStatesFor (GetActiveSuggestionStatesForRequest) GetActiveSuggestionStatesForResponse

BatchSuggestionStates

BatchSuggestionStates (BatchSuggestionStatesRequest) BatchSuggestionStatesResponse

ListSuggestionStates

ListSuggestionStates (ListSuggestionStatesRequest) ListSuggestionStatesResponse

MarkAsRunning

MarkAsRunning (MarkAsRunningRequest) MarkAsRunningResponse

MarkAsCompleted

MarkAsCompleted (MarkAsCompletedRequest) MarkAsCompletedResponse

MarkAsFailed

MarkAsFailed (MarkAsFailedRequest) MarkAsFailedResponse

MarkAsCancelled

MarkAsCancelled (MarkAsCancelledRequest) MarkAsCancelledResponse

UsersService

(synq.users.v1.UsersService)

ListUsers

ListUsers (ListUsersRequest) ListUsersResponse

BatchGetUsers

BatchGetUsers (BatchGetUsersRequest) BatchGetUsersResponse

GetByAlias

GetByAlias (GetByAliasRequest) GetByAliasResponse

GetByEmail

GetByEmail (GetByEmailRequest) GetByEmailResponse

UpsertUserAliases

UpsertUserAliases (UpsertUserAliasesRequest) UpsertUserAliasesResponse

DeleteUserAliases

DeleteUserAliases (DeleteUserAliasesRequest) DeleteUserAliasesResponse

GetUserAliases

GetUserAliases (GetUserAliasesRequest) GetUserAliasesResponse

GetUserIdentities

GetUserIdentities (GetUserIdentitiesRequest) GetUserIdentitiesResponse 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:<user_id>”, “email:<email>”, “slack:<slack_user_id>”, “msteams:<member_id>”, etc.

TriggerService

(synq.datachecks.v1.TriggerService) TriggerService provides synchronous execution of datachecks on entities.

TriggerDatachecks

TriggerDatachecks (TriggerDatachecksRequest) TriggerDatachecksResponse TriggerDatachecks executes datachecks for the specified entities.

TestSuggestionsService

(synq.datachecks.testsuggestions.v1.TestSuggestionsService)

BatchCreateTestSuggestions

BatchCreateTestSuggestions (BatchCreateTestSuggestionsRequest) BatchCreateTestSuggestionsResponse

BatchGetTestSuggestionsForEntities

BatchGetTestSuggestionsForEntities (BatchGetTestSuggestionsForEntitiesRequest) BatchGetTestSuggestionsForEntitiesResponse

BatchAcceptTestSuggestions

BatchAcceptTestSuggestions (BatchAcceptTestSuggestionsRequest) BatchAcceptTestSuggestionsResponse

BatchRejectTestSuggestions

BatchRejectTestSuggestions (BatchRejectTestSuggestionsRequest) BatchRejectTestSuggestionsResponse

SqlTestsService

(synq.datachecks.sqltests.v1.SqlTestsService) SqlTestsService is a service for managing SqlTests.

BatchUpsertSqlTests

BatchUpsertSqlTests (BatchUpsertSqlTestsRequest) BatchUpsertSqlTestsResponse Upsert SqlTests based on a unique ID.

ListSqlTests

ListSqlTests (ListSqlTestsRequest) ListSqlTestsResponse List SqlTests for given annotations.

BatchGetSqlTests

BatchGetSqlTests (BatchGetSqlTestsRequest) BatchGetSqlTestsResponse Get SqlTests by their IDs.

BatchDeleteSqlTests

BatchDeleteSqlTests (BatchDeleteSqlTestsRequest) BatchDeleteSqlTestsResponse Delete SqlTests by their IDs.

GetSqlTestAudit

GetSqlTestAudit (GetSqlTestAuditRequest) GetSqlTestAuditResponse Get SqlTest audit from a given execution ID in jwt token.

MonitorInfoService

(synq.monitors.info.v1.MonitorInfoService)

MonitorInfo

MonitorInfo (MonitorInfoRequest) MonitorInfoResponse

DeploymentRulesService

(synq.monitors.automated_monitors.v1.DeploymentRulesService)

GetDeployOverview

GetDeployOverview (GetDeployOverviewRequest) GetDeployOverviewResponse

GetDeployDeleteOverview

GetDeployDeleteOverview (GetDeployDeleteOverviewRequest) GetDeployDeleteOverviewResponse

DeleteDeploymentRule

DeleteDeploymentRule (DeleteDeploymentRuleRequest) DeleteDeploymentRuleResponse

ListDeploymentRules

ListDeploymentRules (ListDeploymentRulesRequest) ListDeploymentRulesResponse

ListDeploymentRulesForAsset

ListDeploymentRulesForAsset (ListDeploymentRulesForAssetRequest) ListDeploymentRulesForAssetResponse

BatchGetDeploymentRules

BatchGetDeploymentRules (BatchGetDeploymentRulesRequest) BatchGetDeploymentRulesResponse

UpsertDeploymentRule

UpsertDeploymentRule (UpsertDeploymentRuleRequest) UpsertDeploymentRuleResponse

BatchUpdateDeploymentRuleTitle

BatchUpdateDeploymentRuleTitle (BatchUpdateDeploymentRuleTitleRequest) BatchUpdateDeploymentRuleTitleResponse

DeployDeploymentRule

DeployDeploymentRule (DeployDeploymentRuleRequest) DeployDeploymentRuleResponse

BatchDeployDeploymentRules

BatchDeployDeploymentRules (BatchDeployDeploymentRulesRequest) BatchDeployDeploymentRulesResponse

BatchUpsertDeploymentRules

BatchUpsertDeploymentRules (BatchUpsertDeploymentRulesRequest) BatchUpsertDeploymentRulesResponse

BatchDeleteDeploymentRules

BatchDeleteDeploymentRules (BatchDeleteDeploymentRulesRequest) BatchDeleteDeploymentRulesResponse

HistoryService

(synq.monitors.history.v1.HistoryService)

History

History (HistoryRequest) HistoryResponse

CustomMonitorsService

(synq.monitors.custom_monitors.v1.CustomMonitorsService)

BatchCreateMonitor

BatchCreateMonitor (BatchCreateMonitorRequest) BatchCreateMonitorResponse

BatchUpdateMonitor

BatchUpdateMonitor (BatchUpdateMonitorRequest) BatchUpdateMonitorResponse

BatchDeleteMonitor

BatchDeleteMonitor (BatchDeleteMonitorRequest) BatchDeleteMonitorResponse

BatchUpdateMonitorMode

BatchUpdateMonitorMode (BatchUpdateMonitorModeRequest) BatchUpdateMonitorModeResponse

ConfigChangesOverview

ConfigChangesOverview (ConfigChangesOverviewRequest) ConfigChangesOverviewResponse

BatchUpdateMonitorSeverity

BatchUpdateMonitorSeverity (BatchUpdateMonitorSeverityRequest) BatchUpdateMonitorSeverityResponse

ListConfigsMonitors

ListConfigsMonitors (ListConfigsMonitorsRequest) ListConfigsMonitorsResponse

ListMonitors

ListMonitors (ListMonitorsRequest) ListMonitorsResponse

MonitorPredictionsService

(synq.monitors.predictions.v1.MonitorPredictionsService) Access to anomaly detection model predictions and raw metric timeseries.

GetMonitorPredictions

GetMonitorPredictions (GetMonitorPredictionsRequest) GetMonitorPredictionsResponse Returns prediction timeseries for a monitor. The monitor must exist and not be deleted. Defaults to the monitor’s current metrics_version.

GetEntityMetrics

GetEntityMetrics (GetEntityMetricsRequest) GetEntityMetricsResponse Returns raw metric timeseries for an entity. Identity-aware: resolves logical assets (e.g., dbt models) to their underlying physical tables.

BatchGetLatestEntityMetrics

BatchGetLatestEntityMetrics (BatchGetLatestEntityMetricsRequest) BatchGetLatestEntityMetricsResponse 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 treat a missing entry as “no data”. Lookback matches GetEntityMetrics (30 days).

IdentifierResolveService

(synq.entities.resolve.v1.IdentifierResolveService) IdentifierResolveService resolves identifiers to their Coalesce Quality paths and identities.

BatchResolveIdentifiers

BatchResolveIdentifiers (BatchResolveIdentifiersRequest) BatchResolveIdentifiersResponse Resolve multiple identifiers, returning their Coalesce Quality paths and identity groups.

DatabaseCoordinatesService

(synq.entities.coordinates.v1.DatabaseCoordinatesService) DatabaseCoordinatesService is a service for getting database coordinates of Entities.

BatchDatabaseCoordinates

BatchDatabaseCoordinates (BatchDatabaseCoordinatesRequest) BatchDatabaseCoordinatesResponse Get multiple DatabaseCoordinates for identifiers.

BatchIdsByCoordinates

BatchIdsByCoordinates (BatchIdsByCoordinatesRequest) BatchIdsByCoordinatesResponse Given database FQN return possible entity ids.

LineageService

(synq.entities.lineage.v1.LineageService) LineageService allows you to fetch:

Entity level lineage from a starting point of one or more entities.
Column Level lineage from a starting point of multiple columns of a single entity.

GetLineage

GetLineage (GetLineageRequest) GetLineageResponse

ImpactService

(synq.entities.impact.v1.ImpactService)

GetImpact

GetImpact (GetImpactRequest) GetImpactResponse

AnnotationsService

(synq.entities.annotations.v1.AnnotationsService) AnnotationsService provides operations for managing and querying entity annotations. Annotations are key-value pairs that can be attached to entities for categorization and filtering.

ListAnnotations

ListAnnotations (ListAnnotationsRequest) ListAnnotationsResponse List all available annotations with their usage counts across entities.

ChangesService

(synq.entities.changes.v1.ChangesService) ChangesService provides functionality to track and retrieve all types of changes to data entities. This unified service returns ALL change types for an entity:

Git commits: Changes to code files (dbt models, SQL files) tracked in version control
Schema changes: Database schema modifications (columns added/removed/changed)
SQL definition changes: View/materialized view definition updates detected by Coalesce Quality

Changes are returned with structured metadata including:

For git commits: structured statistics (directories, file types, top changes)
For schema changes: detailed column-level diffs
For SQL changes: before/after SQL definitions

Use cases:

“What changed in the last week for table X?” → Returns git commits, schema changes, SQL changes
“Show me all commits affecting this dbt model” → Returns git commits with lineage context
“What schema changes happened to this table?” → Returns schema changes detected by Coalesce Quality

List

List (ListRequest) ListResponse 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

BatchChange (BatchChangeRequest) BatchChangeResponse 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.

EntityIssuesService

(synq.entities.status.v1.EntityIssuesService) EntityIssuesService is the service which retrieves entity issues status.

GetIssuesStatus

GetIssuesStatus (GetIssuesStatusRequest) GetIssuesStatusResponse Get specific entity status by its identifier.

BatchGetIssuesStatus

BatchGetIssuesStatus (BatchGetIssuesStatusRequest) BatchGetIssuesStatusResponse Get multiple entity statuses by their identifiers.

EntityIncidentsService

(synq.entities.status.v1.EntityIncidentsService) EntityIncidentsService is the service which retrieves entity status.

GetIncidents

GetIncidents (GetIncidentsRequest) GetIncidentsResponse Get specific entity status by its identifier.

BatchGetIncidents

BatchGetIncidents (BatchGetIncidentsRequest) BatchGetIncidentsResponse Get multiple entity statuses by their identifiers.

OrchestrationService

(synq.entities.orchestration.v1.OrchestrationService) OrchestrationService provides information about orchestration relationships between entities. This includes relationships between Airflow tasks and transformation models (dbt, SQLMesh), as well as task-to-task dependencies.

BatchOrchestration

BatchOrchestration (BatchOrchestrationRequest) BatchOrchestrationResponse BatchOrchestration retrieves orchestration relationships for multiple entities. For each entity, it returns both upstream entities (what orchestrates it) and downstream entities (what it orchestrates).

ChecksCategoriesService

(synq.entities.checks.v1.ChecksCategoriesService) ChecksCategoriesService lets workspace admins set explicit category overrides on individual checks. An explicit category is the authoritative category for a check — it takes precedence over the categories computed by the workspace’s categorisation rules. It is a public API so customers can manage check categories programmatically; the same service is also mounted on the internal API. The workspace and the acting identity are always taken from the request context, never from the payload.

UpsertCheckCategories

UpsertCheckCategories (UpsertCheckCategoriesRequest) UpsertCheckCategoriesResponse UpsertCheckCategories sets (or replaces) the explicit category for one or more checks. Each entry is the complete state for its check — both dimensions — so an empty category / governance_category means “no explicit value for that dimension”.

DeleteCheckCategories

DeleteCheckCategories (DeleteCheckCategoriesRequest) DeleteCheckCategoriesResponse DeleteCheckCategories clears the explicit category (both dimensions) for the given checks. Checks fall back to their rule-computed categories afterwards.

ListCheckCategories

ListCheckCategories (ListCheckCategoriesRequest) ListCheckCategoriesResponse ListCheckCategories returns every explicit check category in the caller’s workspace.

ChecksCoverageService

(synq.entities.checks.v1.ChecksCoverageService) ChecksCoverageService provides functionality to retrieve and analyze the coverage of checks for entities in the system. It helps track which checks are applied to entities, including both direct checks and propagated checks from upstream entities.

GetCoverage

GetCoverage (GetCoverageRequest) GetCoverageResponse GetCoverage retrieves the coverage of checks for a specific entity. This includes both direct checks applied to the entity and checks propagated from upstream entities. The response provides detailed information about:

Table-level checks
Column-level checks
Check propagation paths
Column usage statistics

TypesService

(synq.entities.custom.v1.TypesService) TypesService is a service for managing custom entity types.

UpsertType

UpsertType (UpsertTypeRequest) UpsertTypeResponse Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.

DeleteType

DeleteType (DeleteTypeRequest) DeleteTypeResponse Delete an entity by its identifier. If the entity does not exist, it will be a no-op.

ListTypes

ListTypes (ListTypesRequest) ListTypesResponse List all entities.

EntityExecutionsService

(synq.entities.custom.v1.EntityExecutionsService)

UpsertExecution

UpsertExecution (UpsertExecutionRequest) UpsertExecutionResponse Execution affects status of the custom entity

UpsertLogEntry

UpsertLogEntry (UpsertLogEntryRequest) UpsertLogEntryResponse LogEntry is a log message for the custom entity

EntitiesService

(synq.entities.custom.v1.EntitiesService) custom.EntitiesService is a service for managing custom entities. Entities can represent various data platform concepts such as services, consumers, applications or data pipelines that are not natively available in Coalesce Quality. Entities are identified by a unique identifier and can be created, updated, read and deleted.

UpsertEntity

UpsertEntity (UpsertEntityRequest) UpsertEntityResponse Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.

DeleteEntity

DeleteEntity (DeleteEntityRequest) DeleteEntityResponse Delete an entity by its identifier. If the entity does not exist, it will be a no-op.

ListEntities

ListEntities (ListEntitiesRequest) ListEntitiesResponse List all entities.

FeaturesService

(synq.entities.custom.v1.FeaturesService)

UpsertEntityFeature

UpsertEntityFeature (UpsertEntityFeatureRequest) UpsertEntityFeatureResponse Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.

DeleteEntityFeature

DeleteEntityFeature (DeleteEntityFeatureRequest) DeleteEntityFeatureResponse Delete an entity by its identifier. If the entity does not exist, it will be a no-op.

ListEntityFeatures

ListEntityFeatures (ListEntityFeaturesRequest) ListEntityFeaturesResponse List all entities.

GroupsService

(synq.entities.custom.v1.GroupsService) It eliminates the need to keep state on client side to remember which assets were already created and which should be deleted. The server will keep track of the current state of the group and client can always send the intended new state. The server will calculate the diff and entities that are no longer present in the group will be removed. Example:

group has entities A, B, C at time t1
client sends group with entities B, C, D at time t2
server will remove entity A from the system and update the current state of the group to B, C, D

The service is designed to be idempotent and can be called multiple times with the same state without causing any side effects.

ListEntityGroups

ListEntityGroups (ListEntityGroupsRequest) ListEntityGroupsResponse ListEntityGroups lists all groups.

UpsertEntitiesGroup

UpsertEntitiesGroup (UpsertEntitiesGroupRequest) UpsertEntitiesGroupResponse UpsertEntitiesGroup updates current definition of group to the server. As part of the upsert operation the difference of entity ids is calculated between past state and the current state and entities that are no longer part of the group are removed.

DeleteEntitiesGroup

DeleteEntitiesGroup (DeleteEntitiesGroupRequest) DeleteEntitiesGroupResponse DeleteEntitiesGroup deletes a group by its identifier. If the group does not exist, it will be a no-op.

RelationshipsService

(synq.entities.custom.v1.RelationshipsService) RelationshipsService allow management of relationships between entities. Relationships can be created, updated, and deleted between 2 custom entities, or between a custom entity and Coalesce Quality native entity.enum There is no option to create relationships between 2 Coalesce Quality native entities (dbt model, BI dashboard, etc.).

UpsertRelationships

UpsertRelationships (UpsertRelationshipsRequest) UpsertRelationshipsResponse Create or update relationships between entities. If the relationship already exists, it will be updated, otherwise it will be created.

DeleteRelationships

DeleteRelationships (DeleteRelationshipsRequest) DeleteRelationshipsResponse Delete relationships between entities. If the relationship does not exist, it will be ignored.

ListRelationships

ListRelationships (ListRelationshipsRequest) ListRelationshipsResponse Delete relationships between entities. If the relationship does not exist, it will be ignored.

ChecksRelationshipsService

(synq.entities.custom.v1.ChecksRelationshipsService)

UpsertCheckRelationships

UpsertCheckRelationships (UpsertCheckRelationshipsRequest) UpsertCheckRelationshipsResponse 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

DeleteCheckRelationships (DeleteCheckRelationshipsRequest) DeleteCheckRelationshipsResponse Delete relationships between checks and the entities they validate. Relationships that do not exist are ignored.

EntitiesService

(synq.entities.entities.v1.EntitiesService) EntitiesService is a service for retriving any entity.

GetEntity

GetEntity (GetEntityRequest) GetEntityResponse Get specific entity by its identifier.

BatchGetEntities

BatchGetEntities (BatchGetEntitiesRequest) BatchGetEntitiesResponse Get multiple entities by their identifiers.

ListEntities

ListEntities (ListEntitiesRequest) ListEntitiesResponse List entities matching the given filter

SearchEntities

SearchEntities (SearchEntitiesRequest) SearchEntitiesResponse Search for entities.

EntityExecutionsService

(synq.entities.executions.v2.EntityExecutionsService) EntityExecutionsService provides read-only access to entity execution history. This service allows customers to retrieve information about all executions that happened on their entities, including execution status, timing, and messages. Use cases:

Retrieve execution history for specific entities
Filter executions by time range, status, or execution type
Get aggregated summaries of execution activity
Track execution trends and patterns

ListExecutions

ListExecutions (ListExecutionsRequest) ListExecutionsResponse ListExecutions retrieves a paginated list of executions for one or more entities. Executions are returned in reverse chronological order (newest first). Supports filtering by:

Entity identifiers (required)
Time range
Execution type(s)
Status(es)

BatchGetExecutions

BatchGetExecutions (BatchGetExecutionsRequest) BatchGetExecutionsResponse BatchGetExecutions retrieves multiple executions by their IDs. This is useful when you already know the execution IDs and want to fetch their details.

GetExecutionsSummary

GetExecutionsSummary (GetExecutionsSummaryRequest) GetExecutionsSummaryResponse GetExecutionsSummary provides aggregated statistics about executions for specified entities. This is useful for quickly understanding execution patterns without fetching all execution details. Returns:

Counts by execution type
Counts by status
Time range of available executions
Latest execution per entity

GetLatestExecutions

GetLatestExecutions (GetLatestExecutionsRequest) GetLatestExecutionsResponse GetLatestExecutions retrieves the most recent execution for 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 entity in targets or extra_references. For example, querying for a table won’t return results because tables don’t execute on their own - they are created/updated by models (which do execute). Optionally filter by execution status to get the latest execution with a specific status.

EntityExecutionsService

(synq.entities.executions.v1.EntityExecutionsService) Deprecated: Use [synq.entities.custom.v1.EntityExecutionsService] instead

UpsertExecution

UpsertExecution (UpsertExecutionRequest) UpsertExecutionResponse Execution affects status of the custom entity

UpsertLogEntry

UpsertLogEntry (UpsertLogEntryRequest) UpsertLogEntryResponse LogEntry is a log message for the custom entity

SqlInsightsService

(synq.entities.sql_insights.v1.SqlInsightsService) SqlInsightsService exposes analytical information about the SQL used across a workspace’s entities. It answers questions such as “which SQL constructs are used in my warehouse, and how often” and “what SQL constructs does this specific entity use”, without requiring the caller to re-parse any SQL.

ListSqlConstructs

ListSqlConstructs (ListSqlConstructsRequest) ListSqlConstructsResponse ListSqlConstructs returns the distribution of SQL constructs across all entities in the workspace, with an occurrence count per construct. The result is workspace-scoped (derived from the authenticated request) — no entity paths are supplied. Useful for building filter/autocomplete UIs and for high-level “shape of our SQL” analytics.

BatchSqlDetails

BatchSqlDetails (BatchSqlDetailsRequest) BatchSqlDetailsResponse BatchSqlDetails returns the SQL details (currently the set of detected SQL constructs) for each of the requested entities, keyed by their synq path. Entities with no SQL details are omitted from the response map.

SchemaMismatchesService

(synq.entities.schemas.v1.SchemaMismatchesService) SchemaMismatchesService provides access to schema drift information between data platform tables and their definitions (e.g., dbt models).

BatchSchemaMismatches

BatchSchemaMismatches (BatchSchemaMismatchesRequest) BatchSchemaMismatchesResponse Get schema mismatches for a batch of entities by their identifiers.

SchemasService

(synq.entities.schemas.v1.SchemasService) EntitiesService is a service for retriving any entity.

GetSchema

GetSchema (GetSchemaRequest) GetSchemaResponse Get schema of the entity its identifier.

CodeService

(synq.entities.code.v1.CodeService) CodeService is a service for retrieving code associated with entities in the system. It provides functionality to access and manage code artifacts such as SQL queries, Python scripts, dbt models, and other code configurations that are part of Coalesce Quality entities.

ListCode

ListCode (ListCodeRequest) ListCodeResponse ListCode retrieves 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.

TableConstraintsService

(synq.entities.constraints.v1.TableConstraintsService) TableConstraintsService provides access to table constraint and index information.

GetTableConstraints

GetTableConstraints (GetTableConstraintsRequest) GetTableConstraintsResponse Get table constraints (primary keys, foreign keys, indexes, etc.) for a given entity.

DwhService

(synq.ingest.dwh.v1.DwhService)

IngestObjectInformation

IngestObjectInformation (IngestObjectInformationRequest) IngestObjectInformationResponse

IngestSqlDefinitions

IngestSqlDefinitions (IngestSqlDefinitionsRequest) IngestSqlDefinitionsResponse

IngestSchemas

IngestSchemas (IngestSchemasRequest) IngestSchemasResponse

IngestObjectMetrics

IngestObjectMetrics (IngestObjectMetricsRequest) IngestObjectMetricsResponse

IngestTaskResults

IngestTaskResults (IngestTaskResultsRequest) IngestTaskResultsResponse

IngestQueryLogs

IngestQueryLogs (IngestQueryLogsRequest) IngestQueryLogsResponse

IngestTableConstraints

IngestTableConstraints (IngestTableConstraintsRequest) IngestTableConstraintsResponse

IngestLineage

IngestLineage (IngestLineageRequest) IngestLineageResponse IngestLineage pushes 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 (MERGE) and an authoritative refresh of a region of the warehouse (REPLACE_SCOPE); REPLACE_SCOPE is what lets the platform expire edges that no longer exist. Safe to retry: re-sending the same batch converges to the same state.

OpenlineageService

(synq.ingest.openlineage.v1.OpenlineageService)

Ingest

Ingest (IngestRequest) IngestResponse

CloudwatchService

(synq.ingest.cloudwatch.v1.CloudwatchService)

IngestCloudwatchLogsData

IngestCloudwatchLogsData (IngestCloudwatchLogsDataRequest) IngestCloudwatchLogsDataResponse

AirflowLogsService

(synq.ingest.airflow.v1.AirflowLogsService)

IngestLog

IngestLog (IngestLogRequest) IngestLogResponse

IngestDatahubAspects

IngestDatahubAspects (IngestDatahubAspectsRequest) IngestDatahubAspectsResponse

SqlMeshService

(synq.ingest.sqlmesh.v1.SqlMeshService)

IngestMetadata

IngestMetadata (IngestMetadataRequest) IngestMetadataResponse

IngestExecution

IngestExecution (IngestExecutionRequest) IngestExecutionResponse

DbtService

(synq.ingest.dbt.v1.DbtService)

IngestInvocation

IngestInvocation (IngestInvocationRequest) IngestInvocationResponse

DomainMembersService

(synq.domains.members.v1.DomainMembersService) DomainMembersService can be used to manage domain memberships.

AddDomainMembers

AddDomainMembers (AddDomainMembersRequest) AddDomainMembersResponse Add domain members.

RemoveDomainMembers

RemoveDomainMembers (RemoveDomainMembersRequest) RemoveDomainMembersResponse Remove domain members.

ListDomainMembers

ListDomainMembers (ListDomainMembersRequest) ListDomainMembersResponse List domain members.

ListUserDomains

ListUserDomains (ListUserDomainsRequest) ListUserDomainsResponse List domains for the given user.

SetDefaultUserDomain

SetDefaultUserDomain (SetDefaultUserDomainRequest) SetDefaultUserDomainResponse Set default domain for user.

DomainsService

(synq.domains.v1.DomainsService) DomainsService can be used to manage domains.

Upsert

Upsert (UpsertRequest) UpsertResponse Create or update a domain.

BatchGet

BatchGet (BatchGetRequest) BatchGetResponse Get multiple domains by their identifiers.

FetchDomainWithSubDomains

FetchDomainWithSubDomains (FetchDomainWithSubDomainsRequest) FetchDomainWithSubDomainsResponse Get a domain with its sub-domains

List

List (ListRequest) ListResponse List all the domains in the current workspace.

Delete

Delete (DeleteRequest) DeleteResponse Delete a domain by its identifier.

SetDefinition

SetDefinition (SetDefinitionRequest) SetDefinitionResponse Set the definition for an existing domain.

UpsertDefinitionPart

UpsertDefinitionPart (UpsertDefinitionPartRequest) UpsertDefinitionPartResponse Upsert definition part to the definition of an existing domain.

RemoveDefinitionPart

RemoveDefinitionPart (RemoveDefinitionPartRequest) RemoveDefinitionPartResponse Remove definition part from the definition of an existing domain.

GetUsage

GetUsage (GetUsageRequest) GetUsageResponse

SavedViewsService

(synq.savedviews.v1.SavedViewsService) SavedViewsService manages saved views — named, reusable selections over your entities (and other surfaces) with display configuration, sharing and per-user pinning. A saved view is owned by the user who created it. It can be kept private, shared with the whole workspace, or granted to specific users. Reads return, for the calling user, how each view relates to them (mine / shared / granted) and what they are allowed to do with it. Workspace administrators can manage any view in the workspace.

Upsert

Upsert (UpsertRequest) UpsertResponse Create or update a saved view. The view id is supplied by the caller (a UUID), which makes this operation idempotent — repeating the same request converges to the same view rather than creating a duplicate. Mutable fields are optional: a field that is set is written, a field that is omitted is left unchanged. To guard against overwriting a concurrent edit, pass the etag you last read.

Delete

Delete (DeleteRequest) DeleteResponse Delete a saved view. Idempotent — deleting an already-deleted or unknown view succeeds. Pass etag to guard against deleting a concurrently-edited view.

BatchGet

BatchGet (BatchGetRequest) BatchGetResponse 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.

List

List (ListRequest) ListResponse 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

SetPin (SetPinRequest) SetPinResponse 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.

DataproductsService

(synq.dataproducts.v2.DataproductsService) DataproductsService manages data products — named, owned groupings of data assets with a membership definition, a priority and an optional folder. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on Upsert: a field that is set is written, a field that is omitted is left unchanged. Pass the etag you last read to guard against overwriting a concurrent edit. A data product is a leaf in the reference graph — its definition may not reference another data product or domain — so membership resolution always terminates.

Upsert

Upsert (UpsertRequest) UpsertResponse 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

BatchGet (BatchGetRequest) BatchGetResponse 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.

List

List (ListRequest) ListResponse List the data products in the workspace, paginated. Narrow with folder and priorities.

Delete

Delete (DeleteRequest) DeleteResponse 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

SetDefinition (SetDefinitionRequest) SetDefinitionResponse Replace the entire membership definition of a data product.

UpsertDefinitionPart

UpsertDefinitionPart (UpsertDefinitionPartRequest) UpsertDefinitionPartResponse Add or replace a single definition part (matched by its part id).

RemoveDefinitionPart

RemoveDefinitionPart (RemoveDefinitionPartRequest) RemoveDefinitionPartResponse Remove a single definition part by its part id. Idempotent.

ListMembers

ListMembers (ListMembersRequest) ListMembersResponse List the assets that currently belong to a data product, resolved from its definition and returned as opaque entity ids. Paginated.

DataproductsService

(synq.dataproducts.v1.DataproductsService) DataproductsService can be used to manage data products.

Upsert

Upsert (UpsertRequest) UpsertResponse Create or update a dataproduct.

Get

Get (GetRequest) GetResponse Get multiple dataproducts by their identifiers.

List

List (ListRequest) ListResponse List all the dataproducts in the current scope.

Delete

Delete (DeleteRequest) DeleteResponse Delete a dataproduct by its identifier. Soft deletes by default. Optionally purge the dataproduct to release the identifier.

SetDefinition

SetDefinition (SetDefinitionRequest) SetDefinitionResponse Set the definition for an existing dataproduct.

UpsertDefinitionPart

UpsertDefinitionPart (UpsertDefinitionPartRequest) UpsertDefinitionPartResponse Upsert definition part to the definition of an existing dataproduct.

RemoveDefinitionPart

RemoveDefinitionPart (RemoveDefinitionPartRequest) RemoveDefinitionPartResponse Remove definition part from the definition of an existing dataproduct.

IncidentsService

(synq.incidents.v1.IncidentsService) IncidentsService is a service for managing Incidents.

CreateIncident

CreateIncident (CreateIncidentRequest) CreateIncidentResponse

RenameIncident

RenameIncident (RenameIncidentRequest) RenameIncidentResponse

UpdateIncidentState

UpdateIncidentState (UpdateIncidentStateRequest) UpdateIncidentStateResponse

CancelIncident

CancelIncident (CancelIncidentRequest) CancelIncidentResponse Cancel an incident

CloseIncident

CloseIncident (CloseIncidentRequest) CloseIncidentResponse Close an incident

MergeIncidents

MergeIncidents (MergeIncidentsRequest) MergeIncidentsResponse

SplitIncident

SplitIncident (SplitIncidentRequest) SplitIncidentResponse

AddIssuesToIncident

AddIssuesToIncident (AddIssuesToIncidentRequest) AddIssuesToIncidentResponse

RemoveIssuesFromIncident

RemoveIssuesFromIncident (RemoveIssuesFromIncidentRequest) RemoveIssuesFromIncidentResponse

ListIncidents

ListIncidents (ListIncidentsRequest) ListIncidentsResponse

BatchGetIncidents

BatchGetIncidents (BatchGetIncidentsRequest) BatchGetIncidentsResponse

AssignIncidentOwner

AssignIncidentOwner (AssignIncidentOwnerRequest) AssignIncidentOwnerResponse

PostComment

PostComment (PostCommentRequest) PostCommentResponse Post a comment on an incident.

Messages

CronSchedule

(synq.schedule.v1.CronSchedule) CronSchedule uses standard cron expression syntax.

Field	Type	Description
expression	string	Standard cron expression (e.g. “0 /6 * *”).

ICalSchedule

(synq.schedule.v1.ICalSchedule) ICalSchedule uses RFC 5545 RRULE recurrence rules.

Field	Type	Description
recurrence_rule	string	RFC 5545 RRULE recurrence rule (e.g. “FREQ=MONTHLY;BYDAY=TH;BYSETPOS=-1”). DTSTART should be set via the dtstart field below rather than inline in the rule.
oneof _dtstart.dtstart	optional Timestamp	Anchor time for the recurrence rule. Wall-clock time interpreted in the schedule’s timezone. Defines when the schedule starts and aligns occurrences. If not set and no DTSTART is present in the recurrence_rule, defaults to now().

Schedule

(synq.schedule.v1.Schedule) Schedule defines a recurring schedule with timezone context.

Field	Type	Description
timezone	string	IANA timezone, e.g. “Europe/Warsaw”, “America/New_York”.
oneof type.cron	CronSchedule	none
oneof type.ical	ICalSchedule	none

FixedQuantumGrid

(synq.schedule.v1.FixedQuantumGrid) FixedQuantumGrid snaps onto a fixed-size grid anchored at the Unix epoch (1970-01-01T00:00:00Z): [epoch, epoch+quantum, epoch+2*quantum, …].

Field	Type	Description
quantum	Duration	Spacing between grid points, e.g. 10m.

IntegrationAnchorGrid

(synq.schedule.v1.IntegrationAnchorGrid) IntegrationAnchorGrid snaps onto the shared, stable grid an integration’s periodic warehouse scrape already fires on. Aligning to it lets a run reuse the same warehouse wake as the scrape. The integration is resolved in the caller’s own workspace (taken from the authenticated identity, never from the request), and the caller must be authorized to read it — a token without integration read access is rejected.

Field	Type	Description
integration_id	string	The integration whose scrape grid to align to.
oneof _period.period	optional Duration	Spacing between grid points. When unset, the integration’s configured scrape cadence is used — this is what actually resumes the warehouse once per tick. Set it only to override for unusual cases.

PreviewScheduleParams

(synq.schedule.v1.PreviewScheduleParams) Parameters for evaluating a single schedule.

Field	Type	Description
schedule	Schedule	The schedule to evaluate.
oneof _after.after	optional Timestamp	Starting point for computing occurrences. Defaults to now if not set.
oneof _limit.limit	optional int32	Number of occurrences to return. Defaults to 7, maximum 100.
oneof _snap.snap	optional ScheduleSnap	Optional. When set, each computed occurrence is mapped to the nearest matching grid point before being returned, so the job co-fires with existing activity (e.g. a warehouse that is already awake) instead of triggering its own resume. When unset, occurrences are returned exactly as the schedule expression produces them.

PreviewScheduleResult

(synq.schedule.v1.PreviewScheduleResult) Result for a single schedule evaluation.

Field	Type	Description
occurrences	repeated Timestamp	The next occurrences in chronological order. Empty if error is set.
error	string	Error message if the schedule expression is invalid or cannot be evaluated. Empty on success.
snap_info	repeated SnapInfo	Per-occurrence snap outcome, index-aligned with `occurrences`. Empty when snap was not requested.

PreviewSchedulesRequest

(synq.schedule.v1.PreviewSchedulesRequest)

Field	Type	Description
schedules	repeated PreviewScheduleParams	Schedules to evaluate. An empty list returns an empty response.

PreviewSchedulesResponse

(synq.schedule.v1.PreviewSchedulesResponse)

Field	Type	Description
results	repeated PreviewScheduleResult	Results matching the request schedules by index.

ScheduleSnap

(synq.schedule.v1.ScheduleSnap) ScheduleSnap maps each schedule occurrence onto a grid so runs line up with activity that is already happening, avoiding a separate warehouse resume. Pick one grid source and, optionally, how far an occurrence may move.

Field	Type	Description
oneof grid.integration_anchor	IntegrationAnchorGrid	Snap onto the shared warehouse-scrape grid for an integration, so the run co-fires with the periodic scrape and reuses the same warehouse wake instead of paying for another resume.
oneof grid.fixed_quantum	FixedQuantumGrid	Snap onto a fixed-quantum grid (e.g. every 10 minutes from the Unix epoch, UTC). Useful for tidy round-minute fire times without coupling to integration activity.
tolerance	Duration	How far an occurrence may be moved to land on the grid. If the nearest eligible grid point is farther away than this, the occurrence is returned unmoved and flagged as not snapped (see SnapInfo). Unset or zero means an occurrence snaps only when it already lands exactly on a grid point.
direction	SnapDirection	Direction an occurrence is allowed to move. Unspecified behaves as NEAREST.

SnapInfo

(synq.schedule.v1.SnapInfo) SnapInfo records, for one occurrence, whether snapping moved it onto the grid.

Field	Type	Description
original	Timestamp	The occurrence as the schedule expression produced it, before snapping.
snapped	bool	True if the occurrence was moved onto the grid. False if the nearest grid point was farther than the tolerance (or none was available), in which case the aligned `occurrences` entry equals `original`.

OAuthAuthentication

(synq.platforms.v1.OAuthAuthentication) Authentication using OAuth credentials

Field	Type	Description
client_id	string	none
client_secret	string	none

PasswordAuthentication

(synq.platforms.v1.PasswordAuthentication) Authentication using a username and password

Field	Type	Description
username	string	none
password	string	none

PlatformAuthentication

(synq.platforms.v1.PlatformAuthentication)

Field	Type	Description
oneof authentication.token	TokenAuthentication	none
oneof authentication.oauth	OAuthAuthentication	none
oneof authentication.password	PasswordAuthentication	none
oneof authentication.synq_managed_key_pair	SynqManagedKeyPairAuthentication	none
oneof authentication.user_managed_key_pair	UserManagedKeyPairAuthentication	none

SynqManagedKeyPairAuthentication

(synq.platforms.v1.SynqManagedKeyPairAuthentication) Authentication using a managed key pair. The public key will be set and returned by the server after the authentication is created.

Field	Type	Description
oneof _public_key.public_key	optional string	none

TokenAuthentication

(synq.platforms.v1.TokenAuthentication) Authentication using a token (API key, PAT, etc)

Field	Type	Description
token	string	none

UserManagedKeyPairAuthentication

(synq.platforms.v1.UserManagedKeyPairAuthentication) Authentication using a user-managed key pair. The private key is stored safely as a secret. The response does not include the private key for security.

Field	Type	Description
private_key	string	none

AthenaIdentifier

(synq.platforms.v1.AthenaIdentifier)

Field	Type	Description
instance	string	AWS account and region the Athena workgroup runs in, formatted as “<account-id>.<region>” (e.g. “123456789012.eu-west-1”). Auto-derived by SYNQ from sts:GetCallerIdentity at integration setup time.
catalog	string	Glue Data Catalog name. Almost always “AwsDataCatalog” — the default catalog for Athena unless the customer registered a federated catalog.

BigqueryIdentifier

(synq.platforms.v1.BigqueryIdentifier)

Field	Type	Description
project	string	BigQuery project

ClickhouseIdentifier

(synq.platforms.v1.ClickhouseIdentifier)

Field	Type	Description
host	string	Clickhouse host inclusive of port
schema	string	Clickhouse database

DataPlatformIdentifier

(synq.platforms.v1.DataPlatformIdentifier) DataPlatformIdentifier is a unique reference to a data platform integrated with Coalesce Quality.

Field	Type	Description
oneof id.unknown	UnknownDataPlatform	none
oneof id.bigquery	BigqueryIdentifier	none
oneof id.clickhouse	ClickhouseIdentifier	none
oneof id.snowflake	SnowflakeIdentifier	none
oneof id.redshift	RedshiftIdentifier	none
oneof id.postgres	PostgresIdentifier	none
oneof id.mysql	MysqlIdentifier	none
oneof id.databricks	DatabricksIdentifier	none
oneof id.dbt_cloud	DbtCloudIdentifier	none
oneof id.sql_mesh	SqlMeshIdentifier	none
oneof id.duckdb	DuckDbIdentifier	none
oneof id.trino	TrinoIdentifier	none
oneof id.mssql	MssqlIdentifier	none
oneof id.oracle	OracleIdentifier	none
oneof id.athena	AthenaIdentifier	none
oneof id.fabric	FabricIdentifier	none
oneof id.synq_integration_id	string	Coalesce Quality integration ID maps to the created integration on the Coalesce Quality platform.

DatabricksIdentifier

(synq.platforms.v1.DatabricksIdentifier)

Field	Type	Description
workspace	string	URL of the databricks workspace

DbtCloudIdentifier

(synq.platforms.v1.DbtCloudIdentifier)

Field	Type	Description
api_endpoint	string	API endpoint for Dbt Cloud
account_id	string	Account ID
project_id	string	Project ID

DuckDbIdentifier

(synq.platforms.v1.DuckDbIdentifier)

Field	Type	Description
motherduck_account	string	none

FabricIdentifier

(synq.platforms.v1.FabricIdentifier)

Field	Type	Description
instance	string	Workspace SQL analytics endpoint host, e.g. “<workspace-id>.datawarehouse.fabric.microsoft.com”. Identifies the Fabric workspace the integration connects to. Fabric is workspace-scoped with cross-database queries, so the workspace host alone identifies the platform (like Databricks’ workspace URL); a specific warehouse/table is addressed by FabricTableIdentifier.
workspace_id	string	Fabric workspace GUID — the identifier used by the Fabric REST API for workspace-scoped resources. The Fabric endpoint host in `instance` encodes the tenant and workspace GUIDs; this is the decoded workspace GUID, provided so you don’t have to decode it yourself. `instance` remains the identifying value. Optional: empty when the host isn’t a standard Fabric endpoint.
tenant_id	string	Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance` alongside workspace_id. Optional: empty when the host isn’t a standard Fabric endpoint.

MssqlIdentifier

(synq.platforms.v1.MssqlIdentifier)

Field	Type	Description
host	string	SQL Server host
database	string	Database name

MysqlIdentifier

(synq.platforms.v1.MysqlIdentifier)

Field	Type	Description
host	string	Mysql host inclusive of port

OracleIdentifier

(synq.platforms.v1.OracleIdentifier)

Field	Type	Description
host	string	Oracle host
service_name	string	Oracle service name (PDB)

PostgresIdentifier

(synq.platforms.v1.PostgresIdentifier)

Field	Type	Description
host	string	Postgres host inclusive of port
database	string	Postgres database

RedshiftIdentifier

(synq.platforms.v1.RedshiftIdentifier)

Field	Type	Description
cluster	string	Redshift cluster
database	string	Redshift database

SnowflakeIdentifier

(synq.platforms.v1.SnowflakeIdentifier)

Field	Type	Description
account	string	Snowflake account
database	string	Snowflake database

SqlMeshIdentifier

(synq.platforms.v1.SqlMeshIdentifier)

Field	Type	Description
default_database_instance	string	Default database instance for SQL Mesh

TrinoIdentifier

(synq.platforms.v1.TrinoIdentifier)

Field	Type	Description
coordinator	string	none

UnknownDataPlatform

(synq.platforms.v1.UnknownDataPlatform)

SetPlatformAuthenticationRequest

(synq.platforms.v1.SetPlatformAuthenticationRequest)

Field	Type	Description
platform	DataPlatformIdentifier	Platform identifier
authentication	PlatformAuthentication	Authentication details

SetPlatformAuthenticationResponse

(synq.platforms.v1.SetPlatformAuthenticationResponse)

Field	Type	Description
success	bool	none
oneof _authentication.authentication	optional PlatformAuthentication	The authentication is returned in case there is a server side set information to be passed to the client.

ScopeFilter

(synq.common.v1.ScopeFilter) ScopeFilter defines include/exclude rules for scoping data warehouse queries. Matching semantics:

If include is non-empty, a (database, schema, table) tuple must match at least one include rule.
If exclude is non-empty, the tuple must NOT match any exclude rule.
Exclude takes precedence over include (exclude wins).
Empty/unset ScopeFilter means accept all.

Field	Type	Description
include	repeated ScopeRule	Include rules. If non-empty, only matching objects are accepted.
exclude	repeated ScopeRule	Exclude rules. Matching objects are rejected, even if they match an include rule.

ScopeRule

(synq.common.v1.ScopeRule) ScopeRule is a multi-level pattern for matching data warehouse objects. All non-empty fields must match for the rule to apply. Empty field means “match anything” at that level (wildcard). Patterns support glob syntax where * matches zero or more characters. Matching is case-insensitive.

Field	Type	Description
database	string	Database-level pattern. Only meaningful for warehouses that expose more than one database/catalog per connection — Snowflake & Trino (catalog), Databricks (catalog), Athena (Glue catalog), DuckDB (database). Ignored by single-database/-project connections (Postgres, Redshift, MSSQL, Oracle, BigQuery project) and by MySQL/ClickHouse, which filter their namespace at the schema level below.
schema	string	Schema-level pattern. The level directly above a table. Maps to: dataset in BigQuery; database (namespace) in MySQL & ClickHouse; schema in Postgres/Redshift/Snowflake/Trino/MSSQL; owner in Oracle.
table	string	Table or view name pattern.

SqlExpression

(synq.common.v1.SqlExpression) SqlExpression carries a SQL string together with the placeholder tokens the caller must substitute before executing it. Empty placeholders means sql is byte-equal to what runs in the warehouse and is safe to dispatch without further processing. When placeholders is non-empty, every listed token appears literally in sql and must be replaced (or otherwise interpreted) by the caller before execution.

Field	Type	Description
sql	string	SQL string. Dialect matches the integration that owns the expression’s parent resource. May contain placeholder tokens — see `placeholders`.
placeholders	repeated SqlPlaceholder	Placeholders present in `sql`. Order is undefined; each token is unique within the slice. Absent when `sql` is directly runnable.

SqlPlaceholder

(synq.common.v1.SqlPlaceholder) SqlPlaceholder describes one substitution slot in a SqlExpression.

Field	Type	Description
token	string	Literal token as it appears in `sql`, e.g. “{from}“.
description	string	Human- and AI-readable purpose of the placeholder. Should answer “what value should I substitute, and in what form?” without relying on out-of-band documentation. Example: “Lower bound of the metric query time window (inclusive, UTC timestamp).”

GetDiffByChangeIdRequest

(synq.git.commits.v1.GetDiffByChangeIdRequest)

Field	Type	Description
change_id	string	none
limit_to_files	repeated string	none

GetDiffByChangeIdResponse

(synq.git.commits.v1.GetDiffByChangeIdResponse)

Field	Type	Description
oneof _commit_diff.commit_diff	optional CommitDiff	none

GetDiffByCommitRequest

(synq.git.commits.v1.GetDiffByCommitRequest)

Field	Type	Description
commit_sha	string	Commit SHA. Accepts either the full 40-char hex hash or any unique hex prefix of at least 7 characters (server resolves the prefix against stored commits, like `git rev-parse <prefix>`). Ambiguous or unmatched prefixes return an empty diff rather than an error.
limit_to_files	repeated string	none

GetDiffByCommitResponse

(synq.git.commits.v1.GetDiffByCommitResponse)

Field	Type	Description
oneof _commit_diff.commit_diff	optional CommitDiff	none

CommitDiff

(synq.git.commits.v1.CommitDiff)

Field	Type	Description
commit_sha	string	none
file_diffs	repeated FileDiff	none

FileDiff

(synq.git.commits.v1.FileDiff)

Field	Type	Description
file_path	string	none
diff	string	none

BatchGetOwnersRequest

(synq.owners.v1.BatchGetOwnersRequest)

Field	Type	Description
ids	repeated string	Owner ids to fetch (1–200, unique). Each accepts either the bare UUID or the `entity_id` form (`owner-<uuid>`); the prefix is stripped server-side.
include_deleted	bool	Include soft-deleted owners.

BatchGetOwnersResponse

(synq.owners.v1.BatchGetOwnersResponse)

Field	Type	Description
owners	map OwnersEntry	Owners keyed by id. Ids that do not exist (or are deleted, unless requested) are absent.

BatchGetOwnersResponse.OwnersEntry

(synq.owners.v1.BatchGetOwnersResponse.OwnersEntry)

Field	Type	Description
key	string	none
value	Owner	none

BatchGetOwnershipsRequest

(synq.owners.v1.BatchGetOwnershipsRequest)

Field	Type	Description
ids	repeated string	Ownership ids to fetch (1–200, unique).
include_deleted	bool	Include soft-deleted ownerships.

BatchGetOwnershipsResponse

(synq.owners.v1.BatchGetOwnershipsResponse)

Field	Type	Description
ownerships	map OwnershipsEntry	Ownerships keyed by id. Ids that do not exist (or are deleted, unless requested) are absent.

BatchGetOwnershipsResponse.OwnershipsEntry

(synq.owners.v1.BatchGetOwnershipsResponse.OwnershipsEntry)

Field	Type	Description
key	string	none
value	Ownership	none

ContactList

(synq.owners.v1.ContactList) A wrapper giving the contact set explicit presence on write, so a partial update can distinguish “replace the contacts” (present, possibly empty) from “leave contacts unchanged” (absent).

Field	Type	Description
contacts	repeated Contact	none

DeleteOwnerRequest

(synq.owners.v1.DeleteOwnerRequest)

Field	Type	Description
id	string	Id of the owner to delete. Accepts the bare UUID or the `owner-<uuid>` entity_id form (the prefix is stripped server-side).
purge	bool	Hard-delete instead of soft-delete, releasing the id for reuse.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.
actor	Actor	Who is performing this write. Optional.

DeleteOwnerResponse

(synq.owners.v1.DeleteOwnerResponse)

DeleteOwnershipRequest

(synq.owners.v1.DeleteOwnershipRequest)

Field	Type	Description
id	string	Id of the ownership to delete.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.
actor	Actor	Who is performing this write. Optional.

DeleteOwnershipResponse

(synq.owners.v1.DeleteOwnershipResponse)

ListOwnersRequest

(synq.owners.v1.ListOwnersRequest)

Field	Type	Description
pagination	Pagination	Pagination.
include_deleted	bool	Include soft-deleted owners.

ListOwnersResponse

(synq.owners.v1.ListOwnersResponse)

Field	Type	Description
owners	repeated Owner	The matching owners.
page_info	PageInfo	Pagination cursor for the next page.

ListOwnershipsRequest

(synq.owners.v1.ListOwnershipsRequest)

Field	Type	Description
owner_id	string	Id of the owner whose ownerships to list. Accepts the bare UUID or the `owner-<uuid>` entity_id form (the prefix is stripped server-side).
pagination	Pagination	Pagination.
include_deleted	bool	Include soft-deleted ownerships.

ListOwnershipsResponse

(synq.owners.v1.ListOwnershipsResponse)

Field	Type	Description
ownerships	repeated Ownership	The owner’s ownerships.
page_info	PageInfo	Pagination cursor for the next page.

UpsertOwnerRequest

(synq.owners.v1.UpsertOwnerRequest)

Field	Type	Description
id	string	Opaque id of the owner. Accepts either the bare UUID or the `entity_id` form this API returns (`owner-<uuid>`) — the prefix is stripped server-side, so the value you read back from any API can be passed straight in. The same id updates the same owner; a new id creates a new owner.
oneof _title.title	optional string	Owner name. Required when creating; omit to keep the existing name on update.
oneof _contacts.contacts	optional ContactList	Notification channels. Omit to leave the existing contacts unchanged; pass a present (possibly empty) list to replace them.
oneof _source.source	optional Source	Source. Omit to keep the existing source (defaults to SOURCE_SYNQ on create).
oneof _etag.etag	optional string	Optional optimistic-concurrency guard. When set, the update fails with a conflict if the owner was modified since this etag was read.
actor	Actor	Who is performing this write. Optional — identity is completed from the calling credentials; set it to attribute the change on behalf of a user.

UpsertOwnerResponse

(synq.owners.v1.UpsertOwnerResponse)

Field	Type	Description
owner	Owner	The stored owner after the upsert.

UpsertOwnershipRequest

(synq.owners.v1.UpsertOwnershipRequest)

Field	Type	Description
owner_id	string	Id of the owner this ownership belongs to. Accepts the bare UUID or the `owner-<uuid>` entity_id form (the prefix is stripped server-side).
id	string	Opaque id of the ownership (a UUID). The same id updates the same ownership; a new id creates a new one.
selection	OwnershipSelection	Which assets this ownership covers.
alert	AlertConfig	How alerts fire for the covered assets. Optional.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.
actor	Actor	Who is performing this write. Optional.

UpsertOwnershipResponse

(synq.owners.v1.UpsertOwnershipResponse)

Field	Type	Description
ownership	Ownership	The stored ownership after the upsert.

Contact

(synq.owners.v1.Contact) A notification channel attached to an owner. An owner can hold several contacts of different kinds; when an owner’s ownership fires an alert, the notification is delivered to every one of the owner’s contacts.

Field	Type	Description
oneof contact_method.slack	SlackChannelContact	Post to a Slack channel.
oneof contact_method.email	EmailContact	Send to a fixed set of email addresses.
oneof contact_method.ms_teams	MsTeamsContact	Post to a Microsoft Teams channel.
oneof contact_method.users	UserContact	Notify Coalesce Quality users by email.

EmailContact

(synq.owners.v1.EmailContact) Deliver notifications by email to a fixed list of recipients.

Field	Type	Description
recipient_emails	repeated string	Recipient email addresses.

MsTeamsContact

(synq.owners.v1.MsTeamsContact) Deliver notifications to a Microsoft Teams channel, optionally @-mentioning members.

Field	Type	Description
channel_id	string	Teams channel id to post in.
mentions	repeated MsTeamsMention	Members to @-mention in the notification. Optional.

MsTeamsMemberMention

(synq.owners.v1.MsTeamsMemberMention) An @-mention of an individual Microsoft Teams member.

Field	Type	Description
member_id	string	Teams member id that is actually mentioned. A workspace user’s Teams member id is available from `synq.users.v1.UsersService` — the `msteams:<id>` entry in `GetUserIdentities`, or an `ms_teams` alias on the user.
name	string	Display name of the member (informational). Optional.

MsTeamsMention

(synq.owners.v1.MsTeamsMention) A single @-mention in a Microsoft Teams notification.

Field	Type	Description
oneof mention.member	MsTeamsMemberMention	Mention an individual Teams member.

SlackChannelContact

(synq.owners.v1.SlackChannelContact) Deliver notifications to a Slack channel, optionally @-mentioning users or user groups in the message.

Field	Type	Description
channel	string	Channel to post in — a channel name (e.g. “#data-alerts”) or a channel id (e.g. “C0123456789”).
team_name	string	Name of the Slack workspace (team) the channel belongs to. Optional; only needed to disambiguate when more than one Slack workspace is connected.
mentions	repeated SlackMention	Users and/or user groups to @-mention in the notification. Optional.

SlackGroupMention

(synq.owners.v1.SlackGroupMention) An @-mention of a Slack user group.

Field	Type	Description
group_name	string	Display name of the group. Optional.
slack_id	string	Slack user-group id that is actually mentioned (e.g. “S0123456789”).

SlackMention

(synq.owners.v1.SlackMention) A single @-mention in a Slack notification.

Field	Type	Description
oneof mention.user	SlackUserMention	Mention an individual Slack user.
oneof mention.group	SlackGroupMention	Mention a Slack user group.

SlackUserMention

(synq.owners.v1.SlackUserMention) An @-mention of an individual Slack user.

Field	Type	Description
user_name	string	Display handle of the user (informational; helps readers recognise the mention). Optional.
slack_id	string	Slack user id that is actually mentioned (e.g. “U0123456789”). A workspace user’s Slack id is available from `synq.users.v1.UsersService` — the `slack:<id>` entry in `GetUserIdentities`, or a `slack` alias on the user.

UserContact

(synq.owners.v1.UserContact) Deliver notifications to Coalesce Quality users, identified by email. Each email should match a user in the workspace; the notification reaches them through their own configured notification preferences. Enumerate the valid users (and their emails) with synq.users.v1.UsersService — ListUsers for the full set, or GetByEmail to validate a single address.

Field	Type	Description
user_emails	repeated string	Emails of the users to notify. Each should match a workspace user; look them up via `synq.users.v1.UsersService.ListUsers` / `GetByEmail`.

Owner

(synq.owners.v1.Owner) An owner: a named responsible party (a team or a person) that data assets can be assigned to, together with the notification channels alerts about those assets are delivered to. Assets are attached to an owner through Ownerships (see OwnershipsService), so an owner on its own routes nothing until at least one ownership assigns it some assets.

Field	Type	Description
id	string	Opaque id of the owner (a UUID) supplied by the caller on create, which makes UpsertOwner idempotent. This is the id used to address the owner on this API (creating ownerships under it, deleting it).
entity_id	string	Stable, opaque platform identifier of this owner (of the form “owner-<uuid>”). Output-only — the server derives it; never construct it by hand. This is the exact value other SYNQ APIs accept as an owner reference (for example the `synq.alerts.v1.AlertsService` owner path — see `synq.alerts.v1.Alert.Owner`), so read it here and pass it there to point at the same owner without needing to know how it is formed.
title	string	Human-readable name of the owner (shown as “Owner name” in the app).
contacts	repeated Contact	Notification channels for this owner. A fired alert is delivered to every contact.
source	Source	none
etag	string	Entity tag for optimistic concurrency: pass it back on UpsertOwner / DeleteOwner to guard against overwriting a concurrent change. Form: `W/"<id>-<version>"`. Opaque — do not parse.
created_by	Actor	Who created the owner. Output-only.
updated_by	Actor	Who last edited the owner. Output-only.
created_at	Timestamp	When the owner was created. Output-only.
oneof _deleted_at.deleted_at	optional Timestamp	When the owner was soft-deleted, if it has been. Output-only.

AlertConfig

(synq.owners.v1.AlertConfig) How alerts fire for the assets an ownership covers. Deliberately mirrors the settings on the public alerts API (synq.alerts.v1) so alerting behaviour reads the same across SYNQ.

Field	Type	Description
severities	repeated Severity	Failure severities that fire an alert (Warning / Error / Fatal). Empty means no severity is selected and the ownership routes no failure alerts.
notify_upstream	bool	Also alert on issues in the upstream dependencies of the covered assets.
ongoing	OngoingAlertsStrategy	How repeat notifications for a still-open issue are handled: no repeats (Disabled), a scheduled digest (Schedule — a daily digest in the app), or one on every failed run (Stream). Leave unset for no ongoing notifications.
allow_sql_test_audit_link	bool	Include a link to the SQL test audit report in notifications.
is_disabled	bool	When true this ownership’s alerts are turned off while the assignment itself stays in place.

Ownership

(synq.owners.v1.Ownership) An ownership assigns a set of data assets to an owner and configures the alerts routed to that owner about those assets. In the app this is the owner’s “Owned assets”. One owner can hold many ownerships; deleting the owner deletes all of its ownerships.

Field	Type	Description
id	string	Opaque id of the ownership (a UUID) supplied by the caller on create, which makes UpsertOwnership idempotent. This is the same value `synq.alerts.v1.AlertsService` reports as the ownership reference (`synq.alerts.v1.Alert.Owner.ownership_id`) on an alert attributed to this owner.
owner_id	string	Id of the Owner this ownership belongs to (the owner’s `id`, a UUID).
selection	OwnershipSelection	Which assets this ownership covers.
alert	AlertConfig	How alerts fire for the covered assets.
etag	string	Entity tag for optimistic concurrency: pass it back on UpsertOwnership / DeleteOwnership to guard against overwriting a concurrent change. Form: `W/"<id>-<version>"`. Opaque — do not parse.
created_by	Actor	Who created the ownership. Output-only.
updated_by	Actor	Who last edited the ownership. Output-only.
created_at	Timestamp	When the ownership was created. Output-only.
oneof _deleted_at.deleted_at	optional Timestamp	When the ownership was soft-deleted, if it has been. Output-only.

OwnershipQuery

(synq.owners.v1.OwnershipQuery) A named asset selection behind an ownership, expressed for the public API. Uses the same write/read bridge as saved views and data products. On write, provide the query in ONE of two forms:

public_query — a structured query (the same shape used elsewhere for asset selection), convenient to build from a filter UI; or
resolver_ql — the resolver query language, a compact text form that is the canonical way to author selections as code. When both are set, resolver_ql wins. The server compiles and stores the query canonically; the raw text is not preserved verbatim.

Field	Type	Description
name	string	Human-readable name of the asset group (shown as “Asset group name”).
resolver_ql	string	WRITE (option A). The query in resolver query language.
rendered_resolver_ql	string	READ, output-only. The stored query rendered back to canonical resolver query language. Deterministically derived; does not preserve original hand-typed formatting or comments.
public_query	Query	WRITE (option B) and READ. On write, the structured query to store (used when `resolver_ql` is empty). On read, a best-effort structured representation of the stored query.

OwnershipSelection

(synq.owners.v1.OwnershipSelection) The set of assets an ownership covers.

Field	Type	Description
oneof selection.query	OwnershipQuery	Assets matched by a query. Covers both a custom “asset group” and the “all assets” case (a match-all query). Unlike a data product definition (which must be a leaf), an ownership query MAY reference data products and domains — routing alerts for everything in a data product/domain is a first-class use.
oneof selection.dataproduct_id	string	All assets belonging to a single data product, referenced by its opaque id (the `id` of a `synq.dataproducts.v2.Dataproduct`, as returned by `synq.dataproducts.v2.DataproductsService`). Accepts either the bare UUID or the `entity_id` form (`dataproduct-<uuid>`) — the prefix is stripped server-side, so a product’s `entity_id` from lineage can be assigned directly. The data product must exist in the workspace at write time.

IdentifierList

(synq.queries.v1.IdentifierList) Resolves to entities matching any of the given identifiers.

Field	Type	Description
identifiers	repeated Identifier	none

InDataPlatform

(synq.queries.v1.InDataPlatform) Resolves to all entities that belong to the given data platform.

Field	Type	Description
identifier	DataPlatformIdentifier	none

InDataproduct

(synq.queries.v1.InDataproduct) Resolves to all the assets that belong to the given data product.

Field	Type	Description
identifier	DataproductIdentifier	none

InDomain

(synq.queries.v1.InDomain) Resolves to all entities in the given data domain.

Field	Type	Description
domain_id	string	none

InFolder

(synq.queries.v1.InFolder) Resolves to all entities belonging to the given folder structure.

Field	Type	Description
path	repeated string	none

Unsupported

(synq.queries.v1.Unsupported) Collects all the parts of the query that are currently unsupported in translation. These represent an internal structure that are not yet completely available on the API.

Field	Type	Description
query_json	string	none

WithAnnotation

(synq.queries.v1.WithAnnotation) Resolves to all entities that contain the annotation with at least one of the provided accepted values. In case of no given accepted values, all entities that carry the given annotation are returned.

Field	Type	Description
name	string	none
oneof _accepted_value.accepted_value	optional string	none
accepted_values	repeated string	none

WithDataPlatformType

(synq.queries.v1.WithDataPlatformType)

Field	Type	Description
types	repeated DataPlatformType	none

WithNameSearch

(synq.queries.v1.WithNameSearch) Resolves to all entities matching the given name search.

Field	Type	Description
search_query	string	none

WithType

(synq.queries.v1.WithType) Resolves to all the entities that have the provided type.

Field	Type	Description
type	Type	none
types	repeated Type	none

WithType.Type

(synq.queries.v1.WithType.Type)

Field	Type	Description
oneof entity_type.default	EntityType	Default Coalesce Quality types
oneof entity_type.custom	int32	Custom types as defined through synq.entities.custom.v1.TypesService

Query

(synq.queries.v1.Query) Query is a structured query that can be used to find entities in the system. It consists of multiple parts, each representing a different filter or sub-query. The parts are combined using the operand to form the final result:

AND (default): returns only entities matching ALL parts (intersection).
OR: returns entities matching ANY part (union).
EXCEPT: requires exactly 2 parts — returns entities from part[0] that are NOT in part[1].
UPSTREAM: returns entities that are upstream (dependencies) of the entities matched by the parts.
DOWNSTREAM: returns entities that are downstream (dependents) of the entities matched by the parts.

Queries can be nested by using a Query as a QueryPart, enabling complex compositions like “upstream of all Snowflake tables”.

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	Defaults to AND if not specified.

Query.QueryPart

(synq.queries.v1.Query.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_dataproduct	InDataproduct	none
oneof part.in_data_platform	InDataPlatform	none
oneof part.with_data_platform_type	WithDataPlatformType	none
oneof part.in_folder	InFolder	none
oneof part.in_domain	InDomain	none
oneof part.query	Query	Nested sub-query, enabling recursive composition of filters and operands.
oneof part.unsupported	Unsupported	Read-only. Represents internal query types that cannot be expressed in the public API. Do not construct these directly — they are returned when translating from internal queries.

GenerateQueryRequest

(synq.queries.v1.GenerateQueryRequest)

Field	Type	Description
description	string	none

GenerateQueryResponse

(synq.queries.v1.GenerateQueryResponse)

Field	Type	Description
oneof _query.query	optional Query	The public Query proto. Absent when unsupported.
oneof _resolver_ql.resolver_ql	optional string	The generated ResolverQL query string. Empty when unsupported.
oneof _unsupported_reason.unsupported_reason	optional string	When the LLM determines the request cannot be expressed as a query, this field contains the reason(s). The other fields will be empty.

Callback

(synq.webhooks.v1.Callback)

Field	Type	Description
url	string	none
action_name	string	none
oneof action.issues_command	IssuesCommand	none

FlatEvent

(synq.webhooks.v1.FlatEvent) A webhook event in the flat format — an experimental, opt-in alternative to Event that carries the same information in a flatter shape. Instead of nesting the payload under a per-event-type field (issue_created, issue_updated, incident_open, …), the payload is carried by a single top-level field — issue, incident, or ping — and event_type says which one is set and why. A receiver can then read a value the same way on every event, e.g. issue.owners[0].title on any issue event, instead of a different path per event type. Exactly one of issue, incident, or ping is set, matching event_type. Select this format per webhook integration; the default is the nested Event. Payload signing is identical — see Event for the signature scheme. Experimental: this shape may change while we gather feedback.

Field	Type	Description
workspace	string	none
event_id	string	none
event_time	Timestamp	none
event_type	EventType	Which event occurred, and which payload field below is set.
issue	IssueSummary	Issue payload. Set on every `EVENT_TYPE_ISSUE_*` event.
incident	IncidentSummary	Incident payload. Set on every `EVENT_TYPE_INCIDENT_*` event.
ping	Ping	Test payload. Set on `EVENT_TYPE_PING` (sent during webhook setup).
callbacks	repeated Callback	none

Event

(synq.webhooks.v1.Event) A webhook event delivered to a customer-configured endpoint. Payload signing: every outgoing request is signed so the receiver can verify it originated from Coalesce Quality and was not tampered with or replayed. Two headers are sent on every delivery: X-Coalesce-Timestamp: <unix seconds when the delivery was signed> X-Coalesce-Signature: v1=<hex-encoded HMAC-SHA256> The signature is computed as: signed_payload = “{X-Coalesce-Timestamp}.” + <raw request body bytes> signature = hex( HMAC_SHA256(key = signing_secret, msg = signed_payload) ) where signing_secret is the per-integration secret shown (read-only) in the webhook integration settings. To verify:

Read X-Coalesce-Timestamp and the raw request body.
Recompute the signature with your copy of the signing secret and compare it against the v1=… value in X-Coalesce-Signature using a constant-time comparison.
Optionally reject deliveries whose timestamp is outside your tolerance window (retries reuse the original signing timestamp, so allow for the retry backoff window — up to ~30 minutes).

The v1= prefix identifies the signature scheme; future schemes may add additional space-separated values to the header.

Field	Type	Description
workspace	string	none
event_id	string	none
event_time	Timestamp	none
event_type	EventType	none
oneof data.ping	Ping	none
oneof data.issue_created	IssueCreated	none
oneof data.issue_updated	IssueUpdated	none
oneof data.issue_status_updated	IssueStatusUpdated	none
oneof data.issue_closed	IssueClosed	none
oneof data.incident_open	IncidentOpen	none
oneof data.incident_closed	IncidentClosed	none
oneof data.incident_cancelled	IncidentCancelled	none
callbacks	repeated Callback	none

IncidentCancelled

(synq.webhooks.v1.IncidentCancelled)

Field	Type	Description
incident	IncidentSummary	none

IncidentClosed

(synq.webhooks.v1.IncidentClosed)

Field	Type	Description
incident	IncidentSummary	none

IncidentOpen

(synq.webhooks.v1.IncidentOpen)

Field	Type	Description
incident	IncidentSummary	none

IncidentSummary

(synq.webhooks.v1.IncidentSummary)

Field	Type	Description
incident_id	string	none
incident_url	string	none
title	string	none
description	string	none
description_html	string	none
started_at	Timestamp	none
oneof _ended_at.ended_at	optional Timestamp	none

IssueClosed

(synq.webhooks.v1.IssueClosed)

Field	Type	Description
issue	IssueSummary	none

IssueCreated

(synq.webhooks.v1.IssueCreated)

Field	Type	Description
issue	IssueSummary	none

IssueStatusUpdated

(synq.webhooks.v1.IssueStatusUpdated)

Field	Type	Description
issue	IssueSummary	none

IssueSummary

(synq.webhooks.v1.IssueSummary)

Field	Type	Description
issue_id	string	none
issue_group_id	string	none
issue_url	string	none
title	string	Summary of the issue, what happened and where.
description	string	Detailed description of the issue. In the Markdown format.
description_html	string	Detailed description of the issue. In the HTML format.
trigger_entity	IssueEntity	Entity which triggered the issue.
directly_affected_entities	repeated IssueEntity	Entities directly affected by the issue, not considering downstream ones.
monitored_entities	repeated IssueEntity	The primary entities being monitored that are associated with this issue, for example the dbt model or dbt Cloud job that a failing test is attached to.
started_at	Timestamp	Time when the issue was triggered.
oneof _ended_at.ended_at	optional Timestamp	Time when the issue was closed.
trigger_run_id	string	none
trigger_name	string	none
trigger_message	string	none
status	IssueStatus	none
oneof _status_actor.status_actor	optional Actor	The user who set the current status, when the transition was human-initiated (e.g. someone pressing Expected / Fixed / No action needed / Investigating in the app or via the public API). This is the same actor exposed by the Issues API as `Issue.latest_status_actor`, so the two feeds can be joined on it.

Set only when an actor is known: it is populated on issue_status_updated events and left unset for system-driven transitions with no human actor (e.g. a status implied by a monitor run). Consumers must treat it as optional and tolerate its absence. Carries the strongest identity the caller proved — a Coalesce Quality email, Slack user id, or PagerDuty user id — alongside a display name. | | owners | repeated Owner | Owners of the entities this issue is about. Covers only the direct owners of the affected entities, not the owners of downstream entities. Empty when the affected entities have no owner assigned. Ordered as shown in the app. |

IssueSummary.IssueEntity

(synq.webhooks.v1.IssueSummary.IssueEntity)

Field	Type	Description
name	string	none
type_name	string	none
identifier	Identifier	none
oneof _folder.folder	optional string	none
entity_url	string	none

IssueSummary.Owner

(synq.webhooks.v1.IssueSummary.Owner) An owner (person or team) responsible for an entity, as assigned in Coalesce Quality (natively or synced from a catalog).

Field	Type	Description
id	string	Identifier of the owner within the workspace. Matches the id on the Owners API, so callers can fetch the full owner record (contacts, source) from that API.
title	string	Display name of the owner, e.g. a team or person name.
url	string	Deep link to the owner in the Coalesce Quality app.

IssueUpdated

(synq.webhooks.v1.IssueUpdated)

Field	Type	Description
issue	IssueSummary	none

Ping

(synq.webhooks.v1.Ping) Test event sent during a webhook setup.

Field	Type	Description
message	string	none

MSSQLCloudConf

(synq.integrations.v1.MSSQLCloudConf) Microsoft SQL Server / Azure SQL Database cloud-managed connection. SQL Server connections are scoped to a single database; create one integration per database. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _host.host	optional string	Hostname or IP (Azure SQL e.g. “yourserver.database.windows.net”).
oneof _port.port	optional int32	Port (typically 1433).
oneof _database.database	optional string	Database to connect to and ingest metadata from.
oneof _username.username	optional string	Login username.
oneof _password.password	optional string	Login password. Write-only — masked on reads.
oneof _trust_cert.trust_cert	optional bool	Skip TLS server certificate verification (not recommended for Azure SQL).
oneof _encrypt.encrypt	optional string	Encryption mode: “true” (default, required for Azure SQL), “false”, “disable”.
oneof _fetch_query_logs.fetch_query_logs	optional bool	Ingest query logs from Query Store (must be enabled on the database; Azure SQL has it on by default).
oneof _scope.scope	optional ScopeFilter	Include/exclude scope filter (by schema and table; database-level filtering does not apply since the connection targets one database).
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.

DatabricksCloudConf

(synq.integrations.v1.DatabricksCloudConf) Databricks cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _workspace_url.workspace_url	optional string	Workspace URL (e.g. “https://your-workspace.cloud.databricks.com”).
oneof authentication.token	string	Personal access token. Write-only — masked on reads.
oneof authentication.oauth_m2m	DatabricksOAuthM2M	OAuth 2.0 machine-to-machine (service principal) auth.
oneof _warehouse_id.warehouse_id	optional string	SQL warehouse id (or cluster id) used to execute queries.
oneof _fetch_query_logs.fetch_query_logs	optional bool	Ingest query logs from system tables.
oneof _fetch_table_metrics.fetch_table_metrics	optional bool	Run ANALYZE TABLE to refresh and collect statistics.
oneof _fetch_table_metrics_scan.fetch_table_metrics_scan	optional bool	Run ANALYZE TABLE … SCAN for detailed metrics incl. row counts (more resource-intensive).
catalog_blocklist	repeated string	Catalog name patterns to exclude from ingestion.
oneof _fetch_table_tags.fetch_table_tags	optional bool	Retrieve Unity Catalog table tags.
oneof _use_show_create_table.use_show_create_table	optional bool	Use SHOW CREATE TABLE for table DDL (otherwise extracted from query logs).
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.
oneof _disable_unity_table_lineage.disable_unity_table_lineage	optional bool	Disable retrieval of Unity Catalog table-to-table lineage. Coalesce Quality already computes lineage from query logs, so the Unity Catalog edges can be redundant noise. When unset/false, Unity Catalog table-to-table lineage is retrieved and published (the default).

DatabricksOAuthM2M

(synq.integrations.v1.DatabricksOAuthM2M) Databricks OAuth 2.0 machine-to-machine (service principal) credentials.

Field	Type	Description
oneof _client_id.client_id	optional string	OAuth client id of the service principal.
oneof _client_secret.client_secret	optional string	OAuth client secret. Write-only — masked on reads.

AthenaAccessKeyAuth

(synq.integrations.v1.AthenaAccessKeyAuth) Amazon Athena access-key authentication (long-lived IAM user credentials).

Field	Type	Description
oneof _access_key_id.access_key_id	optional string	AWS access key id (e.g. “AKIA…“).
oneof _secret_access_key.secret_access_key	optional string	AWS secret access key. Write-only — masked on reads.

AthenaCloudConf

(synq.integrations.v1.AthenaCloudConf) Amazon Athena cloud-managed connection. Athena is serverless — there is no host/port; the endpoint is implied by the AWS region. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _region.region	optional string	AWS region hosting Athena and the Glue Data Catalog (e.g. “eu-central-1”).
oneof _workgroup.workgroup	optional string	Workgroup to run queries under. Defaults to “primary” when empty; must have a query result location configured.
oneof authentication.access_key	AthenaAccessKeyAuth	Long-lived IAM user access key.
oneof _use_show_create_table.use_show_create_table	optional bool	Use SHOW CREATE TABLE per object to retrieve full table DDL.
oneof _use_show_create_view.use_show_create_view	optional bool	Use SHOW CREATE VIEW per view to retrieve full view DDL.
oneof _fetch_query_logs.fetch_query_logs	optional bool	Fetch Athena query history (management API calls; no per-scan billing).
oneof _use_iceberg_metrics_scan.use_iceberg_metrics_scan	optional bool	For Iceberg tables, scan metadata tables for row counts and file sizes (one Athena query per table).
oneof _scope.scope	optional ScopeFilter	Include/exclude scope filter. ScopeRule.database = Glue catalog (usually “AwsDataCatalog”), ScopeRule.schema = Glue database, ScopeRule.table = table/view.

AthenaOutputs

(synq.integrations.v1.AthenaOutputs) Athena generated outputs.

Field	Type	Description
account_id	string	AWS account id resolved from the supplied credentials.
principal_arn	string	ARN of the IAM principal Coalesce Quality authenticates as. Reference it in your Athena / Glue resource policies.

BigQueryOutputs

(synq.integrations.v1.BigQueryOutputs) BigQuery generated outputs.

Field	Type	Description
service_account_email	string	Email of the service account derived from the supplied credentials. Grant this principal access to the datasets you want Coalesce Quality to read.

Capabilities

(synq.integrations.v1.Capabilities) Capabilities advertise which actions are valid for an integration in its current state, so a client can decide what to offer before calling. Capabilities are a hint computed from the integration’s type and current state; the server still enforces every action. A false flag means the action would be rejected right now (unsupported for this type, or not applicable in the current state — for example can_enable is false for an already-enabled integration).

Field	Type	Description
can_patch	bool	The configuration can be changed via `UpdateIntegration`. False for read-only / externally-owned integrations.
can_refresh	bool	An ad-hoc refresh can be triggered via `RefreshIntegration`.
can_disable	bool	The integration can be disabled via `DisableIntegration` (true only when currently enabled).
can_enable	bool	The integration can be enabled via `EnableIntegration` (true only when currently disabled).
can_delete	bool	The integration can be deleted via `DeleteIntegration`.
is_dwh	bool	Whether this is a data warehouse or database connection (rather than a transformation tool, catalog, etc.). Querying features — data preview, SQL tests, and reconciliation — are only available for these.
can_reconcile_deploy	bool	Whether scheduled and API-triggered reconciliations can run against this integration. True only when it is an enabled data warehouse and your workspace has enabled reconciliation for it. These runs use the integration’s workspace-level credentials, so this does not depend on any individual user’s personal connection.

Integration

(synq.integrations.v1.Integration) Integration is a connection from Coalesce Quality to one of your data systems (a warehouse, database, or transformation tool).

Field	Type	Description
id	string	Server-assigned unique identifier (UUID). Use it to address the integration in `GetIntegration`, `UpdateIntegration`, `DeleteIntegration`, and the enable / disable / refresh / health RPCs.
title	string	Human-friendly name shown in the Coalesce Quality UI. Set by you on create and editable via update.
disabled	bool	Whether the integration is currently disabled. A disabled integration keeps its configuration but is not scheduled or refreshed. Toggle with `EnableIntegration` / `DisableIntegration`.
created_at	Timestamp	When the integration was created.
updated_at	Timestamp	When the integration was last modified (configuration, title, or enabled / disabled state).
etag	string	Opaque entity tag for optimistic concurrency. Pass it back as `UpdateIntegrationRequest.etag` / `DeleteIntegrationRequest.etag` to ensure you are modifying the version you last read; a mismatch is rejected with a 409 / ABORTED. The value is weak (prefixed `W/`) and opaque — do not parse it.
platform	DataPlatformType	The data platform this integration connects to (for example POSTGRES, CLICKHOUSE, SNOWFLAKE). UNSPECIFIED for integrations that are not data warehouses or databases.
dialect	SqlDialect	The SQL dialect this integration understands — useful when writing SQL against it, such as custom monitors or reconciliation queries. Determined by the platform. UNSPECIFIED for integrations that are not data warehouses or databases.
config	IntegrationConfig	Connection configuration. Secret fields are masked (empty) on reads.
outputs	IntegrationOutputs	Server-generated outputs (read-only). Empty for types that produce none.
capabilities	Capabilities	Actions valid for this integration in its current state (read-only hint).

IntegrationConfig

(synq.integrations.v1.IntegrationConfig) IntegrationConfig is the connection configuration for an integration. Exactly one variant of the config oneof is set; the populated variant determines the integration’s type. The config holds the connection details (host, credentials, scope) for the connected system. Secret fields (passwords, tokens, keys) follow write-only semantics: they are masked (returned empty) on reads. See each *Conf message and IntegrationsService.UpdateIntegration for preserve / rotate / clear rules.

Field	Type	Description
oneof config.bigquery	BigQueryCloudConf	Google BigQuery connection.
oneof config.snowflake	SnowflakeCloudConf	Snowflake connection.
oneof config.redshift	RedshiftCloudConf	Amazon Redshift connection.
oneof config.postgres	PostgresCloudConf	PostgreSQL connection.
oneof config.mysql	MySQLCloudConf	MySQL connection.
oneof config.clickhouse	ClickhouseCloudConf	ClickHouse connection.
oneof config.databricks	DatabricksCloudConf	Databricks connection.
oneof config.trino	TrinoCloudConf	Trino / Presto connection.
oneof config.mssql	MSSQLCloudConf	Microsoft SQL Server / Azure SQL connection.
oneof config.oracle	OracleCloudConf	Oracle Database connection.
oneof config.duckdb	DuckDBCloudConf	DuckDB / MotherDuck connection.
oneof config.athena	AthenaCloudConf	Amazon Athena connection.
oneof config.dbt_cloud	DbtCloudConf	dbt Cloud connection.
oneof config.fabric	FabricCloudConf	Microsoft Fabric connection.

IntegrationOutputs

(synq.integrations.v1.IntegrationOutputs) Generated, non-secret values produced by the server when an integration is created (for example a service-account email to grant access to, or a public key to install). Outputs are read-only and are never accepted on writes. At most one variant is set, matching the integration’s type. Types that produce no outputs leave this message empty.

Field	Type	Description
oneof outputs.bigquery	BigQueryOutputs	BigQuery: the service-account identity to grant dataset access to.
oneof outputs.snowflake	SnowflakeOutputs	Snowflake: the public key to register when using key-pair auth.
oneof outputs.athena	AthenaOutputs	Athena: the resolved AWS caller identity.

SnowflakeOutputs

(synq.integrations.v1.SnowflakeOutputs) Snowflake generated outputs.

Field	Type	Description
public_key	string	Public key (PEM) to register on the Snowflake user when authenticating with a Coalesce Quality–managed key pair. Empty when you supply your own credentials.

DbtCloudConf

(synq.integrations.v1.DbtCloudConf) dbt Cloud transformation orchestration cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _account_id.account_id	optional string	dbt Cloud account id (the numeric id from your dbt Cloud URL).
job_ids	repeated string	dbt Cloud jobs to track, by job id. Provide the full set on every update (the list is replaced, not merged). When empty, all jobs visible to the API token are tracked.
oneof _token.token	optional string	dbt Cloud API token (service token recommended). Write-only — masked on reads; omit to keep the stored token, send a new value to rotate it.
oneof _project_id.project_id	optional string	Project id used to generate asset identifiers. Use the same id for multiple projects that should be merged.
oneof _api_endpoint.api_endpoint	optional string	dbt Cloud API hostname without scheme (e.g. “cloud.getdbt.com”, “emea.dbt.com”). Empty uses the multi-tenant default.
oneof _default_database_instance.default_database_instance	optional string	Database instance identifier, required where database names are not globally unique (e.g. a Snowflake account).

OracleCloudConf

(synq.integrations.v1.OracleCloudConf) Oracle Database cloud-managed connection. Oracle connections are scoped to a Pluggable Database (PDB) via the service name. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _host.host	optional string	Host address or IP (OCI Autonomous DB e.g. “adb.eu-frankfurt-1.oraclecloud.com”).
oneof _port.port	optional int32	Listener port (typically 1521; OCI Autonomous DB with mTLS uses 1522).
oneof _service_name.service_name	optional string	Service name / PDB name (OCI Autonomous DB e.g. “mydb_high”).
oneof _username.username	optional string	Username.
oneof _password.password	optional string	Password. Write-only — masked on reads.
oneof _ssl.ssl	optional bool	Enable TLS/SSL (TCPS). Required for OCI Autonomous Database.
oneof _ssl_verify.ssl_verify	optional bool	Verify the server certificate when SSL is enabled.
oneof _fetch_query_logs.fetch_query_logs	optional bool	Ingest query logs (V$SQL by default, DBA_HIST with the Diagnostics Pack).
oneof _use_diagnostics_pack.use_diagnostics_pack	optional bool	Use the Oracle Diagnostics Pack (AWR) for persistent query-log history (requires a license; included with OCI Autonomous Database).
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.

DuckDBCloudConf

(synq.integrations.v1.DuckDBCloudConf) DuckDB (via MotherDuck) cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _motherduck_account.motherduck_account	optional string	MotherDuck account name or identifier.
oneof _access_token.access_token	optional string	MotherDuck access token. Write-only — masked on reads.
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.

FabricCloudConf

(synq.integrations.v1.FabricCloudConf) Microsoft Fabric cloud-managed connection. Fabric is workspace-scoped with cross-database queries (like Snowflake or Databricks, not a single database): the workspace SQL analytics endpoint exposes every warehouse / lakehouse in the workspace as a database, queryable via three-part [database].[schema].[table] T-SQL names. Authentication is Microsoft Entra ID only — Fabric rejects SQL logins, so the headless identity is an Entra service principal (application id + secret), or a pre-acquired Entra access token. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _host.host	optional string	Workspace SQL analytics endpoint host, e.g. “<workspace-id>.datawarehouse.fabric.microsoft.com”.
oneof _database.database	optional string	Default execution database — the context in which unqualified ad-hoc / monitor SQL resolves. Defaults to “master” (the always-present workspace entry point) when empty. Metadata reads and generated metrics SQL are fully database-qualified, so this only affects unqualified queries.
oneof authentication.service_principal	FabricServicePrincipalAuth	Entra service principal (application id + secret).
oneof _access_token.access_token	optional string	Pre-acquired Entra OAuth access token for the SQL scope (https://database.windows.net/.default). When set, takes precedence over the service principal — for callers that mint their own token out of band (managed identity / workload-identity federation). Write-only — masked on reads.
oneof _fetch_query_logs.fetch_query_logs	optional bool	Fetch Fabric query history for cost attribution and SQL / column-level lineage. Management-plane reads only, no per-query billing.
oneof _scope.scope	optional ScopeFilter	Include/exclude scope filter. ScopeRule.database = Fabric database / warehouse, ScopeRule.schema = schema, ScopeRule.table = table / view.

FabricServicePrincipalAuth

(synq.integrations.v1.FabricServicePrincipalAuth) Microsoft Fabric Entra service-principal credentials.

Field	Type	Description
oneof _client_id.client_id	optional string	Entra application (client) ID of the service principal.
oneof _client_secret.client_secret	optional string	Service principal client secret. Write-only — masked on reads.
oneof _tenant_id.tenant_id	optional string	Entra tenant (directory) ID. Optional: inferred from the Fabric endpoint when empty; set it when the authority is not the service principal’s home tenant.

RedshiftCloudConf

(synq.integrations.v1.RedshiftCloudConf) Amazon Redshift cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _user.user	optional string	Username.
oneof _password.password	optional string	Password. Write-only — masked on reads.
oneof _host.host	optional string	Cluster endpoint hostname.
oneof _port.port	optional int32	Port (typically 5439).
oneof _database.database	optional string	Database to connect to and ingest metadata from.
oneof _fetch_query_logs.fetch_query_logs	optional bool	Ingest query logs from system views.
oneof _freshness_from_query_logs.freshness_from_query_logs	optional bool	Estimate table freshness from query logs (SYS_QUERY_DETAIL).
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.

BatchGetIntegrationsRequest

(synq.integrations.v1.BatchGetIntegrationsRequest) Request to fetch multiple integrations by id.

Field	Type	Description
integration_ids	repeated string	Integration ids (UUIDs). Unknown ids are omitted from the response.

BatchGetIntegrationsResponse

(synq.integrations.v1.BatchGetIntegrationsResponse) Response with the requested integrations.

Field	Type	Description
integrations	map IntegrationsEntry	The integrations that were found, keyed by integration id. Requested ids that do not exist are absent from the map.

BatchGetIntegrationsResponse.IntegrationsEntry

(synq.integrations.v1.BatchGetIntegrationsResponse.IntegrationsEntry)

Field	Type	Description
key	string	none
value	Integration	none

CreateIntegrationRequest

(synq.integrations.v1.CreateIntegrationRequest) Request to create an integration.

Field	Type	Description
title	string	Human-friendly name for the integration.
config	IntegrationConfig	Connection configuration. Exactly one `config` variant must be set; it fixes the integration’s type.

CreateIntegrationResponse

(synq.integrations.v1.CreateIntegrationResponse) Response from creating an integration.

Field	Type	Description
integration	Integration	The created integration, including its assigned id, etag, and any generated outputs.

DeleteIntegrationRequest

(synq.integrations.v1.DeleteIntegrationRequest) Request to delete an integration.

Field	Type	Description
integration_id	string	Id of the integration to delete (UUID).
oneof _etag.etag	optional string	Optional optimistic-concurrency guard (see `UpdateIntegrationRequest.etag`).

DeleteIntegrationResponse

(synq.integrations.v1.DeleteIntegrationResponse) Response from deleting an integration.

DisableIntegrationRequest

(synq.integrations.v1.DisableIntegrationRequest) Request to disable an integration.

Field	Type	Description
integration_id	string	Id of the integration to disable (UUID).

DisableIntegrationResponse

(synq.integrations.v1.DisableIntegrationResponse) Response from disabling an integration.

Field	Type	Description
integration	Integration	The integration after disabling.

EnableIntegrationRequest

(synq.integrations.v1.EnableIntegrationRequest) Request to enable an integration.

Field	Type	Description
integration_id	string	Id of the integration to enable (UUID).

EnableIntegrationResponse

(synq.integrations.v1.EnableIntegrationResponse) Response from enabling an integration.

Field	Type	Description
integration	Integration	The integration after enabling.

GetIntegrationHealthRequest

(synq.integrations.v1.GetIntegrationHealthRequest) Request for an integration’s health and run history.

Field	Type	Description
integration_id	string	Id of the integration (UUID).
oneof _pagination.pagination	optional Pagination	Cursor-based pagination over the run history. Omit for a bounded recent window (most recent runs from the last 7 days).

GetIntegrationHealthResponse

(synq.integrations.v1.GetIntegrationHealthResponse) Response with current health plus a page of recent runs.

Field	Type	Description
health	IntegrationHealth	Current health summary.
runs	repeated IntegrationRun	Recent runs, most recent first.
page_info	PageInfo	Pagination metadata; pass `page_info.last_id` as the next cursor.

GetIntegrationRequest

(synq.integrations.v1.GetIntegrationRequest) Request to fetch a single integration.

Field	Type	Description
integration_id	string	Integration id (UUID).

GetIntegrationResponse

(synq.integrations.v1.GetIntegrationResponse) Response with a single integration.

Field	Type	Description
integration	Integration	The requested integration.

IntegrationHealth

(synq.integrations.v1.IntegrationHealth) Current health summary for an integration.

Field	Type	Description
status	HealthStatus	Status derived from the most recent run.
oneof _last_run_at.last_run_at	optional Timestamp	When the most recent run occurred. Unset when no runs are observed.
oneof _last_success_at.last_success_at	optional Timestamp	When the most recent successful run occurred. Unset when none is observed.
message	string	Human-readable message from the most recent run (for example an error summary). Empty when there is nothing to report.
healthy	bool	Convenience flag: true when `status` is OK and the last run is recent relative to the integration’s expected refresh cadence.

IntegrationRun

(synq.integrations.v1.IntegrationRun) A single observed run (refresh / sync) of an integration.

Field	Type	Description
run_id	string	Run identifier.
status	HealthStatus	Outcome of this run.
started_at	Timestamp	When the run started.
oneof _finished_at.finished_at	optional Timestamp	When the run finished. Unset while still running.
message	string	Human-readable message for this run (for example an error summary). Empty when there is nothing to report.

ListIntegrationsRequest

(synq.integrations.v1.ListIntegrationsRequest) Request to list integrations.

Field	Type	Description
oneof _disabled.disabled	optional bool	Optional filter: when set, return only enabled (false) or only disabled (true) integrations. Unset means both.

ListIntegrationsResponse

(synq.integrations.v1.ListIntegrationsResponse) Response with the workspace’s integrations.

Field	Type	Description
integrations	repeated Integration	All integrations matching the request.

RefreshIntegrationRequest

(synq.integrations.v1.RefreshIntegrationRequest) Request to trigger an ad-hoc refresh.

Field	Type	Description
integration_id	string	Id of the integration to refresh (UUID).

RefreshIntegrationResponse

(synq.integrations.v1.RefreshIntegrationResponse) Response from triggering a refresh.

UpdateIntegrationRequest

(synq.integrations.v1.UpdateIntegrationRequest) Request to update an integration. The config is replaced wholesale; title is patch-style (omit to leave unchanged).

Field	Type	Description
integration_id	string	Id of the integration to update (UUID).
oneof _title.title	optional string	New human-friendly name. Omit to leave the title unchanged.
config	IntegrationConfig	New connection configuration. The populated `config` variant must match the existing integration’s type.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard. When set, the update is applied only if it matches the integration’s current etag; otherwise ABORTED (HTTP 409). Omit for last-write-wins.

UpdateIntegrationResponse

(synq.integrations.v1.UpdateIntegrationResponse) Response from updating an integration.

Field	Type	Description
integration	Integration	The updated integration with a new etag.

PostgresCloudConf

(synq.integrations.v1.PostgresCloudConf) PostgreSQL cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _user.user	optional string	Username.
oneof _password.password	optional string	Password. Write-only — masked on reads.
oneof _host.host	optional string	Host address or IP.
oneof _port.port	optional int32	Port (typically 5432).
oneof _database.database	optional string	Database to connect to and ingest metadata from.
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.

ClickhouseCloudConf

(synq.integrations.v1.ClickhouseCloudConf) ClickHouse cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _host.host	optional string	Host address or IP.
oneof _port.port	optional string	Port (e.g. “8123” for HTTP, “9440” for HTTPS).
oneof _username.username	optional string	Username.
oneof _password.password	optional string	Password. Write-only — masked on reads.
oneof _default_dataset.default_dataset	optional string	Default database/schema used when not specified in a reference.
additional_parameters	map AdditionalParametersEntry	Additional connection parameters as key/value pairs (e.g. “max_execution_time”: “30”).
oneof _ssl.ssl	optional bool	Enable SSL/TLS.
oneof _database_name.database_name	optional string	Database to connect to and ingest metadata from.
oneof _fetch_query_logs.fetch_query_logs	optional bool	Ingest query logs from system.query_log.
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.

ClickhouseCloudConf.AdditionalParametersEntry

(synq.integrations.v1.ClickhouseCloudConf.AdditionalParametersEntry)

Field	Type	Description
key	string	none
value	string	none

MySQLCloudConf

(synq.integrations.v1.MySQLCloudConf) MySQL cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _user.user	optional string	Username.
oneof _password.password	optional string	Password. Write-only — masked on reads.
oneof _host.host	optional string	Host address or IP.
oneof _port.port	optional int32	Port (typically 3306).
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.

SnowflakeCloudConf

(synq.integrations.v1.SnowflakeCloudConf) Snowflake cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _user.user	optional string	Snowflake username.
oneof authentication.password	string	Password. Write-only — masked on reads.
oneof authentication.key_pair	SnowflakeKeyPairAuth	Key-pair authentication.
oneof _account.account	optional string	Account identifier (e.g. “xy12345.us-east-1”) without scheme or trailing slash.
oneof _warehouse.warehouse	optional string	Warehouse to run queries on.
databases	repeated string	Databases to monitor and ingest metadata from.
oneof _role.role	optional string	Role to use for metadata access and queries.
oneof _fetch_query_logs.fetch_query_logs	optional bool	Ingest query logs from the ACCOUNT_USAGE schema.
fetch_query_logs_databases	repeated string	Databases to fetch query logs from (defaults to all configured databases).
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.
oneof _no_get_ddl.no_get_ddl	optional bool	Skip GET_DDL for table definitions (use query logs instead).
oneof _fetch_tasks.fetch_tasks	optional bool	Ingest Snowflake Tasks metadata.
fetch_tasks_databases	repeated string	Databases to retrieve tasks from (defaults to all configured databases).
oneof _fetch_tasks_executions_from_account_usage.fetch_tasks_executions_from_account_usage	optional bool	Use ACCOUNT_USAGE.TASK_HISTORY for task execution history.
oneof _fetch_tasks_executions_duration.fetch_tasks_executions_duration	optional Duration	Time range for fetching task execution history (minimum 5 minutes).
oneof _fetch_table_lineage.fetch_table_lineage	optional bool	Produce table-level lineage via GET_LINEAGE (Enterprise edition or higher).
fetch_table_lineage_databases	repeated string	Databases to fetch upstream lineage from (defaults to `databases`).
oneof _account_usage_db.account_usage_db	optional string	Database where the ACCOUNT_USAGE schema lives (defaults to “SNOWFLAKE”).

SnowflakeKeyPairAuth

(synq.integrations.v1.SnowflakeKeyPairAuth) Snowflake key-pair authentication.

Field	Type	Description
oneof _private_key_secret.private_key_secret	optional string	PEM-encoded private key (PKCS#8). Write-only — masked on reads. Required when using key-pair auth.
oneof _public_key.public_key	optional string	Public key corresponding to the private key. For a Coalesce Quality–managed key pair this is returned so you can register it on the Snowflake user; when you supply your own key it is optional.
oneof _private_key_passphrase.private_key_passphrase	optional string	Optional passphrase for an encrypted private key. Write-only — masked on reads.

TrinoBasicAuth

(synq.integrations.v1.TrinoBasicAuth) Trino basic (username / password) authentication.

Field	Type	Description
oneof _user.user	optional string	Trino username.
oneof _password.password	optional string	Trino password. Write-only — masked on reads.

TrinoCloudConf

(synq.integrations.v1.TrinoCloudConf) Trino / Presto cloud-managed connection. Fields are optional so an update can carry only what changes (omit = leave unchanged). Secret fields are write-only (masked on reads); omit to keep or send a new value to rotate.

Field	Type	Description
oneof _host.host	optional string	Coordinator hostname or IP.
oneof _port.port	optional int32	Port (leave unset for the driver default — typically 443 for HTTPS, 8080 for HTTP).
oneof authentication.basic	TrinoBasicAuth	Basic username/password auth.
catalogs	repeated string	Catalogs to ingest metadata from (e.g. [“hive”, “postgresql”]).
oneof _fetch_query_logs.fetch_query_logs	optional bool	Ingest query logs from system tables.
oneof _no_show_create_view.no_show_create_view	optional bool	Disable SHOW CREATE VIEW for view DDL.
oneof _no_show_create_table.no_show_create_table	optional bool	Disable SHOW CREATE TABLE for table DDL.
oneof _no_materialized_views.no_materialized_views	optional bool	Disable fetching materialized views from system.metadata.materialized_views.
oneof _fetch_table_comments.fetch_table_comments	optional bool	Fetch table comments from system.metadata.table_comments.
oneof _use_plaintext.use_plaintext	optional bool	Use plaintext HTTP instead of HTTPS. Only enable when SSL is unsupported or the connection is otherwise secured (e.g. a VPN).
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs.

BigQueryCloudConf

(synq.integrations.v1.BigQueryCloudConf) Google BigQuery cloud-managed connection. All fields are optional so an update can carry only what changes: omit a field to leave it unchanged, or send a new value to set it. Secret fields are write-only (masked, returned empty, on reads); omit to keep the stored value or send a new value to rotate it.

Field	Type	Description
oneof _project_id.project_id	optional string	Google Cloud project id containing the datasets to monitor.
blacklisted_datasets	repeated string	Dataset name patterns to exclude from ingestion. Mutually exclusive with `datasets` — when `datasets` is set, this is ignored.
oneof _service_account_key.service_account_key	optional string	Service-account key JSON. Write-only — masked on reads.
oneof _region.region	optional string	Google Cloud region for the project (e.g. “us-central1”, “EU”).
oneof _fetch_query_logs.fetch_query_logs	optional bool	Ingest BigQuery query logs from INFORMATION_SCHEMA.
oneof _audit_table_fqn.audit_table_fqn	optional string	Fully-qualified table for storing SQL test audit logs (e.g. “project.dataset.table”).
datasets	repeated string	Explicit list of datasets to scrape. When set, only these are queried (no project-level dataset listing needed). When empty, all visible datasets are discovered. Mutually exclusive with `blacklisted_datasets`.

IamRequest

(synq.auth.iam.v1.IamRequest)

IamResponse

(synq.auth.iam.v1.IamResponse)

Field	Type	Description
workspace	string	Workspace to which caller is authenticated
scopes	repeated Scope	What scopes are granted
scope_names	repeated string	Names of the scopes available
oneof _integration_id.integration_id	optional string	Indicates that the token is scoped to a specific integration
subject	string	Identifier of the provided token
oneof _synq_user_id.synq_user_id	optional string	Coalesce Quality user ID associated with the token, present for user-level credentials
oneof _client_type.client_type	optional string	Indicates the client type through which the request was made
oneof _user_name.user_name	optional string	Human-readable name of the authenticated user. Populated only when the token is tied to a Coalesce Quality user (i.e. `synq_user_id` is set); empty for workspace-level or third-party tokens.
oneof _user_email.user_email	optional string	Email address of the authenticated user. Populated only when the token is tied to a Coalesce Quality user (i.e. `synq_user_id` is set); empty for workspace-level or third-party tokens.

GetAtlanConnectionsRequest

(synq.extensions.atlan.provider.v1.GetAtlanConnectionsRequest)

GetAtlanConnectionsResponse

(synq.extensions.atlan.provider.v1.GetAtlanConnectionsResponse)

Field	Type	Description
connections	repeated AtlanConnection	none

GetAtlanDataProductsRequest

(synq.extensions.atlan.provider.v1.GetAtlanDataProductsRequest)

GetAtlanDataProductsResponse

(synq.extensions.atlan.provider.v1.GetAtlanDataProductsResponse)

Field	Type	Description
data_products	repeated AtlanDataProduct	none

GetAtlanDomainsRequest

(synq.extensions.atlan.provider.v1.GetAtlanDomainsRequest)

GetAtlanDomainsResponse

(synq.extensions.atlan.provider.v1.GetAtlanDomainsResponse)

Field	Type	Description
domains	repeated AtlanDataDomain	none

AtlanConnection

(synq.extensions.atlan.provider.v1.AtlanConnection)

Field	Type	Description
name	string	none
qualified_name	string	none

AtlanDataDomain

(synq.extensions.atlan.provider.v1.AtlanDataDomain)

Field	Type	Description
name	string	none
qualified_name	string	none
oneof _parent.parent	optional AtlanDataDomain	none

AtlanDataProduct

(synq.extensions.atlan.provider.v1.AtlanDataProduct)

Field	Type	Description
name	string	none
qualified_name	string	none
oneof _domain.domain	optional AtlanDataDomain	none
owner_users	Emails	emails for the owner users
owner_groups	map OwnerGroupsEntry	emails for the owner groups mapped against group ID

AtlanDataProduct.Emails

(synq.extensions.atlan.provider.v1.AtlanDataProduct.Emails)

Field	Type	Description
emails	repeated string	none

AtlanDataProduct.OwnerGroupsEntry

(synq.extensions.atlan.provider.v1.AtlanDataProduct.OwnerGroupsEntry)

Field	Type	Description
key	string	none
value	Emails	none

DomainMappingToggle

(synq.extensions.atlan.workflows.v1.DomainMappingToggle)

Field	Type	Description
atlan_domain_qualified_name	string	none

MappingToggle

(synq.extensions.atlan.workflows.v1.MappingToggle)

Field	Type	Description
oneof mapping.product_mapping	ProductMappingToggle	none
oneof mapping.domain_mapping	DomainMappingToggle	none
oneof mapping.product_owner_mapping	ProductOwnerMappingToggle	none
enabled	bool	none

ProductMappingToggle

(synq.extensions.atlan.workflows.v1.ProductMappingToggle)

Field	Type	Description
atlan_product_qualified_name	string	none

ProductOwnerMappingToggle

(synq.extensions.atlan.workflows.v1.ProductOwnerMappingToggle)

Field	Type	Description
atlan_product_qualified_name	string	none

FetchRunsRequest

(synq.extensions.atlan.workflows.v1.FetchRunsRequest)

Field	Type	Description
from	int32	none
limit	int32	none

FetchRunsResponse

(synq.extensions.atlan.workflows.v1.FetchRunsResponse)

Field	Type	Description
workflow_runs	repeated WorkflowRun	none

GetConnectionMappingsRequest

(synq.extensions.atlan.workflows.v1.GetConnectionMappingsRequest)

GetConnectionMappingsResponse

(synq.extensions.atlan.workflows.v1.GetConnectionMappingsResponse)

Field	Type	Description
mappings	repeated ConnectionMapping	none

GetDomainMappingsRequest

(synq.extensions.atlan.workflows.v1.GetDomainMappingsRequest)

GetDomainMappingsResponse

(synq.extensions.atlan.workflows.v1.GetDomainMappingsResponse)

Field	Type	Description
mappings	repeated DomainMapping	none

GetMappingTogglesRequest

(synq.extensions.atlan.workflows.v1.GetMappingTogglesRequest)

GetMappingTogglesResponse

(synq.extensions.atlan.workflows.v1.GetMappingTogglesResponse)

Field	Type	Description
toggles	repeated MappingToggle	none

GetProductMappingsRequest

(synq.extensions.atlan.workflows.v1.GetProductMappingsRequest)

GetProductMappingsResponse

(synq.extensions.atlan.workflows.v1.GetProductMappingsResponse)

Field	Type	Description
mappings	repeated ProductMapping	none

RemoveConnectionMappingsRequest

(synq.extensions.atlan.workflows.v1.RemoveConnectionMappingsRequest)

Field	Type	Description
atlan_connection_qualified_names	repeated string	none

RemoveConnectionMappingsResponse

(synq.extensions.atlan.workflows.v1.RemoveConnectionMappingsResponse)

SetConnectionMappingsRequest

(synq.extensions.atlan.workflows.v1.SetConnectionMappingsRequest)

Field	Type	Description
mappings	repeated ConnectionMapping	none

SetConnectionMappingsResponse

(synq.extensions.atlan.workflows.v1.SetConnectionMappingsResponse)

SetMappingTogglesRequest

(synq.extensions.atlan.workflows.v1.SetMappingTogglesRequest)

Field	Type	Description
toggles	repeated MappingToggle	none

SetMappingTogglesResponse

(synq.extensions.atlan.workflows.v1.SetMappingTogglesResponse)

SynchronizeRequest

(synq.extensions.atlan.workflows.v1.SynchronizeRequest)

Field	Type	Description
use_v2	bool	none

SynchronizeResponse

(synq.extensions.atlan.workflows.v1.SynchronizeResponse)

Field	Type	Description
workflow_run	WorkflowRun	none
has_errors	bool	none

CommandResult

(synq.extensions.atlan.workflows.v1.CommandResult)

Field	Type	Description
command	string	none
status	Status	none
logs	repeated string	none
oneof _error.error	optional string	none

Log

(synq.extensions.atlan.workflows.v1.Log)

Field	Type	Description
message	string	none
timestamp	Timestamp	none
status	Status	none
metadata	map MetadataEntry	none

Log.MetadataEntry

(synq.extensions.atlan.workflows.v1.Log.MetadataEntry)

Field	Type	Description
key	string	none
value	string	none

WorkflowRun

(synq.extensions.atlan.workflows.v1.WorkflowRun)

Field	Type	Description
workspace	string	none
results	repeated CommandResult	Deprecated: Use Log instead.
status	Status	none
started_at	Timestamp	none
ended_at	Timestamp	none
logs	repeated Log	none

ConnectionMapping

(synq.extensions.atlan.workflows.v1.ConnectionMapping)

Field	Type	Description
atlan_connection_qualified_name	string	none
synq_data_platform_identifier	DataPlatformIdentifier	none

DomainMapping

(synq.extensions.atlan.workflows.v1.DomainMapping)

Field	Type	Description
atlan_domain_qualified_name	string	none
synq_domain_id	string	none

ProductMapping

(synq.extensions.atlan.workflows.v1.ProductMapping)

Field	Type	Description
atlan_dataproduct_qualified_name	string	none
synq_dataproduct_identifier	DataproductIdentifier	none

Integration

(synq.extensions.atlan.integrations.v1.Integration)

Field	Type	Description
workspace	string	none
id	string	ID for the integration. Unique for a workspace.
atlan_tenant_url	string	none
atlan_api_token	string	none
is_valid	bool	Whether the integration is valid or not. Set on `upsert` as a result of connection to atlan api.
is_active	bool	Whether the integration is active or not. Only valid integrations can be activated.
created_at	Timestamp	none
oneof _deleted_at.deleted_at	optional Timestamp	none
updated_at	Timestamp	none

ActivateRequest

(synq.extensions.atlan.integrations.v1.ActivateRequest)

Field	Type	Description
activate	bool	none

ActivateResponse

(synq.extensions.atlan.integrations.v1.ActivateResponse)

GetRequest

(synq.extensions.atlan.integrations.v1.GetRequest)

GetResponse

(synq.extensions.atlan.integrations.v1.GetResponse)

Field	Type	Description
integration	Integration	none

PingRequest

(synq.extensions.atlan.integrations.v1.PingRequest)

Field	Type	Description
atlan_tenant_url	string	none
atlan_api_token	string	none

PingResponse

(synq.extensions.atlan.integrations.v1.PingResponse)

Field	Type	Description
success	bool	none

RemoveRequest

(synq.extensions.atlan.integrations.v1.RemoveRequest)

RemoveResponse

(synq.extensions.atlan.integrations.v1.RemoveResponse)

UpsertRequest

(synq.extensions.atlan.integrations.v1.UpsertRequest)

Field	Type	Description
atlan_tenant_url	string	none
atlan_api_token	string	none

UpsertResponse

(synq.extensions.atlan.integrations.v1.UpsertResponse)

Field	Type	Description
integration	Integration	none

ScopeAuthorization

(synq.v1.ScopeAuthorization)

Field	Type	Description
scopes	repeated Scope	none

PageInfo

(synq.v1.PageInfo)

Field	Type	Description
total_count	int32	Total number of items matching the request. May not be available for cursor-based pagination where the total is unknown or expensive to compute. Deprecated: most of the APIs which require pagination don’t know the total count.
count	int32	Number of items returned in this response.
last_id	string	Opaque cursor token for fetching the next page of results. Pass this value as the cursor in the next Pagination request to continue pagination. Empty if there are no more pages.

Pagination

(synq.v1.Pagination)

Field	Type	Description
oneof _cursor.cursor	optional string	Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.
oneof _page_size.page_size	optional int32	Maximum number of items to return in a single page. If not provided, defaults vary per API.

BatchGetIssuesRequest

(synq.issues.v2.BatchGetIssuesRequest)

Field	Type	Description
issue_ids	repeated string	IDs of the issues to get.

BatchGetIssuesResponse

(synq.issues.v2.BatchGetIssuesResponse)

Field	Type	Description
issues	map IssuesEntry	Issues.

BatchGetIssuesResponse.IssuesEntry

(synq.issues.v2.BatchGetIssuesResponse.IssuesEntry)

Field	Type	Description
key	string	none
value	Issue	none

ClearStatusRequest

(synq.issues.v2.ClearStatusRequest)

Field	Type	Description
issue_id	string	ID of the issue whose status should be cleared.
actor	Actor	Actor clearing the status.
oneof _time.time	optional Timestamp	Time at which the status was cleared. Defaults to the current time when not provided.

ClearStatusResponse

(synq.issues.v2.ClearStatusResponse)

InteractionFilter

(synq.issues.v2.InteractionFilter) Filter for matching issues where an actor interacted with them. If none of status_changes/comments/activities is set, all interaction types are matched.

Field	Type	Description
identities	repeated string	Identity strings to match against the actor that performed the interaction. The caller is responsible for resolving a user to all their known identities (e.g. via GetUserIdentities or GetUserAliases + actoridentities.FromUserAliases()) before calling this API. Format: “synq:<user_id>”, “email:<email>”, “slack:<slack_user_id>”, etc.
status_changes	bool	Match issues where the user set a status (investigating, fixed, expected, etc.).
comments	bool	Match issues where the user posted a comment.
activities	bool	Match issues where the user has an activity record.

ListIssuesRequest

(synq.issues.v2.ListIssuesRequest)

Field	Type	Description
oneof _entities_query.entities_query	optional Query	Filter by entities.
oneof _time.time	optional Time	Time range filter
oneof _sort.sort	optional Sort	Sort options
oneof _pagination.pagination	optional Pagination	Pagination
oneof _lifecycle_state.lifecycle_state	optional LifecycleState	Filter by issue lifecycle state
lifecycle_states	repeated LifecycleState	Filter by issue lifecycle states
oneof _interacted_by.interacted_by	optional InteractionFilter	Filter issues by users who interacted with them (status change, comment, or activity).
severities	repeated Severity	Filter by issue severity. If empty, issues of any severity are returned.

ListIssuesRequest.Sort

(synq.issues.v2.ListIssuesRequest.Sort)

Field	Type	Description
sort_by	Field	none
order	Order	none

ListIssuesRequest.Time

(synq.issues.v2.ListIssuesRequest.Time)

Field	Type	Description
field	Field	none
from	Timestamp	none
to	Timestamp	none

ListIssuesResponse

(synq.issues.v2.ListIssuesResponse)

Field	Type	Description
page_info	PageInfo	Paging information.
issue_ids	repeated string	none

MarkExpectedRequest

(synq.issues.v2.MarkExpectedRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as expected.
actor	Actor	Actor marking the issue as expected.
time	Timestamp	Time at which the issue was marked as expected. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

MarkExpectedResponse

(synq.issues.v2.MarkExpectedResponse)

MarkFixedRequest

(synq.issues.v2.MarkFixedRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as fixed.
actor	Actor	Actor marking the issue as fixed.
time	Timestamp	Time at which the issue was marked as fixed. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

MarkFixedResponse

(synq.issues.v2.MarkFixedResponse)

MarkInvestigatingRequest

(synq.issues.v2.MarkInvestigatingRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as investigating.
actor	Actor	Actor marking the issue as investigating.
time	Timestamp	Time at which the issue was marked as investigating. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

MarkInvestigatingResponse

(synq.issues.v2.MarkInvestigatingResponse)

MarkNoActionNeededRequest

(synq.issues.v2.MarkNoActionNeededRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as no action needed.
actor	Actor	Actor marking the issue as no action needed.
time	Timestamp	Time at which the issue was marked as no action needed. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

MarkNoActionNeededResponse

(synq.issues.v2.MarkNoActionNeededResponse)

PostCommentRequest

(synq.issues.v2.PostCommentRequest)

Field	Type	Description
issue_id	string	ID of the issue to post a comment on.
actor	Actor	Actor posting the comment.
comment	string	Comment to post.
time	Timestamp	Time at which the comment was posted. Defaults to the current time.

PostCommentResponse

(synq.issues.v2.PostCommentResponse)

Field	Type	Description
comment_id	string	none

Actor

(synq.issues.actor.v1.Actor) Actor identifies who performed a write — set by the calling client and carried end-to-end through the public API into stored audit trails (issue status changes, comments, incident assignments) and rendered downstream (e.g. Slack/MSTeams/email alerts). Producers should populate:

name — human-readable display label, derived from synq.auth.iam.v1.IamResponse.user_name when available, falling back to user_email. Avoid generic placeholders (“MCP”, “API”); readers treat those as “no identity resolved” and fall back to impersonal copy.
user — the strongest identifier the caller can prove. For human callers, set email from IamResponse.user_email so the server can resolve the caller back to a workspace user.
via — entry-point label for the channel through which the request arrived (e.g. VIA_MCP for the MCP server), regardless of who the caller is.

Field	Type	Description
name	string	none
oneof user.slack	SlackUser	none
oneof user.email	EmailUser	none
oneof user.pagerduty	PagerdutyUser	none
via	Via	none

EmailUser

(synq.issues.actor.v1.EmailUser)

Field	Type	Description
user_email	string	none

PagerdutyUser

(synq.issues.actor.v1.PagerdutyUser)

Field	Type	Description
user_id	string	none

SlackUser

(synq.issues.actor.v1.SlackUser)

Field	Type	Description
user_id	string	none

BatchGetIssuesRequest

(synq.issues.issues.v1.BatchGetIssuesRequest)

Field	Type	Description
issue_ids	repeated string	IDs of the issues to get.

BatchGetIssuesResponse

(synq.issues.issues.v1.BatchGetIssuesResponse)

Field	Type	Description
issues	map IssuesEntry	Issues.

BatchGetIssuesResponse.IssuesEntry

(synq.issues.issues.v1.BatchGetIssuesResponse.IssuesEntry)

Field	Type	Description
key	string	none
value	Issue	none

Limit

(synq.issues.issues.v1.Limit)

Field	Type	Description
max	int32	none
after_id	string	none

ListIssuesRequest

(synq.issues.issues.v1.ListIssuesRequest)

Field	Type	Description
from	Timestamp	Filter by time range.
to	Timestamp	Filter by time range.
limit	Limit	none
entities	repeated Identifier	Filter by entities.

ListIssuesResponse

(synq.issues.issues.v1.ListIssuesResponse)

Field	Type	Description
issues	repeated Issue	Issues.

MarkExpectedRequest

(synq.issues.issues.v1.MarkExpectedRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as expected.
actor	Actor	Actor marking the issue as expected.
time	Timestamp	Time at which the issue was marked as expected. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

MarkExpectedResponse

(synq.issues.issues.v1.MarkExpectedResponse)

MarkFixedRequest

(synq.issues.issues.v1.MarkFixedRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as fixed.
actor	Actor	Actor marking the issue as fixed.
time	Timestamp	Time at which the issue was marked as fixed. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

MarkFixedResponse

(synq.issues.issues.v1.MarkFixedResponse)

MarkInvestigatingRequest

(synq.issues.issues.v1.MarkInvestigatingRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as investigating.
actor	Actor	Actor marking the issue as investigating.
time	Timestamp	Time at which the issue was marked as investigating. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

MarkInvestigatingResponse

(synq.issues.issues.v1.MarkInvestigatingResponse)

MarkNoActionNeededRequest

(synq.issues.issues.v1.MarkNoActionNeededRequest)

Field	Type	Description
issue_id	string	ID of the issue to mark as no action needed.
actor	Actor	Actor marking the issue as no action needed.
time	Timestamp	Time at which the issue was marked as no action needed. Defaults to the current time.
require_no_existing_status	bool	Ignore status change if the issue already has a status.

MarkNoActionNeededResponse

(synq.issues.issues.v1.MarkNoActionNeededResponse)

PostCommentRequest

(synq.issues.issues.v1.PostCommentRequest)

Field	Type	Description
issue_id	string	ID of the issue to post a comment on.
actor	Actor	Actor posting the comment.
comment	string	Comment to post.
time	Timestamp	Time at which the comment was posted. Defaults to the current time.

PostCommentResponse

(synq.issues.issues.v1.PostCommentResponse)

Field	Type	Description
comment_id	string	none

Issue

(synq.issues.issues.v1.Issue)

Field	Type	Description
id	string	ID of the issue.
name	string	Name of the issue.
message	string	Original message of the issue.
current_message	string	Current message on the issue.
last_error_message	string	Last error message on the issue.
severity	Severity	Severity of the issue.
trigger_entity	Identifier	Entity that triggered this issue.
oneof trigger_details.monitor	MonitorTriggerDetails	none
affected_entities	repeated Identifier	Entities affected by this issue.
state	State	State of the issue.
started_at	Timestamp	Started at timestamp.
updated_at	Timestamp	Updated at timestamp.
ended_at	Timestamp	Ended at timestamp.
latest_status	Status	Latest status of the issue.
latest_status_actor	Actor	Actor that last updated the status of the issue.
comments	repeated IssueComment	List of comments posted on the issue.
lifecycle_state	LifecycleState	Lifecycle state of the issue.

IssueComment

(synq.issues.issues.v1.IssueComment)

Field	Type	Description
id	string	none
message	string	none
created_at	Timestamp	none
actor	Actor	none

MonitorTriggerDetails

(synq.issues.issues.v1.MonitorTriggerDetails)

Field	Type	Description
monitor	MonitorIdentifier	none
metric_id	string	none
metric_version	int32	none
oneof _segment_value.segment_value	optional string	none

IssuesCommand

(synq.issues.commands.v1.IssuesCommand) Not to be used directly. Use the IssuesService instead when calling via API.

Field	Type	Description
workspace	string	none
oneof action.mark_investigating	MarkInvestigatingRequest	none
oneof action.mark_fixed	MarkFixedRequest	none
oneof action.mark_expected	MarkExpectedRequest	none
oneof action.mark_no_action_needed	MarkNoActionNeededRequest	none
oneof action.post_comment	PostCommentRequest	none

AlertIdentifier

(synq.alerts.services.v1.AlertIdentifier)

Field	Type	Description
oneof identifier.id	string	ID of the alert configuration to update.
oneof identifier.fqn	string	FQN of the alert configuration to update.

BatchGetRequest

(synq.alerts.services.v1.BatchGetRequest)

Field	Type	Description
identifiers	repeated AlertIdentifier	IDs of the alerts to get.

BatchGetResponse

(synq.alerts.services.v1.BatchGetResponse)

Field	Type	Description
alerts	map AlertsEntry	Alerts mapped by their identifiers.

BatchGetResponse.AlertsEntry

(synq.alerts.services.v1.BatchGetResponse.AlertsEntry)

Field	Type	Description
key	string	none
value	Alert	none

CreateRequest

(synq.alerts.services.v1.CreateRequest) CreateRequest creates a new alert configuration.

Field	Type	Description
name	string	Human-readable name for the alert configuration.
fqn	string	User-provided fully qualified name for the alert config. This is a unique identifier that users can specify to reference the alert.
trigger	EntityGroupQuery	Query that defines which entities can trigger this alert.
targets	repeated AlertingTarget	Targets where alerts will be sent.
settings	AlertSettings	Additional settings for the specific alert type.
oneof _owner.owner	optional Owner	Optional owner information for the alert configuration.

CreateResponse

(synq.alerts.services.v1.CreateResponse) CreateResponse returns the created alert configuration.

Field	Type	Description
alert	Alert	The alert configuration that was created.

DeleteRequest

(synq.alerts.services.v1.DeleteRequest) DeleteRequest specifies which alert configuration to delete. The config can be identified by either ID or FQN.

Field	Type	Description
identifier	AlertIdentifier	Identifier for the config to delete.

DeleteResponse

(synq.alerts.services.v1.DeleteResponse) DeleteResponse confirms the deletion (empty response). Empty response - successful deletion is indicated by HTTP 200 status.

ListRequest

(synq.alerts.services.v1.ListRequest) ListRequest filters alert configurations to retrieve.

Field	Type	Description
oneof _owner.owner	optional Owner	Optional filter by owner of the alert configurations.

ListResponse

(synq.alerts.services.v1.ListResponse) ListResponse returns the filtered list of alert configurations.

Field	Type	Description
alerts_ids	repeated string	The list of alert configurations matching the filter criteria.

ToggleEnabledRequest

(synq.alerts.services.v1.ToggleEnabledRequest) ToggleEnabledRequest enables or disables an alert configuration. The config can be identified by either ID or FQN.

Field	Type	Description
identifier	AlertIdentifier	Identifier for the config to toggle.
is_enabled	bool	Whether the alert configuration should be enabled. true = enable the alert, false = disable the alert.

ToggleEnabledResponse

(synq.alerts.services.v1.ToggleEnabledResponse) ToggleEnabledResponse confirms the toggle operation (empty response). Empty response - successful toggle is indicated by HTTP 200 status.

UpdateRequest

(synq.alerts.services.v1.UpdateRequest) UpdateRequest updates an existing alert configuration. The config can be identified by either ID or FQN.

Field	Type	Description
identifier	AlertIdentifier	Identifier for the config to update.
oneof _name.name	optional string	Human-readable name for the alert configuration.
oneof _trigger.trigger	optional EntityGroupQuery	Query that defines which entities can trigger this alert.
targets	repeated AlertingTarget	Targets where alerts will be sent. Leave empty to keep existing targets.
oneof _settings.settings	optional AlertSettings	Additional settings for the specific alert type.

UpdateResponse

(synq.alerts.services.v1.UpdateResponse) UpdateResponse returns the updated alert configuration.

Field	Type	Description
alert	Alert	The alert configuration that was updated.

AlertingTarget

(synq.alerts.v1.AlertingTarget) AlertingTarget represents a destination where alert notifications will be sent. Each target type has its own specific configuration requirements.

Field	Type	Description
oneof target.slack	SlackTarget	Send alert to a Slack channel or user.
oneof target.email	EmailTarget	Send alert via email.
oneof target.owner	OwnerTarget	Send alert to the owner of the monitored entity.
oneof target.ms_teams	MsTeamsTarget	Send alert to Microsoft Teams channel or member.
oneof target.webhook	WebhookTarget	Send alert via webhook integration.

EmailTarget

(synq.alerts.v1.EmailTarget) EmailTarget configures alert delivery via email.

Field	Type	Description
recipient_emails	repeated string	List of email addresses that will receive the alert notifications. Each email must be a valid email address format.

MsTeamsTarget

(synq.alerts.v1.MsTeamsTarget) MsTeamsTarget configures alert delivery to Microsoft Teams. Alerts are sent to a Microsoft Teams channel.

Field	Type	Description
channel	string	Teams channel name or ID.

OwnerTarget

(synq.alerts.v1.OwnerTarget) OwnerTarget configures alert delivery to the owner of the monitored entity. This allows alerts to be automatically sent to whoever owns the data being monitored.

Field	Type	Description
owner_path	string	Path that identifies the ownership context for this target. This determines how the system will resolve the actual owner.

SlackTarget

(synq.alerts.v1.SlackTarget) SlackTarget configures alert delivery to Slack. Alerts are sent to a Slack channel.

Field	Type	Description
channel	string	Slack channel name or ID (e.g., “#alerts” or “C1234567890”).

WebhookTarget

(synq.alerts.v1.WebhookTarget) WebhookTarget configures alert delivery via webhook/hook integrations. This allows integration with external systems and custom notification workflows.

Field	Type	Description
webhook_id	string	Unique identifier of the webhook to send alerts to. This references a pre-configured webhook in the system.

Alert

(synq.alerts.v1.Alert) Alert represents the configuration for an alert. It contains all the necessary information to trigger and send alerts.

Field	Type	Description
id	string	Unique identifier for the alert config (system-generated).
name	string	Human-readable name for the alert configuration.
oneof _fqn.fqn	optional string	User-provided fully qualified name for the alert config. This is a unique identifier that users can specify to reference the alert.
trigger	EntityGroupQuery	Query that defines which entities can trigger this alert.
targets	repeated AlertingTarget	List of targets where alerts will be sent.
settings	AlertSettings	Additional settings for the specific alert type.
oneof _owner.owner	optional Owner	none
created_at	Timestamp	Timestamp when the alert config was created.
is_disabled	bool	Whether the alert config is currently disabled.

Alert.Owner

(synq.alerts.v1.Alert.Owner) Owner information for the alert configuration. If set, the alert is attributed to the specified owner and ownership.

Field	Type	Description
owner_path	string	Path identifying the owner of this alert config.
ownership_id	string	Ownership identifier.

AlertSettings

(synq.alerts.v1.AlertSettings) AlertSettings defines the properties that affect the trigger and presentation of an alert. It specifies the conditions under which an alert should be fired and how it should behave.

Field	Type	Description
oneof settings.schema_change	SchemaChangeAlertSettings	Alert triggered by schema changes.
oneof settings.issue	IssueAlertSettings	Unified issue alert settings (replaces entity_failure and issue_lifecycle).

EntityGroupQuery

(synq.alerts.v1.EntityGroupQuery) EntityGroupQuery defines a query to select a group of entities. This is used to specify which entities should be monitored by an alert.

Field	Type	Description
parts	repeated SelectionQuery	The parts that compose this entity group query.

IssueAlertSettings

(synq.alerts.v1.IssueAlertSettings) IssueAlertSettings is the unified alert settings type for issue-based alerts. It replaces both EntityFailureAlertSettings and IssueLifecycleAlertSettings.

Field	Type	Description
severities	repeated Severity	The severity levels that should trigger this alert.
notify_upstream	bool	Whether to notify upstream dependencies when this alert triggers.
allow_sql_test_audit_link	bool	Whether to allow SQL test audit links in alert notifications.
ongoing	OngoingAlertsStrategy	Strategy for handling ongoing/repeated alerts.
grouping	IssueGroupingStrategy	Strategy for grouping issues in alert notifications.

IssueGroupingStrategy

(synq.alerts.v1.IssueGroupingStrategy) IssueGroupingStrategy controls how issues are grouped for alerting purposes.

Field	Type	Description
oneof strategy.no_grouping	NoGrouping	none
oneof strategy.system_detected	SystemDetected	none

IssueGroupingStrategy.NoGrouping

(synq.alerts.v1.IssueGroupingStrategy.NoGrouping) NoGrouping - each issue triggers a separate alert.

IssueGroupingStrategy.SystemDetected

(synq.alerts.v1.IssueGroupingStrategy.SystemDetected) SystemDetected - the system automatically groups related issues.

OngoingAlertsStrategy

(synq.alerts.v1.OngoingAlertsStrategy) OngoingAlertsStrategy defines how to handle ongoing/repeated alerts. This prevents alert spam by controlling notification frequency.

Field	Type	Description
oneof strategy.disabled	Disabled	none
oneof strategy.stream	Stream	none
oneof strategy.schedule	Schedule	none

OngoingAlertsStrategy.Disabled

(synq.alerts.v1.OngoingAlertsStrategy.Disabled) Disabled strategy - no ongoing alerts will be sent after the initial alert. No configuration needed - alerts are simply disabled after the first one.

OngoingAlertsStrategy.Schedule

(synq.alerts.v1.OngoingAlertsStrategy.Schedule) Schedule strategy - alerts are sent on a scheduled basis.

Field	Type	Description
cron	string	Cron expression defining when ongoing alerts should be sent. Must be a valid cron expression (e.g., “0 9 * * MON” for every Monday at 9 AM).

OngoingAlertsStrategy.Stream

(synq.alerts.v1.OngoingAlertsStrategy.Stream) Stream strategy - alerts are sent continuously as issues persist. No configuration needed - alerts stream continuously.

SchemaChangeAlertSettings

(synq.alerts.v1.SchemaChangeAlertSettings) SchemaChangeAlertSettings configures alerts for schema changes. This alert triggers when the schema of monitored entities changes.

Field	Type	Description
notify_upstream	bool	Whether to notify upstream dependencies when schema changes occur.

SelectionQuery

(synq.alerts.v1.SelectionQuery) SelectionQuery represents a query that selects entities based on various criteria. It combines multiple query parts with a logical operand.

Field	Type	Description
parts	repeated QueryPart	The individual query parts that make up this selection.
operand	QueryOperand	The logical operand used to combine the query parts (AND, OR, etc.).

SelectionQuery.QueryPart

(synq.alerts.v1.SelectionQuery.QueryPart) A single part of a selection query.

Field	Type	Description
oneof part.identifier_list	IdentifierList	Filter by specific entity identifiers.
oneof part.with_name_search	WithNameSearch	Filter by name pattern search.
oneof part.with_type	WithType	Filter by entity type.
oneof part.with_annotation	WithAnnotation	Filter by annotation presence/value.
oneof part.in_data_platform	InDataPlatform	Filter by data platform.
oneof part.in_folder	InFolder	Filter by folder location.
oneof part.with_data_platform_type	WithDataPlatformType	Filter by data platform type.
oneof part.in_dataproduct	InDataproduct	Filter by data product membership.
oneof part.query	SelectionQuery	Nested selection query for complex filtering.
oneof part.unsupported	Unsupported	Unsupported query types for backward compatibility.

AgentTask

(synq.agent.dwh.v1.AgentTask)

Field	Type	Description
connection_id	string	none
task_id	string	none
scheduled_at	Timestamp	When this task should execute, if none is specified it will use time of execution
oneof _deadline_at.deadline_at	optional Timestamp	After what time this task should stop executing (even in case of errors, retries will be ignored after this time)
created_at	Timestamp	When the task was created
oneof command.fetch_full_catalog	FetchFullCatalogCommand	none
oneof command.fetch_full_metrics	FetchFullMetricsCommand	none
oneof command.fetch_segments	FetchSegmentsCommand	none
oneof command.fetch_metrics	FetchMetricsCommand	none
oneof command.fetch_table_stats	FetchTableStatsCommand	none

AgentTaskData

(synq.agent.dwh.v1.AgentTaskData)

Field	Type	Description
oneof data.fetch_segments_result	FetchSegmentsResult	none
oneof data.fetch_metrics_result	FetchMetricsResult	none

FetchFullCatalogCommand

(synq.agent.dwh.v1.FetchFullCatalogCommand)

FetchFullMetricsCommand

(synq.agent.dwh.v1.FetchFullMetricsCommand)

FetchMetricsCommand

(synq.agent.dwh.v1.FetchMetricsCommand)

Field	Type	Description
sql_queries	repeated SqlQuery	none
oneof _command_context.command_context	optional string	Application specific context around metrics retrieval

FetchMetricsResult

(synq.agent.dwh.v1.FetchMetricsResult)

Field	Type	Description
query_rows	repeated QueryRows	none
oneof _command_context.command_context	optional string	Matches command_context of FetchMetricsCommand / FetchTableStatsCommand

FetchMetricsResult.ColumnValue

(synq.agent.dwh.v1.FetchMetricsResult.ColumnValue)

Field	Type	Description
name	string	none
is_null	bool	none
oneof value.double_value	double	none
oneof value.int_value	int64	Integer value for values that fit within the signed 64-bit range [-9223372036854775808, 9223372036854775807].
oneof value.time_value	Timestamp	none
oneof value.big_int_value	string	Arbitrary-precision integer encoded as a base-10 string, used for values that exceed the signed 64-bit range. Covers DuckDB HUGEINT (128-bit), ClickHouse Int128/UInt128/Int256/UInt256, and similar wide integer types from other warehouses. Consumers should parse this with an arbitrary-precision library (e.g., Go’s math/big.Int, Java’s BigInteger, Python’s int).

FetchMetricsResult.MetricsRow

(synq.agent.dwh.v1.FetchMetricsResult.MetricsRow)

Field	Type	Description
oneof _segment.segment	optional string	none
column_values	repeated ColumnValue	none

FetchMetricsResult.QueryRows

(synq.agent.dwh.v1.FetchMetricsResult.QueryRows)

Field	Type	Description
rows	repeated MetricsRow	none
oneof _query_id.query_id	optional string	none

FetchSegmentsCommand

(synq.agent.dwh.v1.FetchSegmentsCommand)

Field	Type	Description
sql_query	SqlQuery	none

FetchSegmentsResult

(synq.agent.dwh.v1.FetchSegmentsResult)

Field	Type	Description
rows	repeated SegmentRow	none

FetchSegmentsResult.SegmentRow

(synq.agent.dwh.v1.FetchSegmentsResult.SegmentRow)

Field	Type	Description
segment	string	none
oneof _count.count	optional int64	none

FetchTableStatsCommand

(synq.agent.dwh.v1.FetchTableStatsCommand)

Field	Type	Description
scope_filter	ScopeFilter	Scope filter defining which tables to collect stats for. For a single-table monitor, set a single include rule with exact database/schema/table.
oneof _command_context.command_context	optional string	Application-specific context, echoed back in the result (mirrors FetchMetricsCommand).

SqlQuery

(synq.agent.dwh.v1.SqlQuery)

Field	Type	Description
sql	string	none
oneof _limit_results.limit_results	optional int64	none
oneof _query_id.query_id	optional string	none

Config

(synq.agent.dwh.v1.Config) Config represents the main configuration for the DWH agent

Field	Type	Description
agent	Agent	Agent configuration
synq	SYNQ	Coalesce Quality platform configuration
connections	map ConnectionsEntry	Map of connection configurations

Config.Agent

(synq.agent.dwh.v1.Config.Agent) Agent contains metadata about this agent instance

Field	Type	Description
name	string	Name of the agent instance
tags	repeated string	Tags to categorize and organize the agent
log_level	LogLevel	none
oneof _log_json.log_json	optional bool	none
oneof _log_report_caller.log_report_caller	optional bool	none

Config.ConnectionsEntry

(synq.agent.dwh.v1.Config.ConnectionsEntry)

Field	Type	Description
key	string	none
value	Connection	none

GenerateConnectionsYamlRequest

(synq.agent.dwh.v1.GenerateConnectionsYamlRequest) Request to generate YAML configuration from data warehouse connections.

Field	Type	Description
connections	map ConnectionsEntry	Map of connection ID to Connection configuration. Typically obtained from ListConnectionsResponse. Note: Validation is disabled for this field since Connection values may have empty credentials (which will be replaced with env var placeholders). Connection ID validation is handled in the service implementation.

GenerateConnectionsYamlRequest.ConnectionsEntry

(synq.agent.dwh.v1.GenerateConnectionsYamlRequest.ConnectionsEntry)

Field	Type	Description
key	string	none
value	Connection	none

GenerateConnectionsYamlResponse

(synq.agent.dwh.v1.GenerateConnectionsYamlResponse) Response containing the generated YAML configuration.

Field	Type	Description
yaml	string	Generated YAML configuration string. Can be written directly to a file and used by DWH Agent or Coalesce Quality Scout. Includes header comments with documentation links.
oneof _error.error	optional string	Error message if YAML generation failed. If set, the yaml field should be ignored.

ListConnectionsRequest

(synq.agent.dwh.v1.ListConnectionsRequest)

Field	Type	Description
connection_ids	repeated string	Optional filter to only return connections with these ids. If empty, all DWH connections are returned.

ListConnectionsResponse

(synq.agent.dwh.v1.ListConnectionsResponse)

Field	Type	Description
connections	map ConnectionsEntry	none

ListConnectionsResponse.ConnectionsEntry

(synq.agent.dwh.v1.ListConnectionsResponse.ConnectionsEntry)

Field	Type	Description
key	string	none
value	Connection	none

AgentTaskResponse

(synq.agent.dwh.v1.AgentTaskResponse)

Field	Type	Description
connection_id	string	none
task_id	string	none
oneof _error.error	optional string	none
oneof _task_data.task_data	optional AgentTaskData	none

ConnectRequest

(synq.agent.dwh.v1.ConnectRequest)

Field	Type	Description
oneof message.hello	Hello	none
oneof message.log	Log	none
oneof message.task_response	AgentTaskResponse	none

ConnectResponse

(synq.agent.dwh.v1.ConnectResponse)

Field	Type	Description
tasks	repeated AgentTask	none

Hello

(synq.agent.dwh.v1.Hello)

Field	Type	Description
name	string	none
build_version	string	none
build_time	string	none
available_connections	repeated AvailableConnection	none

Hello.AvailableConnection

(synq.agent.dwh.v1.Hello.AvailableConnection)

Field	Type	Description
connection_id	string	Identifier which will receive commands
name	string	User provided connection name
disabled	bool	Indicates that agent has that connection disabled
type	string	Type of the DWH, e.g. bigquery, duckdb, clickhouse
instance	string	This will be hostname in most cases
databases	repeated string	Enabled databases to query if connection supports multiple databases, can be empty.

Log

(synq.agent.dwh.v1.Log)

Field	Type	Description
time	Timestamp	none
message	string	none
level	LogLevel	none

Connection

(synq.agent.dwh.v1.Connection) Connection represents a database connection configuration

Field	Type	Description
name	string	Name of the connection
disabled	bool	none
parallelism	int32	How many queries to DWH can be executed in parallel, defaults to 2
oneof config.bigquery	BigQueryConf	none
oneof config.clickhouse	ClickhouseConf	none
oneof config.databricks	DatabricksConf	none
oneof config.mysql	MySQLConf	none
oneof config.postgres	PostgresConf	none
oneof config.redshift	RedshiftConf	none
oneof config.snowflake	SnowflakeConf	none
oneof config.trino	TrinoConf	none
oneof config.mssql	MSSQLConf	none
oneof config.oracle	OracleConf	none
oneof config.duckdb	DuckDBConf	none
oneof config.athena	AthenaConf	none
oneof config.fabric	FabricConf	none

AthenaConf

(synq.agent.dwh.v1.AthenaConf) Amazon Athena specific configuration. Athena is serverless: there is no host/port — the endpoint is implied by the AWS region. Queries run inside a workgroup that owns the per-query data-scan cap and the S3 query result location. The configured workgroup MUST have ResultConfiguration.OutputLocation set, otherwise every Athena query fails. Setting EnforceWorkGroupConfiguration=true on the workgroup is strongly recommended so per-query overrides cannot escape the cap. Authentication AthenaConf carries an AWS credential source in one of three ways:

Static IAM access key — set access_key_id and secret_access_key (and optionally session_token if those keys are short-lived STS credentials).
Shared-config profile — set aws_profile to a named profile from ~/.aws/credentials or ~/.aws/config. Useful when the agent host already has AWS CLI configured.
AWS default credential chain — leave all of the above empty. The AWS SDK then uses environment variables (AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY / AWS_PROFILE), shared config, or the EC2 / ECS / EKS instance role attached to the agent host.

If more than one source is provided, they resolve in the order above — explicit static keys win over a profile, profile wins over the chain. role_arn is independent of the source choice. When set, the executor uses one of the three sources as the calling identity and assumes role_arn via STS for every Athena/Glue API call. external_id is included in the AssumeRole request when set; required by trust policies that mandate it. Validation: access_key_id and secret_access_key must be set as a pair (one without the other is rejected); session_token may only be set when both keys are also set.

Field	Type	Description
region	string	AWS region hosting the Athena service and Glue Data Catalog.
workgroup	string	Athena workgroup. Defaults to “primary” when empty. Must have a ResultConfiguration.OutputLocation configured.
catalog	string	Glue Data Catalog name. Defaults to “AwsDataCatalog” when empty. Override only when using federated catalogs backed by Lambda connectors.
access_key_id	string	AWS access key ID for static IAM credentials. Required together with secret_access_key.
secret_access_key	string	AWS secret access key. Required together with access_key_id.
session_token	string	STS session token, set only when access_key_id and secret_access_key are short-lived STS credentials. Ignored otherwise.
aws_profile	string	Named profile from the AWS shared credentials / config files (~/.aws/credentials, ~/.aws/config). Useful when the agent host already has AWS CLI configured.
role_arn	string	IAM role to assume via STS for every Athena / Glue API call. The calling identity comes from access_key_id, aws_profile, or the default credential chain — whichever is configured.
external_id	string	ExternalId included in the AssumeRole request. Set when the role’s trust policy requires it.
role_session_name	string	Session name attached to the AssumeRole request. Defaults to “synq-athena-agent”.
scope	ScopeFilter	Scope filter for include/exclude filtering by Glue catalog, Glue database, and table. Mapping (mirrors BigQuery’s project/dataset shape): ScopeRule.database = Glue Data Catalog name (almost always ‘AwsDataCatalog’) ScopeRule.schema = Glue database — what users typically filter on ScopeRule.table = Glue table / view name When include rules constrain schemas, the IAM principal does not need catalog-wide glue:GetDatabases — only glue:GetDatabase on the listed names.
use_show_create_table	bool	Use SHOW CREATE TABLE to retrieve full table DDL (CTAS bodies, Iceberg TBLPROPERTIES, Hive external LOCATION/SerDe). One Athena query per table — billed at the 10MB scan minimum each.
use_show_create_view	bool	Use SHOW CREATE VIEW to retrieve full view DDL instead of the rewritten body from information_schema.views.view_definition.
use_iceberg_metrics_scan	bool	For Iceberg tables, fan out one Athena query per table to read row counts and total file size from the table’s `$files` / `$snapshots` / `$partitions` metadata tables. Without this, Iceberg tables only have metrics when the customer has run ANALYZE TABLE COMPUTE STATISTICS (Glue parameters). Hive external tables are unaffected. Each call is one Athena query (~$0.00005 at the 10MB scan minimum).

BigQueryConf

(synq.agent.dwh.v1.BigQueryConf) BigQuery specific configuration

Field	Type	Description
project_id	string	GCP project ID
service_account_key	string	Service account key JSON
service_account_key_file	string	Location of service account key file
region	string	Region for BigQuery resources
datasets	repeated string	Explicit list of dataset names to scrape (e.g., [‘analytics’, ‘mart_core’]). When set, only these datasets are queried — the service account does not need project-level bigquery.datasets.list permission. When empty, all visible datasets in the project are discovered automatically.

ClickhouseConf

(synq.agent.dwh.v1.ClickhouseConf)

Field	Type	Description
host	string	Host address
port	int32	Port number (default: 9000 for native protocol)
database	string	Database name
username	string	Username for authentication
password	string	Password for authentication
allow_insecure	bool	Whether to use disable SSL for connection

DatabricksConf

(synq.agent.dwh.v1.DatabricksConf)

Field	Type	Description
workspace_url	string	none
oneof _auth_token.auth_token	optional string	none
oneof _auth_client.auth_client	optional string	none
oneof _auth_secret.auth_secret	optional string	none
oneof _warehouse.warehouse	optional string	none
refresh_table_metrics	bool	none
refresh_table_metrics_use_scan	bool	none
fetch_table_tags	bool	none
use_show_create_table	bool	none

DuckDBConf

(synq.agent.dwh.v1.DuckDBConf) DuckDB / MotherDuck specific configuration. Supports two modes:

Local/embedded: set database to a file path (e.g. “/tmp/my.duckdb”) or “:memory:”
MotherDuck (cloud): set motherduck_account and motherduck_token

Field	Type	Description
database	string	Local database path (file path or “:memory:”). Mutually exclusive with motherduck_account.
motherduck_account	string	MotherDuck account name. Requires motherduck_token.
motherduck_token	string	MotherDuck authentication token. Required when motherduck_account is set.

FabricConf

(synq.agent.dwh.v1.FabricConf) Microsoft Fabric Warehouse / Lakehouse SQL analytics endpoint configuration. Fabric speaks T-SQL over TDS (like SQL Server) but is deliberately its own integration with a minimal, opinionated surface: the connection always uses TLS on port 1433 and authenticates with a Microsoft Entra ID service principal (Fabric rejects SQL logins entirely). Callers therefore only supply the endpoint, the warehouse name, and the service-principal credentials — the azuread ActiveDirectoryServicePrincipal workflow and encryption settings are fixed internally so there is nothing to guess. For hosted deployments that mint their own Entra token (managed identity / workload-identity federation), set access_token instead of client_id + client_secret.

Field	Type	Description
host	string	Workspace SQL analytics endpoint host, e.g. “<workspace-id>.datawarehouse.fabric.microsoft.com”.
database	string	Default execution database — the context in which unqualified ad-hoc / monitor SQL resolves. Optional: defaults to “master” (the always-present workspace entry point). Metadata scrapping and generated metrics SQL are fully database-qualified via cross-database queries, so this only affects unqualified queries. It is a different axis from `databases` (which databases to scrape).
scope	ScopeFilter	Include/exclude filter over the workspace’s databases/schemas/tables (ScopeRule.database = Fabric database/warehouse, .schema = schema, .table = table). The canonical scope encoding (as AthenaConf uses); unset means the whole workspace. A per-call scope can only narrow within this, never escape it.
client_id	string	Entra application (client) ID of the service principal (default auth), or the user-assigned identity client ID when auth_type is “managed_identity”.
client_secret	string	Service principal client secret.
tenant_id	string	Entra tenant (directory) ID. Optional: inferred from the endpoint when empty; set it when the server-supplied authority is not the SP’s home tenant.
access_token	string	Pre-acquired Entra OAuth access token for the SQL scope (https://database.windows.net/.default). When set, takes precedence over all other authentication methods — for managed identity / workload-identity hosts.
auth_type	string	Authentication method, matched case-insensitively. Empty defaults to a service principal (client_id + client_secret). The ambient modes below authenticate as the host’s own Azure identity with no stored credential and are intended for on-prem agents (opt-in — never engaged unless named): - “azure_cli”: reuse an interactive `az login` session (local execution) - “default”: DefaultAzureCredential chain (managed identity → env → workload identity → az CLI) - “managed_identity”: Azure managed identity (set client_id for a user-assigned identity) Canonical values are lower-case (the scrapper matches case-insensitively).

MSSQLConf

(synq.agent.dwh.v1.MSSQLConf) Microsoft SQL Server / Azure SQL Database specific configuration. SQL Server is database-scoped — each connection targets a single database. Authentication methods (in priority order):

access_token: pre-acquired Azure AD OAuth token
fed_auth: Azure AD federated authentication (with optional username/password)
username + password: standard SQL Server Authentication

Field	Type	Description
host	string	Host address or IP. For Azure SQL: e.g. “yourserver.database.windows.net”
port	int32	Port number (default: 1433)
database	string	Database name to connect to
username	string	Username for SQL Server Authentication or Azure AD. For Azure AD Service Principal, this is the Application (Client) ID. Leave empty when using access_token or Azure AD Managed Identity.
password	string	Password for SQL Server Authentication or Azure AD client secret
trust_cert	bool	Skip TLS server certificate verification
encrypt	string	Connection encryption mode: “true” (default), “false”, “disable”
fed_auth	string	Azure AD federated authentication method. When set, the azuread driver is used instead of the standard sqlserver driver. Values: “ActiveDirectoryDefault”, “ActiveDirectoryMSI”, “ActiveDirectoryServicePrincipal”, “ActiveDirectoryAzCli”
access_token	string	Pre-acquired Azure AD OAuth access token. When set, takes precedence over all other authentication methods.
application_client_id	string	Azure AD Application (Client) ID. Used with ActiveDirectoryServicePrincipal and user-assigned MSI.

MySQLConf

(synq.agent.dwh.v1.MySQLConf) MySQL specific configuration

Field	Type	Description
host	string	Host address
port	int32	Port number (default: 3306)
database	string	Database name
username	string	Username for authentication
password	string	Password for authentication
allow_insecure	bool	Whether to allow insecure connections
params	map ParamsEntry	Additional connection parameters

MySQLConf.ParamsEntry

(synq.agent.dwh.v1.MySQLConf.ParamsEntry)

Field	Type	Description
key	string	none
value	string	none

OracleConf

(synq.agent.dwh.v1.OracleConf) Oracle Database specific configuration. Oracle connections are scoped to a Pluggable Database (PDB) via the service name. Authentication methods:

wallet_path: Oracle Wallet (mTLS) for OCI Autonomous Database
username + password: standard Oracle database authentication Both can be combined (wallet for TLS + explicit credentials).

Field	Type	Description
host	string	Host address or IP. For OCI: e.g. “adb.eu-frankfurt-1.oraclecloud.com”
port	int32	Listener port (default: 1521, OCI Autonomous DB with mTLS uses 1522)
service_name	string	Service name (PDB name). For OCI Autonomous DB: e.g. “mydb_high”, “mydb_low”, “mydb_tp”
username	string	Username for authentication (optional when wallet stores credentials)
password	string	Password for authentication (optional when wallet stores credentials)
ssl	bool	Enable TLS/SSL encryption (TCPS protocol). Required for OCI Autonomous Database. Auto-enabled when wallet_path is set.
ssl_verify	bool	Enable server certificate verification when SSL is enabled
wallet_path	string	Path to Oracle Wallet directory for mTLS authentication (OCI Autonomous DB). Contains TLS certificates (cwallet.sso) and optionally stored credentials.
use_diagnostics_pack	bool	Use Oracle Diagnostics Pack (AWR) for persistent query log history. When false, query logs come from V$SQL (in-memory, no additional license). When true, query logs come from DBA_HIST views (requires Diagnostics Pack license).

PostgresConf

(synq.agent.dwh.v1.PostgresConf) Postgres specific configuration

Field	Type	Description
host	string	Host address
port	int32	Port number (default: 5432)
database	string	Database name
username	string	Username for authentication
password	string	Password for authentication
allow_insecure	bool	Whether to allow insecure connections

RedshiftConf

(synq.agent.dwh.v1.RedshiftConf) Redshift specific configuration

Field	Type	Description
host	string	Host address
port	int32	Port number (default: 5439)
database	string	Database name
username	string	Username for authentication
password	string	Password for authentication
freshness_from_query_logs	bool	Estimate table freshness based on query logs

SnowflakeConf

(synq.agent.dwh.v1.SnowflakeConf) Snowflake specific configuration

Field	Type	Description
account	string	Snowflake account identifier
warehouse	string	Virtual warehouse to use
role	string	Role to assume
username	string	Username for authentication
password	string	Password for authentication
private_key	string	Content of Private key used for Snowflake authentication
private_key_file	string	Location of the file containing Private key used for Snowflake authentication
oneof _private_key_passphrase.private_key_passphrase	optional string	Passphrase used to decode Private key
databases	repeated string	Database to connect to
use_get_ddl	bool	Use GET_DDL to determine queries used for table/view creation
oneof _account_usage_db.account_usage_db	optional string	Name of the database where ACCOUNT_USAGE schema is present, fallbacks to SNOWFLAKE
oneof _auth_type.auth_type	optional string	Authentication type: empty (default, uses password or private_key), “externalbrowser” (SSO via browser) When set to “externalbrowser”, opens browser for SSO login and caches the token locally.

TrinoConf

(synq.agent.dwh.v1.TrinoConf) Trino specific configuration

Field	Type	Description
host	string	Host address
oneof _port.port	optional int32	Optional port to use, otherwise it will use the default port 8080
oneof _use_plaintext.use_plaintext	optional bool	Use non-SSL connection to Trino. This should only be enabled if the Trino cluster does not support SSL or if the connection is secured through other means (e.g., a VPN). Defaults to false (SSL enabled).
username	string	Username for authentication
password	string	Password for authentication
catalogs	repeated string	To which catalogs to connect
no_show_create_view	bool	Use SHOW CREATE VIEW to get views DDLs
no_show_create_table	bool	Use SHOW CREATE TABLE to get tables DDLs
no_materialized_views	bool	Should it fetch system.metadata.materialized_views to get information about Trino MVs
fetch_table_comments	bool	Fetch Trino table comments from system.metadata.table_comments

ColumnMapping

(synq.agent.recon.v1.ColumnMapping) ColumnMapping maps a source column name to a target column name. Used when source and target use different naming conventions for the same data (e.g., snake_case vs SCREAMING_SNAKE_CASE, or completely different names). Only columns with different names need explicit mapping — columns with identical names (or case-insensitive matches when case_insensitive is true) are matched automatically.

Field	Type	Description
source	string	Column name in the source dataset.
target	string	Corresponding column name in the target dataset.

Dataset

(synq.agent.recon.v1.Dataset) Dataset defines a source or target dataset for reconciliation. A dataset specifies which connection to use and how to select data — either via a raw SQL query or by referencing a table with optional column filtering.

Field	Type	Description
connection	string	Name of the connection to use. Must reference a connection configured in the runner’s connection map.
oneof data_source.query	string	Raw SQL query returning the dataset. Should be a SELECT or WITH (CTE) statement. Supports template variable interpolation via {{variable_name}} syntax.
oneof data_source.table	TableReference	Table reference with optional column selection. Automatically generates a SELECT query from the table metadata.
oneof _as_of.as_of	optional string	Time-travel timestamp for snapshot queries (e.g., “2026-02-01 00:00:00”). When set, wraps the query with database-specific time-travel syntax: - Snowflake: AT(TIMESTAMP => ‘<as_of>’) - BigQuery: FOR SYSTEM_TIME AS OF TIMESTAMP ‘<as_of>’ - Databricks: TIMESTAMP AS OF ‘<as_of>’ Has no effect on databases that don’t support time-travel.

TableReference

(synq.agent.recon.v1.TableReference) TableReference specifies a table and optional column filtering. Use this instead of a raw query when you want to compare all (or most) columns of a table without writing SQL. name is the table or view name (e.g., “orders”, “fact_sales”). database and schema are optional namespace qualifiers. The actual SQL FQN is generated at runtime using the appropriate dialect quoting.

Field	Type	Description
name	string	Table or view name (e.g., “orders”, “fact_sales”). Required — this is the actual object name.
columns	repeated string	Explicit list of columns to include in the comparison. When set, only these columns are selected from the table. Mutually exclusive with exclude_columns.
exclude_columns	repeated string	Columns to exclude from the comparison. All columns except these are selected (resolved at runtime via table metadata). Useful for skipping volatile columns (e.g., updated_at, etl_batch_id). Mutually exclusive with columns.
oneof _database.database	optional string	Database/catalog name (e.g., “PROD_RAW”, “my_project”). Maps to: Snowflake database, BigQuery project, Databricks catalog.
oneof _schema.schema	optional string	Schema/dataset name (e.g., “public”, “analytics”). Maps to: Snowflake schema, BigQuery dataset, Databricks schema.
oneof _where.where	optional string	Row filter — appended as WHERE clause to the generated SELECT. Example: “created_at ≥ ‘2024-01-01’ AND status = ‘active‘“

CronSchedule

(synq.agent.recon.v1.CronSchedule)

Field	Type	Description
expression	string	Standard cron expression (e.g. “0 /6 * *”).

ICalSchedule

(synq.agent.recon.v1.ICalSchedule)

Field	Type	Description
recurrence_rule	string	RFC 5545 RRULE recurrence rule (e.g. “FREQ=MONTHLY;BYDAY=TH;BYSETPOS=-1”). DTSTART should be set via the dtstart field below rather than inline in the rule.
oneof _dtstart.dtstart	optional Timestamp	Anchor time for the recurrence rule. Wall-clock time interpreted in the schedule’s timezone. Defines when the schedule starts and aligns occurrences. If not set and no DTSTART is present in the recurrence_rule, defaults to now().

ReconciliationConfigSummary

(synq.agent.recon.v1.ReconciliationConfigSummary) Summary of a single reconciliation within a suite config (for listing without parsing full config).

Field	Type	Description
name	string	none
oneof _title.title	optional string	none
oneof _description.description	optional string	none
source_connection	string	none
target_connection	string	none
mode	ReconcilationMode	none
annotations	repeated Annotation	Resolved annotation list for this case. For suite-config summaries this is suite-level annotations + case-level annotations (deduped). For deployment summaries the deployment-level overlay is also merged in. Already deduplicated by (name, value); ready for direct display.

SuiteSchedule

(synq.agent.recon.v1.SuiteSchedule) Schedule configuration for managed suites.

Field	Type	Description
timezone	string	IANA timezone, e.g. “Europe/Warsaw”. Required when a schedule is set.
oneof type.cron	CronSchedule	none
oneof type.ical	ICalSchedule	none

AuditLogEntry

(synq.agent.recon.v1.AuditLogEntry) AuditLogEntry is a summary of an audit log for listing purposes. Use GetAuditLog to retrieve the full audit log data.

Field	Type	Description
invocation_id	string	none
oneof _parent_invocation_id.parent_invocation_id	optional string	none
suite_name	string	none
oneof _suite_title.suite_title	optional string	none
started_at	Timestamp	none
completed_at	Timestamp	none
duration	Duration	none
status	AuditStatus	none
summary	AuditSummary	none
reconciliations	repeated ReconciliationSummary	none
oneof _suite_id.suite_id	optional string	Stable suite identifier assigned by the platform — same value as the suite_id on RunStateService.ReconciliationRunState, suitable for joining a run row to its audit log. Empty for legacy logs ingested before run-state correlation was added.
oneof _deployment_id.deployment_id	optional string	Deployment identifier this run belongs to (UUIDv7). Empty for adhoc submissions and for legacy logs ingested before run-state correlation.
oneof _run_id.run_id	optional string	Stable run identifier (UUIDv7) assigned at scheduling time. Empty for legacy logs / direct agent submissions made outside the platform job queue.

GetAuditLogRequest

(synq.agent.recon.v1.GetAuditLogRequest)

Field	Type	Description
invocation_id	string	Invocation ID of the audit log to retrieve.

GetAuditLogResponse

(synq.agent.recon.v1.GetAuditLogResponse)

Field	Type	Description
audit_log	AuditLog	none

IngestAuditLogRequest

(synq.agent.recon.v1.IngestAuditLogRequest)

Field	Type	Description
audit_log	AuditLog	The audit log to store.

IngestAuditLogResponse

(synq.agent.recon.v1.IngestAuditLogResponse)

ListAuditLogsRequest

(synq.agent.recon.v1.ListAuditLogsRequest)

Field	Type	Description
oneof _suite_name.suite_name	optional string	Filter by suite name. When empty, returns all suites.
oneof _started_after.started_after	optional Timestamp	Only return audit logs started after this timestamp (inclusive).
oneof _started_before.started_before	optional Timestamp	Only return audit logs started before this timestamp (exclusive).
oneof _pagination.pagination	optional Pagination	Pagination parameters.
statuses	repeated AuditStatus	Filter by audit status. When empty, returns all statuses.

ListAuditLogsResponse

(synq.agent.recon.v1.ListAuditLogsResponse)

Field	Type	Description
audit_logs	repeated AuditLogEntry	none
page_info	PageInfo	Pagination info for fetching the next page.

ReconciliationSummary

(synq.agent.recon.v1.ReconciliationSummary) ReconciliationSummary is a compact summary of a single reconciliation within an audit log entry.

Field	Type	Description
name	string	none
oneof _title.title	optional string	none
oneof _description.description	optional string	none
source_connection	string	Source connection name.
target_connection	string	Target connection name.
status	ReconciliationStatus	none
overall_match	bool	none
error	string	Error message if the reconciliation failed.

ConnectionEnvironmentOverride

(synq.agent.recon.v1.ConnectionEnvironmentOverride) ConnectionEnvironmentOverride applies to all datasets using a given connection. Provides a default table path override for all datasets on that connection.

Field	Type	Description
table_path	TablePathOverride	Default table path override for all datasets on this connection. Can be further overridden by dataset-level overrides.

DatasetEnvironmentOverride

(synq.agent.recon.v1.DatasetEnvironmentOverride) DatasetEnvironmentOverride applies to a specific dataset in a specific reconciliation. Takes precedence over connection-level overrides.

Field	Type	Description
table_path	TablePathOverride	Table path override for this specific dataset.

ReconEnvironment

(synq.agent.recon.v1.ReconEnvironment) ReconEnvironment defines overrides applied to a suite before execution. Environments allow the same suite definition to run against different database locations (e.g., dev vs production schemas) without modifying the suite itself. Used both in synq-recon CLI (loaded from .env.yaml files) and in kernel-recon cloud (managed as workspace-level configurations).

Field	Type	Description
name	string	Environment name (e.g., “dev-lukasz”, “staging”, “production”).
oneof _description.description	optional string	Human-readable description of this environment.
connections	map ConnectionsEntry	Connection-level overrides, keyed by connection name. Applied to all datasets using the specified connection.
datasets	map DatasetsEntry	Dataset-level overrides, keyed by “reconciliation_name.source” or “reconciliation_name.target”. Takes precedence over connection-level overrides for the matching dataset.
variables	map VariablesEntry	Variable overrides merged on top of suite-level variables. Takes precedence over suite variables but is overridden by CLI —var flags.

ReconEnvironment.ConnectionsEntry

(synq.agent.recon.v1.ReconEnvironment.ConnectionsEntry)

Field	Type	Description
key	string	none
value	ConnectionEnvironmentOverride	none

ReconEnvironment.DatasetsEntry

(synq.agent.recon.v1.ReconEnvironment.DatasetsEntry)

Field	Type	Description
key	string	none
value	DatasetEnvironmentOverride	none

ReconEnvironment.VariablesEntry

(synq.agent.recon.v1.ReconEnvironment.VariablesEntry)

Field	Type	Description
key	string	none
value	string	none

TablePathOverride

(synq.agent.recon.v1.TablePathOverride) TablePathOverride remaps components of a fully-qualified table name. Only set fields are overridden — unset fields keep the suite’s original value. Applied to TableReference fields in datasets when an environment is active.

Field	Type	Description
oneof _database.database	optional string	Replace the database/catalog component. e.g., “PROD_DB” → “DEV_LUKASZ_DB”
oneof _schema.schema	optional string	Replace the schema/dataset component. e.g., “analytics” → “dev_lukasz_analytics”
oneof _table_prefix.table_prefix	optional string	Prefix to prepend to the table name. e.g., “dev_” → “dev_orders” instead of “orders”
oneof _table_suffix.table_suffix	optional string	Suffix to append to the table name. e.g., “_staging” → “orders_staging” instead of “orders”

ConnectionMapping

(synq.agent.recon.v1.ConnectionMapping) Maps a reconciliation-connection name (as referenced in the suite config) to a concrete SYNQ integration. Used at execution time to resolve DWH credentials. Two credential planes are defined on the wire:

integration_id: workspace-level integration. Required for deployment paths and acceptable for adhoc submission when the caller has SCOPE_INTEGRATION_EDIT.
user_integration_id: per-user OAuth-backed integration. Accepted only on adhoc submission, and only when a user identity is present in the calling context. Deployment paths reject this branch unconditionally — scheduled runs must be able to fire without any particular user being available, so they always run with workspace credentials.

Wire-compatible with the previous shape: the original integration_id (field 2) is preserved as one branch of the oneof so existing serialized rows decode unchanged.

Field	Type	Description
connection_name	string	Connection name as it appears in the suite config (e.g. ReconcilationSuite.reconciliations[].source.connection).
oneof source.integration_id	string	Workspace-level integration (credentials owned by the workspace).
oneof source.user_integration_id	string	Per-user integration ID (user-level credentials). Server requires a user identity in the calling context to accept this branch.

ConnectionResolutionFailure

(synq.agent.recon.v1.ConnectionResolutionFailure) Error-details payload attached to FAILED_PRECONDITION when a recon request cannot be honoured because one or more suite connection names have no usable mapping. The caller should prompt the user to bind every listed connection and retry.

Field	Type	Description
unresolved	repeated UnresolvedConnection	none

GetSuiteDeploymentRequest

(synq.agent.recon.v1.GetSuiteDeploymentRequest)

Field	Type	Description
oneof lookup.suite_id	string	none
oneof lookup.deployment_id	string	none

GetSuiteDeploymentResponse

(synq.agent.recon.v1.GetSuiteDeploymentResponse)

Field	Type	Description
deployment	SuiteDeployment	none

ListSuiteDeploymentHistoryRequest

(synq.agent.recon.v1.ListSuiteDeploymentHistoryRequest)

Field	Type	Description
oneof lookup.suite_id	string	none
oneof lookup.deployment_id	string	none
oneof _pagination.pagination	optional Pagination	none

ListSuiteDeploymentHistoryResponse

(synq.agent.recon.v1.ListSuiteDeploymentHistoryResponse)

Field	Type	Description
entries	repeated SuiteDeploymentHistoryEntry	none
page_info	PageInfo	none

ListSuiteDeploymentsRequest

(synq.agent.recon.v1.ListSuiteDeploymentsRequest)

Field	Type	Description
oneof _pagination.pagination	optional Pagination	none
oneof _integration_id.integration_id	optional string	Return only deployments wired to this SYNQ integration (match against the deployment’s connection_mappings).
oneof _triggerable_by_api.triggerable_by_api	optional bool	Filter by triggerable_by_api flag.
active_only	bool	When true (default), only active deployments are returned.
include_paused	bool	When false (default), paused deployments are excluded.

ListSuiteDeploymentsResponse

(synq.agent.recon.v1.ListSuiteDeploymentsResponse)

Field	Type	Description
deployments	repeated SuiteDeployment	none
page_info	PageInfo	none

PauseDeploymentRequest

(synq.agent.recon.v1.PauseDeploymentRequest)

Field	Type	Description
suite_id	string	none
oneof _until.until	optional Timestamp	Absent = pause indefinitely.
oneof _reason.reason	optional string	none
actor	Actor	Actor performing the pause. Required.

PauseDeploymentResponse

(synq.agent.recon.v1.PauseDeploymentResponse)

Field	Type	Description
deployment	SuiteDeployment	none

PromoteSuiteRequest

(synq.agent.recon.v1.PromoteSuiteRequest)

Field	Type	Description
suite_id	string	Suite to promote. For managed suites pass the suite name; for ad-hoc pass the UUID suite_id.
oneof _state_at.state_at	optional Timestamp	Specific version to promote. Absent = latest.
connection_mappings	repeated ConnectionMapping	Mappings for suite connections that don’t already resolve to a workspace integration by name. Connections whose name matches a workspace integration can be omitted; they are resolved automatically. Promotion fails if any connection in the suite cannot be resolved.
oneof _schedule.schedule	optional SuiteSchedule	Optional cron/iCal schedule. Absent on a re-promote preserves the existing deployment’s schedule (cron or iCal) verbatim; absent on a fresh promote means no schedule. To remove a schedule from an existing deployment use UpdateDeploymentSchedule (clear), not a re-promote.
oneof _triggerable_by_api.triggerable_by_api	optional bool	When true, a TriggerDeployment RPC may execute this deployment on demand. Optional so re-promotes can omit it: an absent value preserves the existing deployment’s setting (a fresh promote defaults to false).
oneof _run_bisection.run_bisection	optional bool	Whether runs of this deployment drill into mismatched reconciliations after the quick check. Absent preserves the existing deployment’s setting on a re-promote, or defaults to true on a fresh promote. Set false for quick-check-only deployments. Each reconciliation’s own `bisection.enabled` still controls whether it is eligible to drill.
oneof _execution_timeout.execution_timeout	optional Duration	Maximum wall-clock time for a single run of this deployment. Absent on a fresh promote uses the server default; absent on a re-promote preserves the existing deployment’s setting. The server clamps the effective value to a supported range. Set a lower value to bound cost on expensive warehouses, or a higher value for large tables whose drill legitimately needs longer than the default.
oneof _change_summary.change_summary	optional string	none
oneof _deployment_id.deployment_id	optional string	Optional client-supplied deployment id (UUID). Use this to make PromoteSuite idempotent across retries: if the original request wrote a row but the response was lost, the client re-issues with the same deployment_id and the second call resolves to the same deployment.

Server semantics: - absent : reuse the existing deployment for this suite_id, or generate a fresh UUIDv7 - present, no row exists for (workspace, deployment_id) : adopt as-is - present, row exists with same suite_id : idempotent retry - present, row exists with different suite_id : ALREADY_EXISTS | | actor | Actor | Actor performing the promotion. Required. | | deployment_annotations | repeated Annotation | Initial deployment-level annotation overlay. Merged with suite-level and case-level annotations from the frozen suite snapshot. Use UpdateDeploymentAnnotations to mutate later without re-promoting. | | case_failure_impacts | map CaseFailureImpactsEntry | Per-case override controlling how the tables referenced by each reconciliation case propagate onto runs. Keyed by case name from the suite config. When a key is omitted on re-promote, the prior deployment’s value is retained — operators only set keys they want to change, and the FE can offer an “apply to all” action by sending the same value under every case name. New cases (not present in any previous deployment of this suite_id) default to RAISE_ISSUE_ON_TABLES when unset. Sending CASE_FAILURE_IMPACT_UNSPECIFIED for a known case is treated as “no opinion, keep current”; to actively reset to the default, either omit the case or send RAISE_ISSUE_ON_TABLES. |

PromoteSuiteRequest.CaseFailureImpactsEntry

(synq.agent.recon.v1.PromoteSuiteRequest.CaseFailureImpactsEntry)

Field	Type	Description
key	string	none
value	CaseFailureImpact	none

PromoteSuiteResponse

(synq.agent.recon.v1.PromoteSuiteResponse)

Field	Type	Description
deployment	SuiteDeployment	none

ResumeDeploymentRequest

(synq.agent.recon.v1.ResumeDeploymentRequest)

Field	Type	Description
suite_id	string	none
actor	Actor	Actor performing the resume. Required.

ResumeDeploymentResponse

(synq.agent.recon.v1.ResumeDeploymentResponse)

Field	Type	Description
deployment	SuiteDeployment	none

SuiteDeployment

(synq.agent.recon.v1.SuiteDeployment) SuiteDeployment is the latest state of a deployment (current row).

Field	Type	Description
deployment_id	string	Stable platform identity (UUIDv7). Preserved across re-promotes, pause/resume, and unpromote → re-promote cycles. Downstream AssetCommand / RunCommand reference this.
suite_id	string	Suite this deployment came from.
suite_name	string	none
oneof _suite_title.suite_title	optional string	none
oneof _suite_description.suite_description	optional string	none
active	bool	False after UnpromoteSuite. Scheduler and triggers stop.
oneof _paused_until.paused_until	optional Timestamp	When set and in the future, scheduled/triggered runs are suppressed. An indefinite pause uses a far-future sentinel timestamp.
oneof _paused_reason.paused_reason	optional string	none
suite	ReconcilationSuite	Frozen snapshot of the suite config at promote time.
connection_mappings	repeated ConnectionMapping	Mapping used at execution time to resolve DWH credentials.
oneof _schedule.schedule	optional SuiteSchedule	Schedule (if any). Absent = no cron; use triggerable_by_api.
triggerable_by_api	bool	When true, this deployment can be run on demand via TriggerDeployment, in addition to any cron schedule.
oneof _run_bisection.run_bisection	optional bool	When true (the default), runs of this deployment drill into mismatched reconciliations via bisection after the quick check to locate the differing rows; when false, runs stop at the quick check. Each reconciliation’s own `bisection.enabled` still controls whether it is eligible to drill, so this acts as the deployment-wide switch on top.
oneof _execution_timeout.execution_timeout	optional Duration	Maximum wall-clock time for a single run of this deployment (the quick check plus any bisection drill). A run that exceeds it is cancelled and marked failed. Absent means the server default applies; the effective value is clamped to a supported range. Lower it to bound cost on expensive warehouses where a deep drill can run for a long time.
connection_names	repeated string	Denormalized summaries so listing callers don’t need to parse the snapshot.
integration_ids	repeated string	none
reconciliation_summaries	repeated ReconciliationConfigSummary	none
source_suite_type	string	Where this deployment’s snapshot came from.

“managed” or “adhoc” | | source_config_state_at | Timestamp | none | | state_at | Timestamp | Most recent event timestamp. | | last_action | DeploymentAction | none | | oneof _last_actor.last_actor | optional Actor | none | | oneof _last_change_summary.last_change_summary | optional string | none | | oneof _next_run_at.next_run_at | optional Timestamp | Next cron occurrence computed live from schedule at response time. Absent when there’s no schedule, when the deployment is inactive/paused, or when the schedule expression no longer yields an upcoming occurrence (e.g. an iCal RRULE that has finished). Use this for “Next run: …” UI hints — it’s the authoritative upcoming-tick source, independent of any pre-materialised execution_jobs / run_state rows. | | deployment_annotations | repeated Annotation | Deployment-level annotation overlay. Applied on top of the suite-level and case-level annotations baked into the frozen suite snapshot. The merged, deduplicated list lives on PromotedReconSuiteMetadata / PromotedReconCaseMetadata — this field exposes only the deployment’s own overlay so callers can render and edit it independently. | | case_failure_impacts | map CaseFailureImpactsEntry | Effective per-case CaseFailureImpact map currently in force for this deployment. Keyed by case name. Cases without an entry behave as RAISE_ISSUE_ON_TABLES. Drives whether the runner attaches each case’s referenced tables to Run.target (issue-raising) or Run.extra_references (visibility only) — see PromotedReconCaseMetadata.error_tables / shown_tables for the resolved table lists. |

SuiteDeployment.CaseFailureImpactsEntry

(synq.agent.recon.v1.SuiteDeployment.CaseFailureImpactsEntry)

Field	Type	Description
key	string	none
value	CaseFailureImpact	none

SuiteDeploymentHistoryEntry

(synq.agent.recon.v1.SuiteDeploymentHistoryEntry) SuiteDeploymentHistoryEntry is a single event in the deployment’s history.

Field	Type	Description
deployment_id	string	none
suite_id	string	none
state_at	Timestamp	none
action	DeploymentAction	none
active	bool	State of the deployment at the moment of this event.
oneof _paused_until.paused_until	optional Timestamp	none
oneof _paused_reason.paused_reason	optional string	none
oneof _schedule.schedule	optional SuiteSchedule	none
triggerable_by_api	bool	none
connection_mappings	repeated ConnectionMapping	none
oneof _run_bisection.run_bisection	optional bool	The run_bisection setting in force at the time of this event.
oneof _execution_timeout.execution_timeout	optional Duration	The execution_timeout in force at the time of this event. Absent means the server default applied.
oneof _suite.suite	optional ReconcilationSuite	Only filled for PROMOTED / REPROMOTED events (snapshot changes).
oneof _source_config_state_at.source_config_state_at	optional Timestamp	none
oneof _actor.actor	optional Actor	none
oneof _change_summary.change_summary	optional string	none
deployment_annotations	repeated Annotation	Deployment-level annotation overlay at this point in time. Filled on every history entry (annotation changes carry the full new list, other events carry the snapshot at the time of the event).
case_failure_impacts	map CaseFailureImpactsEntry	Effective per-case CaseFailureImpact map at this point in time. Snapshot semantics — every history entry carries the full map in force right after the event was recorded.

SuiteDeploymentHistoryEntry.CaseFailureImpactsEntry

(synq.agent.recon.v1.SuiteDeploymentHistoryEntry.CaseFailureImpactsEntry)

Field	Type	Description
key	string	none
value	CaseFailureImpact	none

TriggerDeploymentRequest

(synq.agent.recon.v1.TriggerDeploymentRequest)

Field	Type	Description
oneof lookup.suite_id	string	none
oneof lookup.deployment_id	string	none
actor	Actor	Actor triggering the run. Required.
oneof _run_bisection.run_bisection	optional bool	Per-run override for the deployment’s stored run_bisection setting. Unset (the default) inherits the deployment’s value, so an on-demand run behaves like a scheduled one. Set false for a cheap quick-check-only run with no bisection drill-down.
oneof _execution_timeout.execution_timeout	optional Duration	Per-run override for the deployment’s stored execution_timeout. Unset (the default) inherits the deployment’s value. Set it to bound this one run to a shorter or longer wall-clock budget; the server clamps the effective value to a supported range.

TriggerDeploymentResponse

(synq.agent.recon.v1.TriggerDeploymentResponse)

Field	Type	Description
deployment_id	string	Identity of the deployment that was triggered (canonical form even when the request used `suite_id`).
run_id	string	Stable opaque identifier of the enqueued run. Pass this to RunStateService to track lifecycle.
scheduled_at	Timestamp	When the run is scheduled to start. For TriggerDeployment this is ~now(); the worker will pick it up shortly.

UnpromoteSuiteRequest

(synq.agent.recon.v1.UnpromoteSuiteRequest)

Field	Type	Description
suite_id	string	none
oneof _reason.reason	optional string	none
actor	Actor	Actor performing the unpromote. Required.

UnpromoteSuiteResponse

(synq.agent.recon.v1.UnpromoteSuiteResponse)

Field	Type	Description
deployment	SuiteDeployment	none

UnresolvedConnection

(synq.agent.recon.v1.UnresolvedConnection) One entry per connection name the server failed to resolve. Returned inside ConnectionResolutionFailure as the structured error detail of a FAILED_PRECONDITION on adhoc submission or deployment promote/update.

Field	Type	Description
connection_name	string	Connection name as referenced by the suite config.
reason	ConnectionResolutionReason	Why the server could not satisfy the mapping.
message	string	Optional human-readable elaboration (“integration X has reconciliation adhoc disabled by workspace admin”, etc.). Already includes workspace / suite context — safe to surface verbatim.
candidate_integration_ids	repeated string	Suggested integration ids the caller could pick from. Filtered by the capability the failing call needs (RECONCILIATION_ADHOC for adhoc, RECONCILIATION_DEPLOY for deployment) so the UI can render a picker directly without re-querying.

UpdateDeploymentAnnotationsRequest

(synq.agent.recon.v1.UpdateDeploymentAnnotationsRequest)

Field	Type	Description
suite_id	string	none
deployment_annotations	repeated Annotation	Full replacement for the deployment-level annotation overlay. Pass an empty list to clear all deployment-level annotations (suite/case annotations from the frozen snapshot still apply).
oneof _change_summary.change_summary	optional string	none
actor	Actor	Actor performing the annotation update. Required.

UpdateDeploymentAnnotationsResponse

(synq.agent.recon.v1.UpdateDeploymentAnnotationsResponse)

Field	Type	Description
deployment	SuiteDeployment	none

UpdateDeploymentCaseImpactsRequest

(synq.agent.recon.v1.UpdateDeploymentCaseImpactsRequest)

Field	Type	Description
suite_id	string	none
case_failure_impacts	map CaseFailureImpactsEntry	Partial patch of the per-case impact map. See UpdateDeploymentCaseImpacts RPC docs for merge / clear semantics.
oneof _change_summary.change_summary	optional string	none
actor	Actor	Actor performing the update. Required.

UpdateDeploymentCaseImpactsRequest.CaseFailureImpactsEntry

(synq.agent.recon.v1.UpdateDeploymentCaseImpactsRequest.CaseFailureImpactsEntry)

Field	Type	Description
key	string	none
value	CaseFailureImpact	none

UpdateDeploymentCaseImpactsResponse

(synq.agent.recon.v1.UpdateDeploymentCaseImpactsResponse)

Field	Type	Description
deployment	SuiteDeployment	none

UpdateDeploymentMappingsRequest

(synq.agent.recon.v1.UpdateDeploymentMappingsRequest)

Field	Type	Description
suite_id	string	none
connection_mappings	repeated ConnectionMapping	Same shape as PromoteSuiteRequest.connection_mappings — entries are optional and apply only to connections that don’t resolve by name.
oneof _change_summary.change_summary	optional string	none
actor	Actor	Actor performing the mapping update. Required.

UpdateDeploymentMappingsResponse

(synq.agent.recon.v1.UpdateDeploymentMappingsResponse)

Field	Type	Description
deployment	SuiteDeployment	none

UpdateDeploymentScheduleRequest

(synq.agent.recon.v1.UpdateDeploymentScheduleRequest)

Field	Type	Description
suite_id	string	none
oneof _schedule.schedule	optional SuiteSchedule	Presence-based: - absent = preserve current schedule - present, empty = clear the schedule (an empty SuiteSchedule has no cron, which the deployment row stores as no schedule) - present, with cron = replace the schedule
oneof _triggerable_by_api.triggerable_by_api	optional bool	Absent = preserve current setting. Otherwise update triggerable_by_api.
oneof _change_summary.change_summary	optional string	none
oneof _run_bisection.run_bisection	optional bool	Absent = preserve current setting. Otherwise update the deployment’s run_bisection flag.
oneof _execution_timeout.execution_timeout	optional Duration	Absent = preserve current setting. Otherwise update the deployment’s execution_timeout (maximum wall-clock budget for a single run). The server clamps the effective value to a supported range at run time.
actor	Actor	Actor performing the schedule update. Required.

UpdateDeploymentScheduleResponse

(synq.agent.recon.v1.UpdateDeploymentScheduleResponse)

Field	Type	Description
deployment	SuiteDeployment	none

ParseYamlRequest

(synq.agent.recon.v1.ParseYamlRequest)

Field	Type	Description
yaml	string	YAML config string to parse.

ParseYamlResponse

(synq.agent.recon.v1.ParseYamlResponse)

Field	Type	Description
suite	ReconcilationSuite	The parsed suite configuration.

RenderYamlRequest

(synq.agent.recon.v1.RenderYamlRequest)

Field	Type	Description
suite	ReconcilationSuite	The suite configuration to render as YAML.

RenderYamlResponse

(synq.agent.recon.v1.RenderYamlResponse)

Field	Type	Description
yaml	string	The rendered YAML config string.

ColumnThresholdOverride

(synq.agent.recon.v1.ColumnThresholdOverride) ColumnThresholdOverride associates threshold overrides with a specific group_column level in the aggregate drill-down hierarchy.

Field	Type	Description
column	string	Group column name this override applies to. Must match one of the group_columns in the AggregateConfig.
thresholds	ThresholdConfig	Threshold overrides for this group column level. Values here override the parent ThresholdConfig for reconciliation groups at this drill-down level. May include per_measure for further specificity.

MeasureThresholdOverride

(synq.agent.recon.v1.MeasureThresholdOverride) MeasureThresholdOverride associates threshold overrides with a specific measure (aggregate function + column combination).

Field	Type	Description
function	AggregateFunction	Aggregate function this override applies to.
column	string	Column name this override applies to. Together with function, forms the measure key (e.g., SUM + “amount” = “SUM(amount)“).
thresholds	ThresholdConfig	Threshold overrides for this specific measure. Values here override the parent ThresholdConfig (and any per_column override) for this measure only.

ThresholdConfig

(synq.agent.recon.v1.ThresholdConfig) ThresholdConfig defines tolerance thresholds for aggregate comparisons. A difference is reported as a mismatch only when it exceeds ALL configured thresholds (AND logic: both absolute AND percentage must be exceeded). Thresholds can be overridden at finer granularity:

per_column: override thresholds for a specific group_column drill-down level.
per_measure: override thresholds for a specific measure (e.g., “SUM(amount)”).
Nesting: per_column entries may contain per_measure overrides (most specific wins).

When no thresholds are configured at any level, exact match is required.

Field	Type	Description
oneof _absolute.absolute	optional double	Maximum allowed absolute difference per measure. When set, differences ≤ this value are considered within tolerance. Example: absolute = 0.01 accepts sub-cent rounding differences.
oneof _percentage.percentage	optional double	Maximum allowed percentage difference per measure. Expressed as a decimal fraction: 0.1 = 10%, 0.01 = 1%. The formula used depends on percentage_mode. When set, differences ≤ this percentage are considered within tolerance.
percentage_mode	PercentageMode	Which percentage formula to use for threshold evaluation. Only relevant when percentage is set.
per_column	repeated ColumnThresholdOverride	Per group_column level threshold overrides. Allows different tolerance for different levels of the drill-down hierarchy. For example, tighter thresholds at the city level than at the region level. Entries may themselves contain per_measure overrides for maximum specificity.
per_measure	repeated MeasureThresholdOverride	Per measure threshold overrides. Allows different tolerance for different measures within the same reconciliation. For example, allow 1% tolerance for SUM(amount) but require exact COUNT match.

DeleteSuiteConfigRequest

(synq.agent.recon.v1.DeleteSuiteConfigRequest)

Field	Type	Description
suite_id	string	Suite ID to delete.
actor	Actor	Actor performing the delete. Required.

DeleteSuiteConfigResponse

(synq.agent.recon.v1.DeleteSuiteConfigResponse)

GetSuiteConfigRequest

(synq.agent.recon.v1.GetSuiteConfigRequest)

Field	Type	Description
suite_id	string	Suite ID to look up. For managed suites this equals the suite name, for ad-hoc suites this is the generated UUID.

GetSuiteConfigResponse

(synq.agent.recon.v1.GetSuiteConfigResponse)

Field	Type	Description
suite_config	SuiteConfig	none

GetSuiteConfigVersionRequest

(synq.agent.recon.v1.GetSuiteConfigVersionRequest)

Field	Type	Description
suite_id	string	Suite ID.
state_at	Timestamp	Version timestamp.

GetSuiteConfigVersionResponse

(synq.agent.recon.v1.GetSuiteConfigVersionResponse)

Field	Type	Description
version	SuiteConfigVersion	none

ListSuiteConfigVersionsRequest

(synq.agent.recon.v1.ListSuiteConfigVersionsRequest)

Field	Type	Description
suite_id	string	Suite ID to get version history for.
oneof _pagination.pagination	optional Pagination	Pagination parameters.

ListSuiteConfigVersionsResponse

(synq.agent.recon.v1.ListSuiteConfigVersionsResponse)

Field	Type	Description
versions	repeated SuiteConfigVersion	none
page_info	PageInfo	Pagination info for fetching the next page.

ListSuiteConfigsRequest

(synq.agent.recon.v1.ListSuiteConfigsRequest)

Field	Type	Description
oneof _connection_name.connection_name	optional string	Filter suites using a specific connection name. When empty, returns all.
oneof _pagination.pagination	optional Pagination	Pagination parameters.
include_adhoc	bool	When true, also include ad-hoc suite configs in the results. By default only managed suites are returned.

ListSuiteConfigsResponse

(synq.agent.recon.v1.ListSuiteConfigsResponse)

Field	Type	Description
suite_configs	repeated SuiteConfig	none
page_info	PageInfo	Pagination info for fetching the next page.

SubmitAdhocSuiteRequest

(synq.agent.recon.v1.SubmitAdhocSuiteRequest)

Field	Type	Description
oneof _suite.suite	optional ReconcilationSuite	Inline suite configuration. Required when suite_id is not set.
invocation_id	string	Client-generated invocation ID for idempotency. If an execution with this ID already exists, the call is a no-op.
oneof _suite_id.suite_id	optional string	Reference to an existing managed suite (alternative to inline suite). When set, the suite config is loaded from the database.
connection_mappings	repeated ConnectionMapping	Maps each connection name referenced by the suite to the integration that should provide credentials at execution time.

When omitted, the server attempts to resolve each connection name against a workspace integration of the same name (legacy behaviour). When the suite references connection names that the server cannot resolve, the call fails with FAILED_PRECONDITION + a ConnectionResolutionFailure detail listing every unresolved name and candidate integrations, so the caller can prompt the user to bind them. Both workspace-level (integration_id) and user-level (user_integration_id) credentials are accepted here: - integration_id requires SCOPE_INTEGRATION_EDIT on the caller. - user_integration_id requires a user identity in the calling context and the integration’s allow_reconciliation_adhoc gate enabled. | | oneof _run_bisection.run_bisection | optional bool | When true (default), the runner drills into each mismatched reconciliation via bisection after the quick check fails. Set to false to stop after the quick check — useful for cheap smoke runs, or when the caller plans to trigger a manual drill later. Per-reconciliation bisection.enabled still gates whether a given recon is eligible for drill, so this flag is the run-level off switch layered on top. | | oneof _execution_timeout.execution_timeout | optional Duration | Maximum wall-clock time for this ad-hoc run (quick check plus any bisection drill). A run that exceeds it is cancelled and marked failed. Absent uses the server default; the server clamps the effective value to a supported range. | | actor | Actor | Actor submitting the run. Required. |

SubmitAdhocSuiteResponse

(synq.agent.recon.v1.SubmitAdhocSuiteResponse)

Field	Type	Description
suite_config	SuiteConfig	The stored suite config (includes the invocation_id as suite_id).

SuiteConfig

(synq.agent.recon.v1.SuiteConfig) SuiteConfig represents the latest version of a reconciliation suite configuration.

Field	Type	Description
suite_id	string	Unique identifier. Equals suite_name for managed suites, UUID for ad-hoc.
suite_name	string	Human-readable suite name from ReconcilationSuite.name.
oneof _suite_title.suite_title	optional string	none
oneof _suite_description.suite_description	optional string	none
suite_type	string	”managed” or “adhoc”.
suite	ReconcilationSuite	The full suite configuration.
connection_names	repeated string	Deduplicated connection names referenced by this suite.
reconciliation_summaries	repeated ReconciliationConfigSummary	Summary of each reconciliation in the suite.
oneof _updated_by.updated_by	optional Actor	Who last updated this config.
state_at	Timestamp	When this version was created.

SuiteConfigVersion

(synq.agent.recon.v1.SuiteConfigVersion) SuiteConfigVersion represents a historical version of a suite config.

Field	Type	Description
suite_id	string	none
suite_name	string	none
oneof _suite_title.suite_title	optional string	none
oneof _suite_description.suite_description	optional string	none
suite_type	string	none
suite	ReconcilationSuite	The full suite configuration at this version.
connection_names	repeated string	Connection names at this version.
reconciliation_summaries	repeated ReconciliationConfigSummary	Reconciliation summaries at this version.
oneof _updated_by.updated_by	optional Actor	Who made this change.
state_at	Timestamp	When this version was created.
deleted	bool	Whether this version represents a deletion.
oneof _change_summary.change_summary	optional string	Human-readable summary of what changed.

UpsertSuiteConfigRequest

(synq.agent.recon.v1.UpsertSuiteConfigRequest)

Field	Type	Description
suite	ReconcilationSuite	The suite configuration to store. suite_id will equal suite.name.
oneof _change_summary.change_summary	optional string	Human-readable summary of what changed in this version.
actor	Actor	Actor performing the upsert. Required.

UpsertSuiteConfigResponse

(synq.agent.recon.v1.UpsertSuiteConfigResponse)

Field	Type	Description
suite_config	SuiteConfig	The stored suite config.

AggregateDrillTarget

(synq.agent.recon.v1.AggregateDrillTarget) AggregateDrillTarget specifies how to extend or drill deeper into aggregate results.

Field	Type	Description
groups	repeated GroupTarget	Specific group key values to drill into. When empty, all mismatched groups from the parent audit are drilled.
additional_group_columns	repeated string	Additional group columns to add to the drill-down hierarchy. Appended after the existing group_columns from the reconciliation config.
additional_measures	repeated Measure	Additional measures to compute that weren’t in the original config.
oneof _threshold_overrides.threshold_overrides	optional ThresholdConfig	Override thresholds for this drill pass.

BisectionDrillTarget

(synq.agent.recon.v1.BisectionDrillTarget) BisectionDrillTarget specifies which mismatch leaves to drill deeper into.

Field	Type	Description
segments	repeated SegmentTarget	Specific segments to drill into. Each segment is identified by its boundaries. When empty, all mismatch leaves from the parent audit are drilled.
oneof _factor.factor	optional int32	Override the bisection factor for this drill pass.
oneof _threshold.threshold	optional int32	Override the row count threshold for this drill pass.
oneof _reporting_level.reporting_level	optional ReportingLevel	Override the reporting level for this drill pass.

GroupTarget

(synq.agent.recon.v1.GroupTarget) GroupTarget identifies a specific group to drill into by its key values.

Field	Type	Description
key	Struct	Group key values that identify this group (column name -> value).

ReconcilationFilter

(synq.agent.recon.v1.ReconcilationFilter) ReconcilationFilter controls which reconciliations are included or excluded.

Field	Type	Description
include	repeated string	Run only these reconciliations (by name). Mutually exclusive with exclude.
exclude	repeated string	Skip these reconciliations (by name). Mutually exclusive with include.

ReconcilationOverride

(synq.agent.recon.v1.ReconcilationOverride) ReconcilationOverride provides per-reconciliation instructions for a run. Used to drill into specific mismatches, adjust config, or extend comparisons.

Field	Type	Description
name	string	Name of the reconciliation this override applies to.
oneof action.bisection_drill	BisectionDrillTarget	Drill into specific bisection mismatch leaves from a prior run.
oneof action.aggregate_drill	AggregateDrillTarget	Drill into specific aggregate groups or add new dimensions from a prior run.
oneof action.rerun	RerunAction	Re-run the reconciliation from scratch, optionally with config changes.

ReconcilationRunRequest

(synq.agent.recon.v1.ReconcilationRunRequest) ReconcilationRunRequest describes what to execute in a reconciliation run. It can start a fresh run, continue from a previous audit, or drill deeper into specific mismatches found in a prior run.

Field	Type	Description
oneof _suite.suite	optional ReconcilationSuite	Suite to execute. Required for fresh runs. When continuing from a parent audit, can be omitted to reuse the parent’s suite.
oneof _parent_audit.parent_audit	optional AuditLog	Parent audit log to continue from. When set, this run resumes or drills deeper into the parent’s results.
oneof _filter.filter	optional ReconcilationFilter	Filter which reconciliations to execute. When empty, all reconciliations in the suite are executed.
variable_overrides	map VariableOverridesEntry	Variable overrides applied on top of suite-level variables.
overrides	repeated ReconcilationOverride	Per-reconciliation drill-down and override instructions.

ReconcilationRunRequest.VariableOverridesEntry

(synq.agent.recon.v1.ReconcilationRunRequest.VariableOverridesEntry)

Field	Type	Description
key	string	none
value	string	none

RerunAction

(synq.agent.recon.v1.RerunAction) RerunAction re-runs a reconciliation from scratch with optional config overrides.

Field	Type	Description
oneof _mode.mode	optional ReconcilationMode	Override the comparison mode.
oneof _bisection.bisection	optional BisectionConfig	Override the bisection configuration.
oneof _reporting.reporting	optional ReportingConfig	Override the reporting configuration.
oneof _aggregate.aggregate	optional AggregateConfig	Override the aggregate configuration.
oneof _error_handling.error_handling	optional ErrorHandlingConfig	Override the error handling configuration.

SegmentTarget

(synq.agent.recon.v1.SegmentTarget) SegmentTarget identifies a specific segment to drill into.

Field	Type	Description
oneof _min_key.min_key	optional Value	Minimum key (inclusive). Unset means unbounded.
oneof _max_key.max_key	optional Value	Maximum key (exclusive). Unset means unbounded.
oneof _time_bucket.time_bucket	optional string	Time bucket (for time-based segmentation).

ReconciliationRunState

(synq.agent.recon.v1.ReconciliationRunState) ReconciliationRunState describes the lifecycle of a single reconciliation run. Returned by RunStateService.

Field	Type	Description
suite_id	string	Suite identifier this run belongs to. For managed suites this is the suite_name; for ad-hoc suites this is the generated UUID.
deployment_id	string	Deployment identifier (UUIDv7) if the run belongs to a promoted deployment. Empty for ad-hoc and legacy managed-suite runs.
run_id	string	Stable opaque identifier of this specific run occurrence (UUIDv7).
status	ReconciliationRunStatus	none
trigger	ReconciliationRunTrigger	none
scheduled_at	Timestamp	When this run was scheduled to start (cron occurrence time, or now() for ad-hoc).
oneof _started_at.started_at	optional Timestamp	When the worker actually picked up the run.
oneof _finished_at.finished_at	optional Timestamp	When the run reached a terminal status (SUCCEEDED / FAILED / CANCELLED).
last_updated_at	Timestamp	Last time this row was updated.
oneof _actor.actor	optional Actor	Actor that initiated the run (user or system). Populated for ADHOC and API triggers.
failure_category	ReconciliationRunFailureCategory	Set only when status is FAILED.
oneof _failure_details.failure_details	optional string	Raw failure detail string. Set only when status is FAILED.
oneof _invocation_id.invocation_id	optional string	Identifier of the audit log this run produced. Empty when the run failed before the worker emitted an audit log (e.g. binding-resolution failure on a misconfigured deployment, or the run was cancelled). When set, pass to AuditLogService.GetAuditLog to retrieve the full per-reconciliation results for this run.

AggregateConfig

(synq.agent.recon.v1.AggregateConfig) AggregateConfig defines aggregate comparison settings. Used when mode is AGGREGATE to compare grouped measures between source and target.

Field	Type	Description
measures	repeated Measure	Measures to compare between source and target. Each measure defines a column and one or more aggregate functions to apply.
oneof _thresholds.thresholds	optional ThresholdConfig	Tolerance thresholds for aggregate comparisons. When not set, exact match is required for all measures.
group_columns	repeated string	Columns defining the drill-down hierarchy for aggregate comparison. Falls back to key_column if not set.

Single column: flat GROUP BY comparison. group_columns: [“region”] → GROUP BY region Multiple columns: cumulative GROUP BY drill-down, pruning matched groups at each level to focus on divergent branches. group_columns: [“region”, “city”, “store”] → Level 0: GROUP BY region → Level 1: GROUP BY region, city (only for mismatched regions) → Level 2: GROUP BY region, city, store (only for mismatched cities) |

BisectionConfig

(synq.agent.recon.v1.BisectionConfig) BisectionConfig controls the bisection drill-down algorithm that recursively splits the key range to locate individual mismatched rows. Only used in ROW_CHECKSUM mode.

Field	Type	Description
enabled	bool	Whether bisection drill-down is enabled. When false, only the quick-check (count + checksum) runs — mismatches are detected but not localized to specific rows.
oneof _factor.factor	optional int32	Branching factor: how many segments each level is split into. Higher values find mismatches faster (fewer levels) but issue more queries per level. Default: 32. Typical range: 4–64.
oneof _threshold.threshold	optional int32	Row count threshold: stop bisecting when a segment has fewer rows than this. Lower values find more precise mismatch locations but issue more queries. Default: 16384. Set to 1 to drill down to individual rows.
strategy	SegmentationStrategy	Segmentation strategy for splitting key ranges.
oneof _time_column.time_column	optional string	Column for time-based partitioning. Required when strategy is TIME. Must be a timestamp, date, or datetime column in the dataset.
time_granularity	TimeGranularity	Granularity for time-based segmentation. Default: DAY. Controls the width of each time bucket when strategy is TIME.

ConnectionQueries

(synq.agent.recon.v1.ConnectionQueries) ConnectionQueries associates SQL queries with a specific connection. Used for setup and teardown blocks at both suite and reconciliation level.

Field	Type	Description
connection	string	Connection name to execute these queries on. Must reference a connection configured in the runner’s connection map.
queries	repeated string	SQL queries to execute in order on this connection.

ErrorHandlingConfig

(synq.agent.recon.v1.ErrorHandlingConfig) ErrorHandlingConfig controls retry and timeout behavior for database queries. Applies to all queries within a reconciliation (setup, comparison, teardown).

Field	Type	Description
oneof _query_timeout.query_timeout	optional Duration	Per-query timeout. When a query exceeds this duration, it is cancelled. Default: no per-query limit (only the global run timeout applies).
oneof _max_retries.max_retries	optional int32	Maximum retry attempts for transient query failures. The total number of attempts is max_retries + 1 (initial + retries). Default: 2.
oneof _retry_initial_delay.retry_initial_delay	optional Duration	Initial backoff delay before the first retry. Subsequent retries multiply this by retry_backoff_factor. Default: 1s.
oneof _retry_backoff_factor.retry_backoff_factor	optional double	Backoff multiplier applied after each retry. Delay for attempt N = retry_initial_delay * retry_backoff_factor^(N-1). Must be ≥ 1.0 to ensure delays don’t decrease. Default: 2.0.

Measure

(synq.agent.recon.v1.Measure) Measure defines a column and aggregate function(s) to compare between source and target datasets. A single measure with multiple functions expands into multiple comparisons (e.g., column=“amount” functions=[SUM, AVG] produces “SUM(amount)” and “AVG(amount)”).

Field	Type	Description
column	string	Column name to aggregate. Must exist in both source and target datasets (after column mapping is applied).
functions	repeated AggregateFunction	Aggregate functions to apply to this column. Multiple functions produce multiple measure comparisons from one column.

Reconcilation

(synq.agent.recon.v1.Reconcilation) Reconcilation defines a single reconciliation scenario comparing data between a source and target dataset. Each reconciliation runs independently and produces its own pass/mismatch/fail result.

Field	Type	Description
name	string	Unique machine identifier within the suite. Alphanumerics, hyphens, and underscores. May be a UUID.
oneof _title.title	optional string	Human-readable title. Displayed in reports. Defaults to name when not set.
oneof _description.description	optional string	Optional longer description explaining what this reconciliation validates.
source	Dataset	Source dataset to compare from — the “expected” or “authoritative” side.
target	Dataset	Target dataset to compare against — the “actual” or “replicated” side.
oneof _key_column.key_column	optional string	Deprecated: use key_columns instead. Single primary key column used for ordering and segmentation during bisection. Retained for backward compatibility — existing single-key configs and stored audit logs keep working. When key_columns is set, this field is ignored. Readers should resolve the effective key via key_columns first, falling back to this.
key_columns	repeated string	Ordered list of key columns used for ordering and segmentation during bisection. Supports composite (multi-column) keys; the bisection orders and range-filters on the column tuple so the engine can prune via a matching primary key / index. A single-element list is equivalent to setting key_column. Required for ROW_CHECKSUM and ROW_COUNT modes (this or the deprecated key_column). Optional in AGGREGATE mode when group_columns provides the grouping key.
mode	ReconcilationMode	Comparison mode controlling how source and target are compared.
oneof _hash_algorithm.hash_algorithm	optional HashAlgorithm	Hash algorithm for row checksums in ROW_CHECKSUM mode. When unset, auto-negotiates the best common algorithm between the source and target database dialects.
column_mapping	repeated ColumnMapping	Explicit column name mapping between source and target. Only columns with different names need mapping — identical names (or case-insensitive matches) are matched automatically.
oneof _case_insensitive.case_insensitive	optional bool	When true, automatically matches columns differing only in letter case (e.g., user_id matches USER_ID). Defaults to true when not set. Set to false to require exact case matching.
oneof _bisection.bisection	optional BisectionConfig	Bisection drill-down configuration for ROW_CHECKSUM mode. Controls how the key range is recursively split to locate mismatches. When not set, uses sensible defaults (factor=32, threshold=16384).
oneof _reporting.reporting	optional ReportingConfig	Reporting output configuration controlling how much detail is included in the audit log for mismatched rows.
oneof _aggregate.aggregate	optional AggregateConfig	Aggregate comparison settings. Required when mode is AGGREGATE. Defines which measures to compare and tolerance thresholds.
oneof _error_handling.error_handling	optional ErrorHandlingConfig	Error handling and retry configuration for database queries. Controls timeouts and retry behavior for transient failures.
oneof _window.window	optional WindowConfig	Time window for incremental comparison. When set, automatically provides a {{window_start}} template variable for filtering queries to a recent time range.
setup	repeated ConnectionQueries	Setup queries run before this specific reconciliation. Executes after suite-level setup but before data comparison.
teardown	repeated ConnectionQueries	Teardown queries run after this specific reconciliation completes.
oneof _teardown_on_failure.teardown_on_failure	optional bool	Whether teardown runs on failure for this reconciliation. When not set, inherits from suite-level teardown_on_failure.
oneof _ignore_setup_errors.ignore_setup_errors	optional bool	When true, logs setup errors as warnings and continues. When not set, inherits from suite-level ignore_setup_errors.
oneof _cutoff.cutoff	optional CutoffConfig	Dynamic cutoff filter for sync reconciliation. Derives a watermark from actual data to exclude rows not yet synced. Applied as WHERE filter to both source and target queries at runtime.
annotations	repeated Annotation	Case-level annotations. Merged with suite-level annotations and deployment-level annotations at promote time, then exposed on the case asset (PromotedReconCaseMetadata).

ReconcilationSuite

(synq.agent.recon.v1.ReconcilationSuite) ReconcilationSuite is the root configuration for a reconciliation suite. It defines template variables and one or more reconciliation scenarios that compare data between source and target databases. Database connections are configured separately and referenced by name.

Field	Type	Description
name	string	Short machine identifier for the suite. Unique machine identifier for the suite, used as the stable key for tracking runs over time. Alphanumerics, hyphens, and underscores. May be a UUID.
oneof _title.title	optional string	Human-readable title for the suite. Displayed in dashboards and reports. Defaults to name when not set.
oneof _description.description	optional string	Optional longer description of the suite’s purpose.
reconciliations	repeated Reconcilation	Reconciliation scenarios to execute. Each reconciliation compares data between a source and target dataset.
setup	repeated ConnectionQueries	Setup queries run once before all reconciliations begin. Use for creating temp tables, loading fixtures, or preparing the environment. Queries execute in order; all connections run sequentially.
teardown	repeated ConnectionQueries	Teardown queries run once after all reconciliations complete. Use for cleaning up temp tables or restoring state.
teardown_on_failure	bool	Whether teardown runs even when reconciliations fail with infrastructure errors. When false (default), teardown is skipped on failure to preserve state for debugging.
ignore_setup_errors	bool	When true, logs setup query errors as warnings and continues execution instead of aborting the run. Useful when setup creates IF NOT EXISTS objects.
variables	map VariablesEntry	Template variables for query interpolation via {{variable_name}} syntax. Values can be literal strings or template expressions: - Literal: “2026-01-01” - Time expression: “{{today - 30d}}”, “{{now - 2h}}” - Built-in: “{{now}}”, “{{today}}”, “{{window_start}}” Variables are resolved once at the start of the run and frozen.
strict_time_references	bool	When true, time reference detection (e.g. NOW(), CURRENT_DATE, GETDATE() in queries) returns an error instead of a warning. Prevents non-deterministic queries that produce different results on each run.
annotations	repeated Annotation	Suite-level annotations. Each annotation is a name with zero or more string values. Applied to the deployed suite asset and inherited by every reconciliation case under the suite. Merged with per-case annotations and deployment-level annotations at promote time — the final, deduplicated list is exposed on PromotedReconSuiteMetadata / PromotedReconCaseMetadata and surfaced to the rest of the SYNQ platform via EntityAnnotations.

ReconcilationSuite.VariablesEntry

(synq.agent.recon.v1.ReconcilationSuite.VariablesEntry)

Field	Type	Description
key	string	none
value	string	none

ReportingConfig

(synq.agent.recon.v1.ReportingConfig) ReportingConfig controls the level of detail included in reconciliation output for mismatched rows. Higher detail levels reveal more data but may have privacy implications.

Field	Type	Description
level	ReportingLevel	Output detail level for mismatched rows.
oneof _sample_limit.sample_limit	optional int32	Maximum number of sample rows to include in output per mismatch segment. Limits the size of the audit log when there are many mismatches. When not set, all mismatched rows within the reporting level are included.
consent_acknowledged	bool	Explicit acknowledgment that detailed row data may be included in the audit log. Required when level is DETAILED to prevent accidental exposure of sensitive data. The caller must set this to true to confirm they understand the privacy implications.

WindowConfig

(synq.agent.recon.v1.WindowConfig) WindowConfig defines a time window for incremental comparison. When configured, automatically provides a {{window_start}} template variable that resolves to (current_time - lookback). Use this in query WHERE clauses to limit comparison to recent data.

Field	Type	Description
oneof _column.column	optional string	Column being windowed. Informational metadata for the audit trail — the actual filtering is done via the {{window_start}} variable in your query WHERE clause.
lookback	Duration	How far back to look from the current time. Defines the window as [now - lookback, now]. Examples: “336h” (14 days), “2h”, “720h” (30 days).
strategy	WindowStrategy	Windowing strategy controlling how boundaries are computed.

CutoffApplyConfig

(synq.agent.recon.v1.CutoffApplyConfig) CutoffApplyConfig controls how the resolved cutoff value is applied as a WHERE filter.

Field	Type	Description
oneof _column.column	optional string	Column to filter on. When not set, uses the derivation column from that side.
oneof _operator.operator	optional string	Comparison operator. Default: ”≤”.

CutoffConfig

(synq.agent.recon.v1.CutoffConfig) CutoffConfig defines a dynamic cutoff filter for sync reconciliation. It derives a watermark value from the actual data (e.g., MAX(created_at)) to automatically exclude rows that haven’t been synced yet. The cutoff is resolved at runtime before comparison queries run:

Derive watermark(s) from source and/or target via aggregate queries.
Combine them (default: MIN of both sides).
Optionally truncate to a time boundary and apply an offset.
Apply as WHERE filter to both source and target queries.

Field	Type	Description
oneof _source.source	optional CutoffSideConfig	Per-side watermark derivation config for source. When not set, derives from target only.
oneof _target.target	optional CutoffSideConfig	Per-side watermark derivation config for target. When not set, derives from source only.
combine	CutoffCombine	How to combine watermarks when both sides are configured. Default: MIN (use the smaller watermark for safety). Ignored when only one side has a watermark.
truncate	CutoffTruncate	Truncate the combined watermark to a time boundary. Example: HOUR truncates 08:47:12 to 08:00:00. Applied after combining, before offset.
oneof _offset.offset	optional Duration	Time offset applied after truncation. Negative durations subtract from the cutoff (safety buffer). Example: “-30m” shifts the cutoff 30 minutes earlier.
oneof _apply_source.apply_source	optional CutoffApplyConfig	How to apply the cutoff as a WHERE filter on the source side. When not set, uses the source derivation column with ≤ operator.
oneof _apply_target.apply_target	optional CutoffApplyConfig	How to apply the cutoff as a WHERE filter on the target side. When not set, uses the target derivation column with ≤ operator.

CutoffSideConfig

(synq.agent.recon.v1.CutoffSideConfig) CutoffSideConfig configures watermark derivation for one side (source or target). There are two modes:

Column + aggregate (default): auto-generates a watermark query from the dataset. For table-based datasets, queries the table directly (the column does NOT need to be in the reconciliation column list). For query-based datasets, wraps the query as a subquery (the column MUST be in the query’s SELECT list).
Custom query: provide a SQL query that returns a single row with a “watermark” column. Use this when the auto-generated query doesn’t work (e.g., complex joins, custom logic).

After resolution at runtime, the query field is always populated with the actual SQL that was executed, regardless of which mode was used. This ensures the audit log captures the exact query for reproducibility.

Field	Type	Description
column	string	Column to derive the watermark from (e.g., “created_at”, “synced_at”). Required when query is not set.
aggregate	CutoffAggregate	Aggregate function to derive the watermark. Default: MAX. Only used when query is not set.
oneof _query.query	optional string	Custom SQL query for watermark derivation. Must return a single row with a “watermark” column. When not set, auto-generated from the dataset at runtime. After resolution, this field is populated with the actual query that was executed.

BatchReconciliationRunStateRequest

(synq.agent.recon.v1.BatchReconciliationRunStateRequest)

Field	Type	Description
suite_ids	repeated string	none
include_adhoc_children	bool	When true, the response also includes adhoc test runs spawned from the queried suites — i.e. rows whose parent_suite_id matches. Use this for the “development” view where adhoc activity is part of the iteration loop. Production / deployment-centric views leave it false to see only deployment-driven runs.

BatchReconciliationRunStateResponse

(synq.agent.recon.v1.BatchReconciliationRunStateResponse)

Field	Type	Description
states	map StatesEntry	Map keyed by suite_id; suites with no recorded runs are omitted.

BatchReconciliationRunStateResponse.StatesEntry

(synq.agent.recon.v1.BatchReconciliationRunStateResponse.StatesEntry)

Field	Type	Description
key	string	none
value	SuiteRunStates	none

CancelReconciliationRunRequest

(synq.agent.recon.v1.CancelReconciliationRunRequest)

Field	Type	Description
suite_id	string	The suite the run belongs to. Required because run rows are keyed by (workspace, suite_id, run_id) — clients pass the suite_id they already know from the run state listing alongside the run_id.
run_id	string	Run identifier. UUIDv7 returned by BatchReconciliationRunState / ListReconciliationRunState.

CancelReconciliationRunResponse

(synq.agent.recon.v1.CancelReconciliationRunResponse)

Field	Type	Description
state	ReconciliationRunState	The current state of the run after the cancel attempt. Status will be CANCELLED if the run was SCHEDULED/IN_PROGRESS at call time, or unchanged if it had already reached a terminal status.

ListReconciliationRunStateRequest

(synq.agent.recon.v1.ListReconciliationRunStateRequest)

Field	Type	Description
suite_ids	repeated string	Optional filter: limit to these suite_ids. Combined with deployment_ids via OR — a row matches if either list contains it (both empty = no suite/deployment filter).
statuses	repeated ReconciliationRunStatus	Optional filter: only return runs in these statuses. Empty = no status filter.
deployment_ids	repeated string	Optional filter: limit to runs belonging to these deployment_ids. Use this to scope the listing to a single promoted deployment cycle — suite_id alone may overlap multiple deployment_ids when a suite has been promoted, unpromoted, and re-promoted.
oneof _scheduled_after.scheduled_after	optional Timestamp	Only return runs scheduled at or after this timestamp (inclusive).
oneof _scheduled_before.scheduled_before	optional Timestamp	Only return runs scheduled before this timestamp (exclusive).
oneof _pagination.pagination	optional Pagination	Pagination parameters. The cursor encodes (scheduled_at, run_id) and is opaque to clients — pass page_info.next_cursor verbatim.
triggers	repeated ReconciliationRunTrigger	Optional filter: only return runs created via these triggers. Empty = no trigger filter. Use this to separate API-triggered runs from cron-scheduled occurrences from ad-hoc submissions in the listing.
actor_identities	repeated string	Optional filter: limit to runs initiated by these actor identities. Identities use the canonical actor-identity string format defined alongside the public Actor type (e.g. `email:foo@example.com`, `slack:U12345`, `client_id:<id>`). Empty list = no actor filter. Useful for “show only my ad-hoc runs” views — clients construct their own identity from the authenticated user (typically `email:<user-email>`) and pass it here.

ListReconciliationRunStateResponse

(synq.agent.recon.v1.ListReconciliationRunStateResponse)

Field	Type	Description
states	repeated ReconciliationRunState	Sorted newest-first by scheduled_at, then by run_id desc as a stable tiebreaker.
page_info	PageInfo	Pagination info for fetching the next page.

SuiteRunStates

(synq.agent.recon.v1.SuiteRunStates) SuiteRunStates groups the most relevant run rows for a single suite.

Field	Type	Description
oneof _latest_concluded.latest_concluded	optional ReconciliationRunState	Most recent run that has reached a terminal status (SUCCEEDED, FAILED, CANCELLED).
oneof _ongoing.ongoing	optional ReconciliationRunState	Most recent run whose target tick has arrived (scheduled_at ≤ now) and that is still SCHEDULED or IN_PROGRESS. Pre-scheduled future rows are not surfaced here — see `next_run_at` on SuiteDeployment for the upcoming cron occurrence.

AggregateDrillChild

(synq.agent.recon.v1.AggregateDrillChild) AggregateDrillChild represents a single divergent group within a drill-down level.

Field	Type	Description
key	Struct	Group key values (column name -> value).
type	AggregateDivergenceType	Type of divergence.
source_values	map SourceValuesEntry	Source measure values (measure key -> value).
target_values	map TargetValuesEntry	Target measure values (measure key -> value).
differences	MeasureDifferences	All difference variants computed for this group.
threshold_evaluation	ThresholdEvaluation	Threshold evaluation results for this group.
source_query	string	Investigation query for source data.
target_query	string	Investigation query for target data.
drill_down	AggregateDrillNode	Further drill-down into this divergent group.

AggregateDrillChild.SourceValuesEntry

(synq.agent.recon.v1.AggregateDrillChild.SourceValuesEntry)

Field	Type	Description
key	string	none
value	double	none

AggregateDrillChild.TargetValuesEntry

(synq.agent.recon.v1.AggregateDrillChild.TargetValuesEntry)

Field	Type	Description
key	string	none
value	double	none

AggregateDrillNode

(synq.agent.recon.v1.AggregateDrillNode) AggregateDrillNode represents a node in the hierarchical aggregate drill-down tree.

Field	Type	Description
level	int32	Drill-down level (0-based).
group_column	string	Group column used at this level.
total_groups	int32	Total groups at this level.
matched_groups	int32	Number of matched groups at this level.
children	repeated AggregateDrillChild	Divergent children (mismatched or missing groups).

AggregateStageResult

(synq.agent.recon.v1.AggregateStageResult) AggregateStageResult is the result for an aggregate_check stage.

Field	Type	Description
total_groups	int32	Top-level (first group column) total group count. With a multi-level drill-down this is the number of distinct first-level groups, NOT the number of leaf groups. Invariant: total_groups == matched_groups + divergent_groups.
matched_groups	int32	Top-level groups that matched — directly, or because their whole subtree resolved. Same level as total_groups.
mismatch_groups	int32	Leaf-level groups with value differences (deepest drill level). NOT comparable to total_groups: one divergent top-level group can contain many divergent leaves. For a same-level “X of Y diverged” ratio use divergent_groups / total_groups; use these leaf counts for detail.
missing_source	int32	Leaf-level groups present in target but missing in source.
missing_target	int32	Leaf-level groups present in source but missing in target.
match	bool	Overall match result.
early_termination_reason	string	Reason if aggregate check terminated early.
drill_down	AggregateDrillNode	Hierarchical drill-down tree for aggregate comparison.
divergent_groups	int32	Top-level groups that diverged (counterpart of matched_groups, same level as total_groups). This is the same-level numerator for a “divergent_groups of total_groups diverged” summary — unlike the leaf-level mismatch_groups / missing_* counts above, which can exceed total_groups in a multi-level drill.

AuditLog

(synq.agent.recon.v1.AuditLog) AuditLog is the root structure for a reconciliation run audit. It captures all operations performed during a synq-recon reconciliation run.

Field	Type	Description
version	string	Schema version. Must be “1”.
invocation_id	string	Unique identifier for this invocation/run.
oneof _parent_invocation_id.parent_invocation_id	optional string	Invocation ID of the parent run this continues from. Set when this run resumes or drills deeper into a previous run’s results.
suite_name	string	Suite machine identifier (promoted from suite.name).
oneof _suite_title.suite_title	optional string	Human-readable title (promoted from suite.title).
oneof _suite_description.suite_description	optional string	Suite description (promoted from suite.description).
started_at	Timestamp	When the run started.
completed_at	Timestamp	When the run completed.
duration	Duration	Total run duration.
status	AuditStatus	Overall execution status derived from individual reconciliation outcomes.
summary	AuditSummary	Aggregated counts derived from individual reconciliation results.
reconciliations	repeated ReconciliationAudit	Audit records for each reconciliation executed.
meta	AuditMeta	Build and environment metadata for the synq-recon binary.
config_file	string	Path to the configuration file used.
suite	ReconcilationSuite	Full suite configuration snapshot as executed. Contains all reconciliation definitions, variables, thresholds, etc.
resolved_variables	map ResolvedVariablesEntry	Resolved template variable values used for query interpolation. Contains the actual values after template evaluation (e.g. “{{today - 30d}}” resolved to “2026-01-27”).
warnings	repeated string	Suite-level warnings detected during config validation.
total_stats	QueryStats	Aggregated query execution statistics across all queries in this run.
oneof _environment.environment	optional string	Name of the environment used for this run. Empty for direct/unmanaged runs where no environment was applied.
resolved_table_references	map ResolvedTableReferencesEntry	Effective table references after environment overrides were applied. Keyed by “reconciliation_name.source” or “reconciliation_name.target”. Only populated when an environment was active and overrides were applied. The suite field (14) still contains the original pre-override config.

AuditLog.ResolvedTableReferencesEntry

(synq.agent.recon.v1.AuditLog.ResolvedTableReferencesEntry)

Field	Type	Description
key	string	none
value	string	none

AuditLog.ResolvedVariablesEntry

(synq.agent.recon.v1.AuditLog.ResolvedVariablesEntry)

Field	Type	Description
key	string	none
value	string	none

AuditMeta

(synq.agent.recon.v1.AuditMeta) AuditMeta holds build and environment metadata for the synq-recon binary.

Field	Type	Description
version	string	Module version or tag (e.g. v1.2.3).
vcs_commit	string	VCS revision hash.
vcs_time	string	VCS commit timestamp (RFC3339).
vcs_dirty	bool	True if the working tree had uncommitted changes.
go_version	string	Go toolchain version used to build the binary.

AuditSummary

(synq.agent.recon.v1.AuditSummary) AuditSummary holds aggregated counts derived from individual reconciliation results.

Field	Type	Description
overall_match	bool	True when every reconciliation matched (exactly or within threshold). False when any reconciliation failed or had an exceeding mismatch.
total	int32	Total number of reconciliations executed.
matched	int32	Number of reconciliations that completed and matched exactly.
matched_within_threshold	int32	Number of reconciliations that had differences within configured thresholds. These are warning-level outcomes — data differs but within acceptable tolerance.
mismatched	int32	Number of reconciliations that completed but found data differences exceeding thresholds (or no thresholds configured).
failed	int32	Number of reconciliations that encountered an infrastructure error.
errors	repeated string	Error messages collected from failed reconciliations.

BisectionStageResult

(synq.agent.recon.v1.BisectionStageResult) BisectionStageResult is the result for a bisection_drill stage.

Field	Type	Description
total_segments	int32	Total number of segments processed.
mismatch_count	int32	Number of mismatched leaf segments.
error_count	int32	Number of segments that encountered errors.
max_depth	int32	Maximum depth reached in the segment tree.
early_termination_reason	string	Reason if bisection terminated early.
statistics	BisectionStatistics	Detailed tree statistics.
mismatch_leaves	repeated MismatchLeafDetail	Details for each mismatched leaf segment.
investigation_queries	repeated InvestigationQuery	Merged investigation queries for adjacent mismatch regions.

BisectionStatistics

(synq.agent.recon.v1.BisectionStatistics) BisectionStatistics holds statistics about the bisection segment tree.

Field	Type	Description
total_nodes	int32	none
matched_nodes	int32	none
mismatched_nodes	int32	none
leaf_nodes	int32	none
intermediate_nodes	int32	none
matched_leaves	int32	none
mismatched_leaves	int32	none
depth_distribution	map DepthDistributionEntry	Number of segments at each depth level.
mismatch_by_depth	map MismatchByDepthEntry	Number of mismatched segments at each depth level.
per_depth	map PerDepthEntry	Detailed per-depth statistics.
total_source_rows	int64	none
total_target_rows	int64	none
mismatch_source_rows	int64	none
mismatch_target_rows	int64	none

BisectionStatistics.DepthDistributionEntry

(synq.agent.recon.v1.BisectionStatistics.DepthDistributionEntry)

Field	Type	Description
key	int32	none
value	int32	none

BisectionStatistics.MismatchByDepthEntry

(synq.agent.recon.v1.BisectionStatistics.MismatchByDepthEntry)

Field	Type	Description
key	int32	none
value	int32	none

BisectionStatistics.PerDepthEntry

(synq.agent.recon.v1.BisectionStatistics.PerDepthEntry)

Field	Type	Description
key	string	none
value	DepthStats	none

CutoffResult

(synq.agent.recon.v1.CutoffResult) CutoffResult captures the runtime resolution of a cutoff filter. Stored in the audit log to provide full transparency into how the cutoff was derived and applied.

Field	Type	Description
source_watermark	string	Watermark value derived from the source dataset. Empty when cutoff was configured for target-only derivation.
target_watermark	string	Watermark value derived from the target dataset. Empty when cutoff was configured for source-only derivation.
cutoff_value	string	Final cutoff value after combining source/target watermarks and applying truncation and offset transforms.
source_where	string	WHERE clause applied to the source query.
target_where	string	WHERE clause applied to the target query.

DatasetInfo

(synq.agent.recon.v1.DatasetInfo) DatasetInfo captures runtime information about a source or target dataset.

Field	Type	Description
connection	string	Connection name used.
dialect	string	Database dialect detected at runtime (e.g. “postgres”, “snowflake”).
query	string	Resolved SQL query actually executed (after variable interpolation).

DepthStats

(synq.agent.recon.v1.DepthStats) DepthStats holds per-depth-level statistics for the bisection tree.

Field	Type	Description
total_rows	int64	none
mismatched_rows	int64	none
segments	int32	none
mismatched_segments	int32	none

DiffQueries

(synq.agent.recon.v1.DiffQueries) DiffQueries holds investigation queries for a mismatch leaf.

Field	Type	Description
source_rows	string	SQL query to retrieve source rows in the mismatch segment.
target_rows	string	SQL query to retrieve target rows in the mismatch segment.

InvestigationQuery

(synq.agent.recon.v1.InvestigationQuery) InvestigationQuery represents a merged diff query covering one or more adjacent mismatch leaves.

Field	Type	Description
min_key	Value	Minimum key (inclusive).
max_key	Value	Maximum key (exclusive).
time_bucket	string	Time bucket label (for time-based segmentation).
leaves_covered	int32	Number of mismatch leaves covered by this query.
source_query	string	SQL query to retrieve source rows.
target_query	string	SQL query to retrieve target rows.

MeasureDifferences

(synq.agent.recon.v1.MeasureDifferences) MeasureDifferences holds all difference variants for measure comparisons.

Field	Type	Description
relative	map RelativeEntry	Relative difference per measure (target - source). Positive means target is larger.
absolute	map AbsoluteEntry	Absolute difference per measure:	target - source	.
pct_vs_source	map PctVsSourceEntry	Percentage difference relative to source:	diff	/	source	.
pct_vs_target	map PctVsTargetEntry	Percentage difference relative to target:	diff	/	target	.
pct_symmetric	map PctSymmetricEntry	Symmetric percentage difference: 2*	diff	/ (	source	+	target	).

MeasureDifferences.AbsoluteEntry

(synq.agent.recon.v1.MeasureDifferences.AbsoluteEntry)

Field	Type	Description
key	string	none
value	double	none

MeasureDifferences.PctSymmetricEntry

(synq.agent.recon.v1.MeasureDifferences.PctSymmetricEntry)

Field	Type	Description
key	string	none
value	double	none

MeasureDifferences.PctVsSourceEntry

(synq.agent.recon.v1.MeasureDifferences.PctVsSourceEntry)

Field	Type	Description
key	string	none
value	double	none

MeasureDifferences.PctVsTargetEntry

(synq.agent.recon.v1.MeasureDifferences.PctVsTargetEntry)

Field	Type	Description
key	string	none
value	double	none

MeasureDifferences.RelativeEntry

(synq.agent.recon.v1.MeasureDifferences.RelativeEntry)

Field	Type	Description
key	string	none
value	double	none

MeasureVerdict

(synq.agent.recon.v1.MeasureVerdict) MeasureVerdict captures the threshold evaluation result for a single measure.

Field	Type	Description
exceeded	bool	True when the measure difference exceeds all configured thresholds.
reason	MeasureVerdictReason	Explains why the measure was considered within or outside thresholds.
effective_absolute	double	Absolute threshold applied to this measure (may differ via per_measure config).
effective_percentage	double	Percentage threshold applied to this measure.
effective_percentage_mode	string	Percentage mode applied to this measure.

MismatchLeafDetail

(synq.agent.recon.v1.MismatchLeafDetail) MismatchLeafDetail holds detailed information about a single mismatch leaf.

Field	Type	Description
segment	SegmentInfo	Segment boundaries.
source_count	int64	none
target_count	int64	none
source_checksum	int64	none
target_checksum	int64	none
count_difference	int64	none
mismatch_types	repeated MismatchType	Types of mismatch detected.
termination_reason	TerminationReason	Why bisection stopped at this leaf.
diff_queries	DiffQueries	Investigation queries to inspect this mismatch.
row_mismatches	repeated RowMismatchDetail	Per-row mismatch details (when reporting level allows).
row_mismatch_count	int32	Total number of row mismatches (may exceed row_mismatches length due to sample_limit).

Normalization

(synq.agent.recon.v1.Normalization) Normalization records the column expressions used after cross-DB type alignment.

Field	Type	Description
source_columns	repeated string	Source column expressions after normalization.
target_columns	repeated string	Target column expressions after normalization.

QueryRecord

(synq.agent.recon.v1.QueryRecord) QueryRecord captures a single SQL query execution.

Field	Type	Description
id	string	Unique query identifier within this run.
role	QueryRole	Whether this query ran against source or target.
connection	string	Connection name used.
dialect	string	Database dialect.
sql	string	SQL query text.
started_at	Timestamp	When the query started.
duration	Duration	Query execution duration.
rows_returned	int32	Number of result rows returned.
error	string	Error message if the query failed.
retry_attempt	int32	Retry attempt number (0 for first attempt).
stats	QueryStats	Execution statistics collected from the database driver.

QueryStats

(synq.agent.recon.v1.QueryStats) QueryStats holds execution statistics collected from the database driver. Fields are optional — absent means the metric is not available for the driver.

Field	Type	Description
query_id	string	Database-assigned query identifier for auditing. Available for BigQuery (job ID), Snowflake, ClickHouse.
oneof _rows_read.rows_read	optional int64	Number of rows read/scanned by the query engine.
oneof _bytes_read.bytes_read	optional int64	Number of bytes read/scanned by the query engine.
oneof _rows_produced.rows_produced	optional int64	Number of result rows returned to the caller.
oneof _cache_hit.cache_hit	optional bool	Whether the query result was served from cache.
oneof _bytes_billed.bytes_billed	optional int64	Number of bytes billed (BigQuery).
oneof _slot_millis.slot_millis	optional int64	Slot time consumed (BigQuery).
oneof _blocks.blocks	optional int64	Number of data blocks read (ClickHouse).
oneof _completed_splits.completed_splits	optional int64	Number of completed splits (Trino).
oneof _cpu_time_millis.cpu_time_millis	optional int64	CPU time consumed (Trino).
oneof _wall_time_millis.wall_time_millis	optional int64	Wall time reported by the engine (Trino).

QuickCheckStageResult

(synq.agent.recon.v1.QuickCheckStageResult) QuickCheckStageResult is the result for a quick_check stage.

Field	Type	Description
source_count	int64	none
target_count	int64	none
source_checksum	int64	none
target_checksum	int64	none
match	bool	none
count_difference	int64	none
error	string	none

ReconciliationAudit

(synq.agent.recon.v1.ReconciliationAudit) ReconciliationAudit captures the configuration and runtime execution data for a single reconciliation.

Field	Type	Description
reconcilation	Reconcilation	The reconciliation configuration as executed.
source	DatasetInfo	Runtime dataset information (resolved queries, detected dialects).
target	DatasetInfo	none
original_source_query	string	Source query before variable interpolation (differs from suite query when variables are used).
original_target_query	string	Target query before variable interpolation.
columns	repeated string	Column names discovered at runtime via QueryShape.
normalization	Normalization	Column normalization expressions applied after cross-DB type alignment.
stages	repeated StageAudit	Execution stages (quick_check, bisection_drill, aggregate_check).
warnings	repeated string	Per-reconciliation warnings.
status	ReconciliationStatus	Outcome status of this reconciliation. Distinguishes infrastructure errors from data mismatches and threshold-based outcomes.
overall_match	bool	Whether source and target matched overall. True when data matched exactly or differences were within configured thresholds.
error	string	Error message if the reconciliation failed due to an infrastructure error.
oneof _cutoff_result.cutoff_result	optional CutoffResult	Cutoff resolution details (when cutoff was configured). Captures the derived watermark values, final cutoff, and WHERE clauses so the run can be fully understood and reproduced.

RowMismatchAudit

(synq.agent.recon.v1.RowMismatchAudit) RowMismatchAudit captures a single row-level mismatch in the segment tree.

Field	Type	Description
pk	Value	Primary key value.
type	RowMismatchType	Type of row mismatch.
oneof _source_row_hash.source_row_hash	optional int64	Source row hash (when available).
oneof _target_row_hash.target_row_hash	optional int64	Target row hash (when available).
source_values	map SourceValuesEntry	Source column values (detailed reporting only).
target_values	map TargetValuesEntry	Target column values (detailed reporting only).

RowMismatchAudit.SourceValuesEntry

(synq.agent.recon.v1.RowMismatchAudit.SourceValuesEntry)

Field	Type	Description
key	string	none
value	string	none

RowMismatchAudit.TargetValuesEntry

(synq.agent.recon.v1.RowMismatchAudit.TargetValuesEntry)

Field	Type	Description
key	string	none
value	string	none

RowMismatchDetail

(synq.agent.recon.v1.RowMismatchDetail) RowMismatchDetail holds per-row mismatch detail.

Field	Type	Description
pk	Value	Primary key value.
type	RowMismatchType	Type of row mismatch.
oneof _source_row_hash.source_row_hash	optional int64	Source row hash (when available).
oneof _target_row_hash.target_row_hash	optional int64	Target row hash (when available).

SegmentAuditNode

(synq.agent.recon.v1.SegmentAuditNode) SegmentAuditNode represents a node in the bisection segment tree.

Field	Type	Description
segment	SegmentInfo	Segment boundaries.
source_count	int64	none
target_count	int64	none
source_checksum	int64	none
target_checksum	int64	none
match	bool	Whether source and target matched for this segment.
is_leaf	bool	Whether this is a leaf node (no further splitting).
termination_reason	TerminationReason	Why bisection stopped at this node.
mismatch_rows_in_subtree	int64	Sum of mismatched rows in this subtree.
total_rows_in_subtree	int64	Sum of all rows in this subtree.
query_ids	repeated string	References to QueryRecord.id values for queries that populated this node.
children	repeated SegmentAuditNode	Child segments (empty for leaf nodes).
row_mismatches	repeated RowMismatchAudit	Row-level mismatches (only for leaf nodes with detailed reporting).

SegmentInfo

(synq.agent.recon.v1.SegmentInfo) SegmentInfo identifies a key range segment.

Field	Type	Description
min_key	Value	Minimum key (inclusive). Unset means unbounded.
max_key	Value	Maximum key (exclusive). Unset means unbounded.
depth	int32	Depth in the bisection tree.
index	int32	Index within the depth level.
time_bucket	string	Time bucket label (for time-based segmentation).

StageAudit

(synq.agent.recon.v1.StageAudit) StageAudit captures one reconciliation stage execution.

Field	Type	Description
stage	StageType	Stage type.
started_at	Timestamp	When the stage started.
completed_at	Timestamp	When the stage completed.
duration	Duration	Stage duration.
queries	repeated QueryRecord	SQL queries executed during this stage.
segment_tree	SegmentAuditNode	Bisection segment tree (only for bisection_drill stage).
oneof result.quick_check_result	QuickCheckStageResult	Result for quick_check stage.
oneof result.bisection_result	BisectionStageResult	Result for bisection_drill stage.
oneof result.aggregate_result	AggregateStageResult	Result for aggregate_check stage.

ThresholdEvaluation

(synq.agent.recon.v1.ThresholdEvaluation) ThresholdEvaluation captures the effective thresholds applied and per-measure verdicts.

Field	Type	Description
absolute_threshold	double	Configured maximum absolute difference, or 0 if not set.
percentage_threshold	double	Configured maximum percentage difference, or 0 if not set.
percentage_mode	string	Which percentage formula was used.
measures	map MeasuresEntry	Per-measure threshold evaluation results.

ThresholdEvaluation.MeasuresEntry

(synq.agent.recon.v1.ThresholdEvaluation.MeasuresEntry)

Field	Type	Description
key	string	none
value	MeasureVerdict	none

AcceptPromptSuggestionRequest

(synq.agent.sre.v1.AcceptPromptSuggestionRequest)

Field	Type	Description
id	string	none
oneof _edited_value.edited_value	optional string	If set, the user edited the suggestion before accepting. The server records both `suggested_value` (unchanged) and `applied_value` (= `edited_value`). Hard-capped at 16384 bytes to match the SRE agent prompt field limits.
oneof _note.note	optional string	Optional short free-text note recorded with the decision. Capped at 512 bytes — it is a one-line annotation for the audit trail, not a place to restate the prompt.

AcceptPromptSuggestionResponse

(synq.agent.sre.v1.AcceptPromptSuggestionResponse)

Field	Type	Description
suggestion	PromptSuggestion	none

AgentTask

(synq.agent.sre.v1.AgentTask)

Field	Type	Description
task_id	string	none
created_at	Timestamp	none
oneof _deadline_at.deadline_at	optional Timestamp	Deadline after which the task should not be processed. If set, the agent should skip or abort tasks past this time.
oneof task.triage	TriageTask	none
oneof task.suggest_tests	SuggestTestsTask	none
oneof task.evaluate	EvaluateTask	none

AgentTaskResponse

(synq.agent.sre.v1.AgentTaskResponse)

Field	Type	Description
task_id	string	none
message	string	Human visible message
oneof _error.error	optional string	Error message indicating a problem
oneof result.evaluate_response	EvaluateResponse	none

ConnectRequest

(synq.agent.sre.v1.ConnectRequest)

Field	Type	Description
oneof message.hello	Hello	none
oneof message.task_response	AgentTaskResponse	none

ConnectResponse

(synq.agent.sre.v1.ConnectResponse)

Field	Type	Description
tasks	repeated AgentTask	none

DismissPromptSuggestionRequest

(synq.agent.sre.v1.DismissPromptSuggestionRequest)

Field	Type	Description
id	string	none
oneof _reason.reason	optional string	Optional short free-text reason recorded with the decision. Capped at 512 bytes — a one-line justification for the audit trail.

DismissPromptSuggestionResponse

(synq.agent.sre.v1.DismissPromptSuggestionResponse)

Field	Type	Description
suggestion	PromptSuggestion	none

DwhConnection

(synq.agent.sre.v1.DwhConnection)

Field	Type	Description
connection_id	string	This will be connection in the agent or integration_id when managed
instance	string	What is the instance of this, e.g. BigQuery project or Databricks workspace
type	string	Type of the DWH connection
databases	repeated string	Databases in this instance, this would be BigQuery dataset or Databricks catalog
parameters	map ParametersEntry	Extra parameters present on the connection
agent_access_enabled	bool	Indicates that Coalesce Quality managed agent can access this connection

DwhConnection.ParametersEntry

(synq.agent.sre.v1.DwhConnection.ParametersEntry)

Field	Type	Description
key	string	none
value	string	none

EvaluateTask

(synq.agent.sre.v1.EvaluateTask) Task to evaluate an LLM request on the agent side (for self-hosted agents).

Field	Type	Description
request	EvaluateRequest	The evaluate request to be processed by the agent’s local LLM.

GetConfigRequest

(synq.agent.sre.v1.GetConfigRequest)

GetConfigResponse

(synq.agent.sre.v1.GetConfigResponse)

Field	Type	Description
workspace	string	Workspace to which agent is authenticated
triage_system_prompt	string	Extra instructions used while triaging and concluding issues.
tester_system_prompt	string	Extra instructions used while suggesting tests.
workspace_system_prompt	string	Extra instructions describing workspace to which agent is connected.
synq_dwh_connections	repeated DwhConnection	Description of all DWH connections/integrations configured in Coalesce Quality. Will indicate to the agent that it can’t access all the data sources if agent has no connections enabled.
issue_grouping_system_prompt	string	Extra instructions describing how issues should be grouped
issue_grouping_disabled	bool	Indicates that SRE shouldn’t group any issues

Hello

(synq.agent.sre.v1.Hello)

Field	Type	Description
name	string	none
build_version	string	none

ListPromptSuggestionsRequest

(synq.agent.sre.v1.ListPromptSuggestionsRequest)

Field	Type	Description
fields	repeated PromptField	Empty = include all fields.
statuses	repeated PromptSuggestionStatus	Empty = pending only.

ListPromptSuggestionsResponse

(synq.agent.sre.v1.ListPromptSuggestionsResponse)

Field	Type	Description
suggestions	repeated PromptSuggestion	none

PromptSuggestion

(synq.agent.sre.v1.PromptSuggestion)

Field	Type	Description
id	string	Server-assigned UUID.
workspace	string	Workspace the suggestion belongs to. Always populated, always matches the caller’s workspace for customer-facing reads.
field	PromptField	none
status	PromptSuggestionStatus	none
baseline_value	string	Value of the targeted prompt field as it was at the moment the suggestion was produced. Used to detect drift on Accept.
suggested_value	string	Value proposed by the analyser. A full replacement for the targeted prompt; diffed against `baseline_value` in the review UI (see the producer guidance on `RecordPromptSuggestionRequest.suggested_value`).
rationale	string	Short markdown explanation produced by the analyser (≤ 2048 bytes), rendered as a “why” callout above the diff in the review UI.
evidence_json	bytes	Opaque JSON encoded by the producer (e.g. references to source entities and incidents). Returned only to producer-scoped callers; customer reads see an empty value.
source	string	Producer identifier + version, e.g. `"offline_audit_v1"`.
produced_at	Timestamp	none
reviewed_by	string	Identity of whoever reviewed the suggestion (derived from the JWT actor). Empty while the suggestion is pending.
reviewed_at	Timestamp	none
decision_note	string	Optional short reason on dismiss, or note on accept (≤ 512 bytes). A one-line annotation captured for the audit trail.
applied_value	string	Value actually written to the prompt field. Differs from `suggested_value` when the user edited before accepting.

RecordPromptSuggestionRequest

(synq.agent.sre.v1.RecordPromptSuggestionRequest)

Field	Type	Description
field	PromptField	Targets the workspace from the JWT (back-office producers select the workspace via the standard x-synq-workspace-override header).
oneof _suggested_value.suggested_value	optional string	Full replacement value for the targeted prompt field, hard-capped at 16384 bytes to match the SRE agent prompt field limit.

Explicit-presence (optional) so the field can carry an empty string with meaning. An empty value is a deliberate proposal to REMOVE the prompt entirely (clear the override back to the built-in default), distinct from omitting the field. Use this when a customised prompt is judged counter-productive and the workspace is better off with no override at all. required is intentionally NOT set: that rule rejects the empty string, which would make a removal proposal un-expressible. Presence (the field must be set at all) is enforced by the handler via a nil check, so an omitted field is still rejected while an explicit "" is accepted. Producer guidance — propose the smallest change that achieves the goal. Start from the current prompt value and append, delete, or rewrite only the relevant section; do not regenerate the whole prompt from scratch. The reviewer is shown a Current-vs-Suggested diff, so a surgical edit is far easier to approve than a wholesale rewrite that rewords every line. Keep individual lines short and break content into paragraphs separated by newlines instead of collapsing everything onto one long line. The review UI diffs line by line, so well-broken text produces a readable, minimal diff; a single monster line shows up as one giant replaced block. | | rationale | string | Short markdown explanation of why the change is proposed, capped at 2048 bytes. Shown to the reviewer as a “why” callout above the diff, so keep it to a few tight sentences or bullet points — it justifies the change, it does not restate the prompt. As with suggested_value, prefer short lines / paragraphs over one long line. | | evidence_json | bytes | Opaque JSON: structured pointers the analyser used to produce the suggestion (top entities, sample issues, etc.). Stored verbatim for traceability. | | source | string | Producer identifier + version, e.g. "offline_audit_v1". A short slug, not free text — capped at 128 bytes. |

RecordPromptSuggestionResponse

(synq.agent.sre.v1.RecordPromptSuggestionResponse)

Field	Type	Description
suggestion	PromptSuggestion	Empty when the live baseline already matches `suggested_value` (no-op).

SuggestTestsTask

(synq.agent.sre.v1.SuggestTestsTask)

Field	Type	Description
entity_ids	repeated Identifier	none

TriageTask

(synq.agent.sre.v1.TriageTask)

Field	Type	Description
issue_ids	repeated string	none

EvaluateRequest

(synq.agent.sre.v1.EvaluateRequest) Request to evaluate an LLM request with structured output.

Field	Type	Description
output_schema	Struct	JSON schema defining the structure of the expected output. The LLM will produce output conforming to this schema.
system_prompt	string	Main system prompt providing instructions to the LLM. This should be constant as it will be cached for efficiency.
messages	repeated Message	History of messages in the conversation. Must contain at least one message. The last message is used as the final request to the LLM.
model_type	ModelType	Type of model to use for the evaluation. Defaults to MODEL_TYPE_SUMMARY if not specified or set to MODEL_TYPE_UNSPECIFIED.

EvaluateResponse

(synq.agent.sre.v1.EvaluateResponse) Response from the LLM evaluation.

Field	Type	Description
output	Struct	Structured output from the LLM conforming to the provided schema.
metrics	LlmResponseMetrics	Metrics about the LLM response.

LlmResponseMetrics

(synq.agent.sre.v1.LlmResponseMetrics) Metrics about the LLM response.

Field	Type	Description
input_tokens	int32	Number of tokens in the input prompt and messages.
output_tokens	int32	Number of tokens in the generated output.
total_tokens	int32	Total number of tokens used (input + output).
latency_ms	int64	Time taken to generate the response in milliseconds.
model	string	Model identifier used for the evaluation.
cache_write_tokens	int32	Number of tokens written to the prompt cache.
cache_read_tokens	int32	Number of tokens read from the prompt cache.

Message

(synq.agent.sre.v1.Message) A single message in the conversation history.

Field	Type	Description
role	MessageRole	Role of the message author.
content	string	Content of the message.

BatchLatestConclusionsRequest

(synq.agent.sre.v1.BatchLatestConclusionsRequest)

Field	Type	Description
issue_ids	repeated string	List of issue IDs for which latest conclusion should be returned.

BatchLatestConclusionsResponse

(synq.agent.sre.v1.BatchLatestConclusionsResponse)

Field	Type	Description
conclusions	repeated IssueConclusionWithEvidence	none

BatchTriageStateRequest

(synq.agent.sre.v1.BatchTriageStateRequest)

Field	Type	Description
issue_ids	repeated string	List of issue IDs for which triage status should be returned.

BatchTriageStateResponse

(synq.agent.sre.v1.BatchTriageStateResponse)

Field	Type	Description
states	map StatesEntry	none

BatchTriageStateResponse.StatesEntry

(synq.agent.sre.v1.BatchTriageStateResponse.StatesEntry)

Field	Type	Description
key	string	none
value	IssueTriageState	none

ConcludeRequest

(synq.agent.sre.v1.ConcludeRequest) Request to conclude the triage investigation for one or more issues.

Field	Type	Description
session_id	string	Unique identifier of the triaging session, used to group related operations.
conclusion	IssueConclusion	IssueConclusion represents the final determination made by the LLM agent about an issue. Each conclusion type must be supported by appropriate evidence collected during investigation.
evidence	repeated EvidenceItem	Collection of evidence items supporting the conclusion. Evidences previously recorded should not be added here.

ConcludeResponse

(synq.agent.sre.v1.ConcludeResponse) Response for the Conclude operation. Empty as the operation is fire-and-forget.

ListTriageStateRequest

(synq.agent.sre.v1.ListTriageStateRequest)

Field	Type	Description
statuses	repeated IssueTriageStatus	none

ListTriageStateResponse

(synq.agent.sre.v1.ListTriageStateResponse)

Field	Type	Description
states	repeated IssueTriageState	none

MarkAsInProgressRequest

(synq.agent.sre.v1.MarkAsInProgressRequest)

Field	Type	Description
issue_ids	repeated string	List of issue IDs for which work has started.

MarkAsInProgressResponse

(synq.agent.sre.v1.MarkAsInProgressResponse)

Field	Type	Description
marked_issue_ids	repeated string	none

MarkFailedRequest

(synq.agent.sre.v1.MarkFailedRequest)

Field	Type	Description
issue_ids	repeated string	List of issue IDs for which work has failed.
error_message	string	none

MarkFailedResponse

(synq.agent.sre.v1.MarkFailedResponse)

Field	Type	Description
marked_issue_ids	repeated string	none

RecordEvidenceRequest

(synq.agent.sre.v1.RecordEvidenceRequest) Request to record evidence collected during the triage investigation.

Field	Type	Description
session_id	string	Unique identifier of the triaging session, used to group related operations.
evidence	repeated EvidenceItem	Collection of structured evidence items collected during the investigation. Must contain at least one evidence item.

RecordEvidenceResponse

(synq.agent.sre.v1.RecordEvidenceResponse) Response for the RecordEvidence operation. Empty as the operation is fire-and-forget.

AnalysisEvidence

(synq.agent.sre.v1.AnalysisEvidence) AnalysisEvidence contains detailed analysis of the issue based on collected data. This should only be used as a last resort when no other more specialized evidence types (history, root cause, related issues, or changes) could be collected. It provides a comprehensive understanding of the problem and its implications.

Field	Type	Description
analysis	string	Detailed analysis of the issue, including observations, patterns, and potential implications. This should provide clear reasoning for the conclusions drawn.
sql_queries	repeated string	SQL queries which were executed to investigate the issue and collect the evidence.

ChangeEvidence

(synq.agent.sre.v1.ChangeEvidence) ChangeEvidence documents recent changes that may have contributed to the issue. This helps in understanding if the issue is related to recent modifications.

Field	Type	Description
entities	repeated Identifier	List of entities (e.g., services, configurations) that have recently changed and may be related to the current issue.
entities_synq_paths	repeated string	Read-only list of paths matching entities. This is a unique path that can be used to access the entity in the Coalesce Quality UI.
change_description	string	Detailed description of the changes that were detected and their potential impact on the current issue.
change_ids	repeated string	When available identifiers of specific change IDs

CodeChange

(synq.agent.sre.v1.CodeChange) CodeChange represents a specific change in a file within a commit.

Field	Type	Description
file_path	string	Path to the file that was changed.
start_line	int32	Starting line number of the change (inclusive).
end_line	int32	Ending line number of the change (inclusive).
change_description	string	Description of what was changed in this section.

CommitEvidence

(synq.agent.sre.v1.CommitEvidence) CommitEvidence documents code changes that may have contributed to the issue. This helps in understanding if the issue is related to recent code modifications.

Field	Type	Description
change_id	string	ID of the change that introduced the code modifications.
relevant_code_changes	repeated CodeChange	List of relevant code changes in the commit.

DataQueryEvidenceItem

(synq.agent.sre.v1.DataQueryEvidenceItem) DataQueryEvidenceItem represents a single SQL query and its analysis.

Field	Type	Description
query_id	string	DEPRECATED: Previously held the SQL query string despite being named query_id. Use the `sql` field instead. Kept for backward compatibility — readers should prefer `sql` when present, falling back to `query_id` for older evidence.
data_analysis	string	Analysis specific to this query’s results and their implications.
sql	string	The SQL query that was executed.

DataQueryEvidenceV2

(synq.agent.sre.v1.DataQueryEvidenceV2) DataQueryEvidenceV2 contains SQL queries and their analysis results with query IDs. This helps in understanding the issue through data analysis with query tracking.

Field	Type	Description
items	repeated DataQueryEvidenceItem	List of data query evidence items, each containing a query ID and its analysis.

EvidenceItem

(synq.agent.sre.v1.EvidenceItem) EvidenceItem represents a single piece of evidence collected during the triage investigation. Each evidence item must have a title and one of the specific evidence types.

Field	Type	Description
evidence_id	string	Unique identifier of the evidence item.
issue_ids	repeated string	List of issue IDs that should be annotated with the provided evidence. Each ID must be a valid UUID.
title	string	Brief, descriptive title summarizing the type of evidence collected. This helps in quickly understanding the nature of the evidence.
oneof evidence.issue_history	HistoryEvidence	Historical evidence showing similar past issues that may help understand the current situation.
oneof evidence.root_cause	RootCauseEvidence	Evidence pointing to the likely root cause of the issue.
oneof evidence.related_issue	RelatedIssueEvidence	Evidence showing related issues that may be connected to the current investigation.
oneof evidence.change	ChangeEvidence	Evidence of recent changes that may have contributed to the issue.
oneof evidence.analysis	AnalysisEvidence	Evidence containing detailed analysis of the issue. DEPRECATED: This type will be gradually retired in favor of more specific evidence types like DataQueryEvidenceV2 and OtherEvidence. Please use those types for new evidence.
oneof evidence.commit	CommitEvidence	Evidence containing code changes and commit information.
oneof evidence.data_query_v2	DataQueryEvidenceV2	Evidence containing SQL queries and data analysis results with query IDs.
oneof evidence.other	OtherEvidence	Evidence containing general analysis that doesn’t fit into other specialized types.
oneof evidence.impacted_dataproduct	ImpactedDataproductEvidence	Evidence of impact on important dataproduct
oneof evidence.impacted_owner	ImpactedOwnerEvidence	Evidence of serious impact on business owner

HistoryEvidence

(synq.agent.sre.v1.HistoryEvidence) HistoryEvidence represents historical context from similar past issues. This helps in understanding if the current issue is recurring or has known patterns.

Field	Type	Description
issue_ids	repeated string	List of issue IDs that are similar to the currently triaged issue. These historical issues can provide insights into resolution patterns.

ImpactedDataproductEvidence

(synq.agent.sre.v1.ImpactedDataproductEvidence) ImpactedDataproduct documents Data Products that are significantly affected by the issue. This helps in understanding the business impact and prioritizing resolution efforts.

Field	Type	Description
impact_reason	string	Detailed explanation of how and why the dataproduct is impacted by the issue. This should provide clear reasoning for the impact assessment.
dataproduct_ids	repeated string	List of dataproduct IDs that are affected by the issue. These IDs should reference existing dataproducts in the system.

ImpactedOwnerEvidence

(synq.agent.sre.v1.ImpactedOwnerEvidence) ImpactedOwner documents business owners or teams that are seriously affected by the issue. This helps in understanding stakeholder impact and communication requirements.

Field	Type	Description
impact_reason	string	Detailed explanation of how and why the owner is impacted by the issue. This should provide clear reasoning for the impact assessment.
owner_ids	repeated string	List of owner IDs that are affected by the issue. These IDs should reference existing owners or teams in the system.

OtherEvidence

(synq.agent.sre.v1.OtherEvidence) OtherEvidence contains general analysis that doesn’t fit into other specialized evidence types. This should be used when the analysis doesn’t involve SQL queries, code changes, or other specialized evidence types.

Field	Type	Description
analysis	string	Detailed analysis of the issue, including observations, patterns, and potential implications. This should provide clear reasoning for the conclusions drawn.

RelatedIssueEvidence

(synq.agent.sre.v1.RelatedIssueEvidence) RelatedIssueEvidence identifies other issues that may be connected to the current investigation. This helps in understanding broader context and potential dependencies.

Field	Type	Description
issue_ids	repeated string	List of issue IDs that are related to the current investigation. These issues may be symptoms of the same underlying problem or have dependencies.

RootCauseEvidence

(synq.agent.sre.v1.RootCauseEvidence) RootCauseEvidence identifies the likely root cause of the issue being investigated. This helps in understanding the fundamental reason behind the problem.

Field	Type	Description
oneof _issue_id.issue_id	optional string	ID of the issue that is believed to be the root cause of the current issue.
entity_ids	repeated string	IDs of entities that are identified as the root cause.
execution_ids	repeated string	IDs of executions that are identified as the root cause.
analysis	string	Analysis text describing the root cause.

SubmitFeatureRequestRequest

(synq.agent.sre.v1.SubmitFeatureRequestRequest) Request to submit a feature request. Should only be used as a last resort when no existing tool can handle the user’s request.

Field	Type	Description
description	string	A clear description of what the user needs, including context about what they were trying to accomplish and why the current tools are insufficient. This should only be populated when no existing tool can fulfill the request.

SubmitFeatureRequestResponse

(synq.agent.sre.v1.SubmitFeatureRequestResponse) Response for the SubmitFeatureRequest operation.

TestSuggestionState

(synq.agent.sre.v1.TestSuggestionState)

Field	Type	Description
workspace	string	none
path	string	none
identifier	Identifier	none
status	TestSuggestionStatus	none
created_at	Timestamp	none
scheduled_at	Timestamp	none
updated_at	Timestamp	none
oneof _last_user_prompt.last_user_prompt	optional string	none

BatchSuggestionStatesRequest

(synq.agent.sre.v1.BatchSuggestionStatesRequest)

Field	Type	Description
identifiers	repeated Identifier	none

BatchSuggestionStatesResponse

(synq.agent.sre.v1.BatchSuggestionStatesResponse)

Field	Type	Description
test_suggestion_states	repeated TestSuggestionState	none

GetActiveSuggestionStatesForRequest

(synq.agent.sre.v1.GetActiveSuggestionStatesForRequest)

Field	Type	Description
identifiers	repeated Identifier	none

GetActiveSuggestionStatesForResponse

(synq.agent.sre.v1.GetActiveSuggestionStatesForResponse)

Field	Type	Description
test_suggestion_states	repeated TestSuggestionState	none

ListSuggestionStatesRequest

(synq.agent.sre.v1.ListSuggestionStatesRequest)

Field	Type	Description
statuses	repeated TestSuggestionStatus	none

ListSuggestionStatesResponse

(synq.agent.sre.v1.ListSuggestionStatesResponse)

Field	Type	Description
test_suggestion_states	repeated TestSuggestionState	none

MarkAsCancelledRequest

(synq.agent.sre.v1.MarkAsCancelledRequest)

Field	Type	Description
identifiers	repeated Identifier	none

MarkAsCancelledResponse

(synq.agent.sre.v1.MarkAsCancelledResponse)

Field	Type	Description
identifiers	repeated Identifier	none

MarkAsCompletedRequest

(synq.agent.sre.v1.MarkAsCompletedRequest)

Field	Type	Description
identifiers	repeated Identifier	none

MarkAsCompletedResponse

(synq.agent.sre.v1.MarkAsCompletedResponse)

Field	Type	Description
identifiers	repeated Identifier	none

MarkAsFailedRequest

(synq.agent.sre.v1.MarkAsFailedRequest)

Field	Type	Description
identifiers	repeated Identifier	none
error_message	string	none

MarkAsFailedResponse

(synq.agent.sre.v1.MarkAsFailedResponse)

Field	Type	Description
identifiers	repeated Identifier	none

MarkAsRunningRequest

(synq.agent.sre.v1.MarkAsRunningRequest)

Field	Type	Description
identifiers	repeated Identifier	none

MarkAsRunningResponse

(synq.agent.sre.v1.MarkAsRunningResponse)

Field	Type	Description
identifiers	repeated Identifier	none

SuggestForRequest

(synq.agent.sre.v1.SuggestForRequest)

Field	Type	Description
identifiers	repeated Identifier	none
user_prompt	string	none

SuggestForResponse

(synq.agent.sre.v1.SuggestForResponse)

AddToIncidentConclusion

(synq.agent.sre.v1.AddToIncidentConclusion) AddToIncidentConclusion indicates that the issue should be added to an existing incident. This conclusion should be supported by evidence showing the connection to the existing incident.

Field	Type	Description
incident_id	string	ID of the existing incident that this issue should be added to.

DeclareIncidentConclusion

(synq.agent.sre.v1.DeclareIncidentConclusion) DeclareIncidentConclusion indicates that the issue requires immediate attention as an incident. This conclusion should be supported by evidence showing significant impact or risk.

Field	Type	Description
title	string	Suggested title for the incident that will be created. Should be clear and concise to quickly communicate the situation.
description	string	Detailed description of the incident situation, including: - What is happening - Potential impact - Affected systems or services - Any immediate actions needed

IssueConclusion

(synq.agent.sre.v1.IssueConclusion) IssueConclusion represents the final determination made by the LLM agent about an issue. Each conclusion type must be supported by appropriate evidence collected during investigation.

Field	Type	Description
conclusion_id	string	Unique identifier of the conclusion.
issue_ids	repeated string	List of issue IDs that should be concluded with the specified conclusion.
title	string	Brief, single-line description summarizing the triage conclusion. Max 5 words.
summary	string	Detailed markdown-formatted description explaining the conclusion and the reasoning based on all collected evidence.
concluded_at	Timestamp	Timestamp when the conclusion was made.
is_final_conclusion	bool	Indicates that this is final conclusion and SRE agent won’t change it unless new evidence is provided to change it.
oneof conclusion.set_expected	SetExpectedConclusion	Conclusion that the issue is expected behavior.
oneof conclusion.set_no_action_needed	SetNoActionNeededConclusion	Conclusion that no action is needed as the issue will resolve itself.
oneof conclusion.set_fixed	SetFixedConclusion	Conclusion that the issue has been fixed and can be closed.
oneof conclusion.declare_incident	DeclareIncidentConclusion	Conclusion that the issue requires incident declaration.
oneof conclusion.add_to_incident	AddToIncidentConclusion	Conclusion that the issue should be added to an existing incident.
oneof conclusion.request_for_human_review	RequestForHumanReviewConclusion	Conclusion that human review is needed for further investigation.
oneof conclusion.unexplained	UnexplainedConclusion	Conclusion that the issue cannot be explained and needs urgent human attention.

IssueConclusionWithEvidence

(synq.agent.sre.v1.IssueConclusionWithEvidence)

Field	Type	Description
conclusion	IssueConclusion	IssueConclusion represents the final determination made by the LLM agent about an issue.
original_issue_ids	repeated string	List of issues for which original conclusion was created.
evidence	repeated EvidenceItem	Collection of structured evidence items collected during the investigation.
oneof _user_feedback.user_feedback	optional ConclusionFeedback	Optional feedback given by the user on the SRE generated conclusion.

RequestForHumanReviewConclusion

(synq.agent.sre.v1.RequestForHumanReviewConclusion) RequestForHumanReviewConclusion indicates that the issue needs human review. This conclusion should be used when:

The agent has collected some evidence but cannot make a definitive conclusion
The issue requires human judgment or expertise
The impact is unclear or needs human assessment

SetExpectedConclusion

(synq.agent.sre.v1.SetExpectedConclusion) SetExpectedConclusion indicates that the issue is expected behavior and no action is needed. This conclusion should be supported by evidence showing this is normal operation.

SetFixedConclusion

(synq.agent.sre.v1.SetFixedConclusion) SetFixedConclusion indicates that the issue has already been resolved and can be closed. This conclusion should be supported by evidence showing the fix has been applied and verified.

SetNoActionNeededConclusion

(synq.agent.sre.v1.SetNoActionNeededConclusion) SetNoActionNeededConclusion indicates that the issue will resolve itself without intervention. This conclusion should be supported by evidence showing the issue is temporary or self-healing.

UnexplainedConclusion

(synq.agent.sre.v1.UnexplainedConclusion) UnexplainedConclusion indicates that the agent was unable to collect sufficient evidence to understand or explain the issue. This conclusion requires high-priority human review as it may indicate a serious or complex problem that needs immediate attention.

LlmConfig

(synq.agent.sre.v1.LlmConfig)

Field	Type	Description
openai	OpenAIApi	none
triage_parallelism	int32	How many Issue triages can run in parallel
test_suggestions_parallelism	int32	How many test suggestions can be processed in parallel

OpenAIApi

(synq.agent.sre.v1.OpenAIApi)

Field	Type	Description
base_url	string	Base URL of the OpenAPI compatible endpoint
api_key	string	API key to use for the interaction with the API
thinking_model	string	Model to use for complex operations
summary_model	string	Model to use for simpler operations, e.g. summary generation or improving the format of messages.

IssueTriageState

(synq.agent.sre.v1.IssueTriageState) IssueTriageState represents the current state of an issue in the SRE agent’s investigation workflow. This state is used to track the progress of automated triage and coordinate between different parts of the system.

Field	Type	Description
issue_id	string	Unique identifier of the issue being investigated by the SRE agent
status	IssueTriageStatus	Current status of the issue in the triage workflow, indicating the stage of investigation
last_updated_at	Timestamp	Timestamp indicating when the issue triage state was last updated
failure_category	TriageFailureCategory	Structured failure category for the frontend to render appropriate messages, only set when status is FAILED
oneof _failure_details.failure_details	optional string	Raw error details for debugging, only set when status is FAILED. Visible to Coalesce Quality admins.

AcceptFeedback

(synq.agent.sre.v1.AcceptFeedback)

ConclusionFeedback

(synq.agent.sre.v1.ConclusionFeedback)

Field	Type	Description
user	string	none
feedback_at	Timestamp	none
oneof feedback.accept	AcceptFeedback	none
oneof feedback.dismiss	DismissFeedback	none
oneof feedback.retriage	ReTriageFeedback	none

DismissFeedback

(synq.agent.sre.v1.DismissFeedback)

Field	Type	Description
oneof _comment.comment	optional string	none

ReTriageFeedback

(synq.agent.sre.v1.ReTriageFeedback)

Field	Type	Description
instruction	string	none

Config

(synq.agent.sre.v1.Config) Config represents the main configuration for the SRE agent

Field	Type	Description
synq	SYNQ	Coalesce Quality platform configuration
connections	map ConnectionsEntry	Map of connection configurations
llm	LlmConfig	none

Config.ConnectionsEntry

(synq.agent.sre.v1.Config.ConnectionsEntry)

Field	Type	Description
key	string	none
value	Connection	none

SYNQ

(synq.agent.v1.SYNQ) SYNQ contains authentication and connection details for the Coalesce Quality platform

Field	Type	Description
client_id	string	Client ID for OAuth authentication
client_secret	string	Client secret for OAuth authentication
endpoint	string	Coalesce Quality API agent endpoint (host:port)
ingest_endpoint	string	Coalesce Quality API ingest endpoint (host:port)
oauth_url	string	OAuth authentication URL

EmailUser

(synq.users.v1.EmailUser)

Field	Type	Description
user_email	string	none

MsTeamsUser

(synq.users.v1.MsTeamsUser)

Field	Type	Description
member_id	string	none

SlackUser

(synq.users.v1.SlackUser)

Field	Type	Description
user_id	string	none

User

(synq.users.v1.User)

Field	Type	Description
id	string	none
first_name	string	none
last_name	string	none
email	string	none
identities	repeated string	Canonical identity strings for this user. Includes “synq:<user_id>” and all linked aliases (email, slack, msteams). Can be passed to ListIssues(interacted_by_identities) to filter issues this user interacted with.

UserAlias

(synq.users.v1.UserAlias)

Field	Type	Description
user_id	string	none
oneof type.slack	SlackUser	none
oneof type.email	EmailUser	none
oneof type.ms_teams	MsTeamsUser	none

BatchGetUsersRequest

(synq.users.v1.BatchGetUsersRequest)

Field	Type	Description
user_ids	repeated string	none

BatchGetUsersResponse

(synq.users.v1.BatchGetUsersResponse)

Field	Type	Description
users	repeated User	none

DeleteUserAliasesRequest

(synq.users.v1.DeleteUserAliasesRequest)

Field	Type	Description
aliases	repeated UserAlias	none

DeleteUserAliasesResponse

(synq.users.v1.DeleteUserAliasesResponse)

GetByAliasRequest

(synq.users.v1.GetByAliasRequest)

Field	Type	Description
alias	UserAlias	none

GetByAliasResponse

(synq.users.v1.GetByAliasResponse)

Field	Type	Description
user	User	none

GetByEmailRequest

(synq.users.v1.GetByEmailRequest)

Field	Type	Description
email	string	none

GetByEmailResponse

(synq.users.v1.GetByEmailResponse)

Field	Type	Description
user	User	none

GetUserAliasesRequest

(synq.users.v1.GetUserAliasesRequest)

Field	Type	Description
user_id	string	none

GetUserAliasesResponse

(synq.users.v1.GetUserAliasesResponse)

Field	Type	Description
aliases	repeated UserAlias	none

GetUserIdentitiesRequest

(synq.users.v1.GetUserIdentitiesRequest)

Field	Type	Description
oneof _user_id.user_id	optional string	User ID to resolve identities for. If omitted, uses the currently authenticated user.

GetUserIdentitiesResponse

(synq.users.v1.GetUserIdentitiesResponse)

Field	Type	Description
identities	repeated string	Canonical identity strings for the user. Always includes “synq:<user_id>” and all linked aliases.

ListUsersRequest

(synq.users.v1.ListUsersRequest)

ListUsersResponse

(synq.users.v1.ListUsersResponse)

Field	Type	Description
users	repeated User	none

UpsertUserAliasesRequest

(synq.users.v1.UpsertUserAliasesRequest)

Field	Type	Description
aliases	repeated UserAlias	none

UpsertUserAliasesResponse

(synq.users.v1.UpsertUserAliasesResponse)

DatacheckResult

(synq.datachecks.v1.DatacheckResult) Result from a single datacheck execution.

Field	Type	Description
status	DatacheckStatus	none
message	string	none
sql_test_result	SqlTestResult	none
monitor_result	MonitorResult	none

MonitorPrediction

(synq.datachecks.v1.MonitorPrediction)

Field	Type	Description
status	DatacheckStatus	none
message	string	none
value	double	none
expected	double	none
field	string	none
segment	string	none

MonitorResult

(synq.datachecks.v1.MonitorResult) Result of a monitor execution.

Field	Type	Description
monitor_id	string	The monitor ID that was executed.
monitor_name	string	none
monitor_path	string	none
metrics_version	int32	none
entity_id	Identifier	The entity that was monitored.
execution_id	string	Execution ID that can be used to retrieve detailed audit information.
executed_at	Timestamp	Timestamp when the monitor was executed.
predictions	repeated MonitorPrediction	Individual segment predictions.

SqlTestResult

(synq.datachecks.v1.SqlTestResult) Result of a SQL test execution.

Field	Type	Description
sql_test_id	string	The SQL test ID that was executed.
entity_ids	repeated Identifier	The entities that the test was executed on.
rows_count	int32	Number of rows returned by the test query. For a passing test, this should typically be 0 (no violations found).
execution_id	string	Execution ID that can be used to retrieve detailed audit information.
executed_at	Timestamp	Timestamp when the test was executed.
error_message	string	Optional error message if the execution failed.
result_data	string	Optional result data or sample rows from the test execution.

TriggerDatachecksRequest

(synq.datachecks.v1.TriggerDatachecksRequest)

Field	Type	Description
entity_ids	repeated Identifier	List of entity identifiers to trigger datachecks for.

TriggerDatachecksResponse

(synq.datachecks.v1.TriggerDatachecksResponse)

Field	Type	Description
results	repeated DatacheckResult	Results from all datacheck executions.

AcceptedValuesTest

(synq.datachecks.testsuggestions.v1.AcceptedValuesTest)

Field	Type	Description
column_name	string	Name of the column to validate
accepted_values	repeated string	List of allowed values for the column

BusinessRuleTest

(synq.datachecks.testsuggestions.v1.BusinessRuleTest)

Field	Type	Description
sql_expression	string	SQL expression that should evaluate to TRUE for valid records

CountDistinctTest

(synq.datachecks.testsuggestions.v1.CountDistinctTest)

Field	Type	Description
column_names	repeated string	List of columns to count distinct combinations

CountDuplicatesTest

(synq.datachecks.testsuggestions.v1.CountDuplicatesTest)

Field	Type	Description
column_names	repeated string	List of columns to check for duplicate combinations

EmptyTest

(synq.datachecks.testsuggestions.v1.EmptyTest)

Field	Type	Description
column_names	repeated string	List of column names to check for empty values

FreshnessTest

(synq.datachecks.testsuggestions.v1.FreshnessTest)

Field	Type	Description
time_partition_column_name	string	Name of the timestamp column used for freshness check
time_window_seconds	int64	Time window for freshness check (in seconds)

MaxValueTest

(synq.datachecks.testsuggestions.v1.MaxValueTest)

Field	Type	Description
column_name	string	Name of the numeric column to validate
max_value	double	Maximum allowed value (inclusive)
strictly	bool	If true, the maximum value is exclusive

MinMaxTest

(synq.datachecks.testsuggestions.v1.MinMaxTest)

Field	Type	Description
column_name	string	Name of the numeric column to validate
min_value	double	Minimum allowed value (inclusive)
max_value	double	Maximum allowed value (inclusive)
strictly	bool	If true, bounds are exclusive

MinValueTest

(synq.datachecks.testsuggestions.v1.MinValueTest)

Field	Type	Description
column_name	string	Name of the numeric column to validate
min_value	double	Minimum allowed value (inclusive)
strictly	bool	If true, the minimum value is exclusive

NotNullTest

(synq.datachecks.testsuggestions.v1.NotNullTest)

Field	Type	Description
column_names	repeated string	List of column names to check for NULL values

RejectedValuesTest

(synq.datachecks.testsuggestions.v1.RejectedValuesTest)

Field	Type	Description
column_name	string	Name of the column to validate
rejected_values	repeated string	List of disallowed values for the column

RelativeTimeTest

(synq.datachecks.testsuggestions.v1.RelativeTimeTest)

Field	Type	Description
column_name	string	Name of the first time column to compare
relative_column_name	string	Name of the second time column that should be later than the first

RowCountTest

(synq.datachecks.testsuggestions.v1.RowCountTest)

TestSuggestion

(synq.datachecks.testsuggestions.v1.TestSuggestion) Test types that can be suggested

Field	Type	Description
identifier	Identifier	none
explanation	string	none
oneof _entity_synq_path.entity_synq_path	optional string	Read-only path of matched entity. This is a unique path that can be used to access the entity in the Coalesce Quality UI.
oneof _id.id	optional string	Read-only Coalesce Quality ID of matched entity. This is a unique ID that can be used to access the entity in the Coalesce Quality UI.
oneof test.not_null_test	NotNullTest	Checks if specified columns contain no NULL values (e.g., user_id should never be null)
oneof test.empty_test	EmptyTest	Checks if specified columns contain empty values (e.g., description field can be empty)
oneof test.accepted_values_test	AcceptedValuesTest	Validates that column values are within an allowed set (e.g., status in [‘active’, ‘inactive’, ‘pending’])
oneof test.rejected_values_test	RejectedValuesTest	Validates that column values are not in a forbidden set (e.g., country not in [‘UNKNOWN’, ‘TEST’])
oneof test.unique_test	UniqueTest	Ensures specified columns form a unique key combination (e.g., order_id is unique)
oneof test.freshness_test	FreshnessTest	Checks if data is up-to-date based on a time column (e.g., latest event_timestamp within 24h)
oneof test.row_count_test	RowCountTest	Deprecated: Validates the total number of rows in a table (e.g., orders table should have records)
oneof test.min_max_test	MinMaxTest	Validates numeric values are within specified range (e.g., price between 0 and 1000)
oneof test.relative_time_test	RelativeTimeTest	Compares time-based columns for logical order (e.g., start_date before end_date)
oneof test.business_rule_test	BusinessRuleTest	Custom SQL-based business logic validation (e.g., total_amount = subtotal + tax)
oneof test.min_value_test	MinValueTest	Validates numeric values are greater than or equal to a minimum value (e.g., price >= 0)
oneof test.max_value_test	MaxValueTest	Validates numeric values are less than or equal to a maximum value (e.g., price <= 1000)

UniqueTest

(synq.datachecks.testsuggestions.v1.UniqueTest)

Field	Type	Description
column_names	repeated string	List of columns that should form a unique combination
time_partition_column_name	string	If provided, the check will be applied to the time window of the time partition column If not provided, the check will be applied to all rows
time_window_seconds	int64	Time window for uniqueness check (in seconds)

BatchAcceptTestSuggestionsRequest

(synq.datachecks.testsuggestions.v1.BatchAcceptTestSuggestionsRequest)

Field	Type	Description
ids	repeated string	none
recurrence_rule	string	Recurrence rule for the execution schedule of the SqlTest.
annotations	repeated Annotation	Annotations for the given test.These help filter the tests for later operations like listing by API, selection in UI, analytics, etc.
save_failures	bool	Boolean flag to to toggle saving of failure runs.

BatchAcceptTestSuggestionsResponse

(synq.datachecks.testsuggestions.v1.BatchAcceptTestSuggestionsResponse)

Field	Type	Description
identifiers	repeated Identifier	Identifiers of created tests.

BatchCreateTestSuggestionsRequest

(synq.datachecks.testsuggestions.v1.BatchCreateTestSuggestionsRequest)

Field	Type	Description
suggestions	repeated TestSuggestion	none

BatchCreateTestSuggestionsResponse

(synq.datachecks.testsuggestions.v1.BatchCreateTestSuggestionsResponse)

BatchGetTestSuggestionsForEntitiesRequest

(synq.datachecks.testsuggestions.v1.BatchGetTestSuggestionsForEntitiesRequest)

Field	Type	Description
identifiers	repeated Identifier	none

BatchGetTestSuggestionsForEntitiesResponse

(synq.datachecks.testsuggestions.v1.BatchGetTestSuggestionsForEntitiesResponse)

Field	Type	Description
suggestions	repeated TestSuggestion	none

BatchRejectTestSuggestionsRequest

(synq.datachecks.testsuggestions.v1.BatchRejectTestSuggestionsRequest)

Field	Type	Description
ids	repeated string	none
oneof _reason.reason	optional string	none

BatchRejectTestSuggestionsResponse

(synq.datachecks.testsuggestions.v1.BatchRejectTestSuggestionsResponse)

AcceptedValuesTest

(synq.datachecks.sqltests.v1.AcceptedValuesTest)

Field	Type	Description
column_name	string	Name of the column to validate
accepted_values	repeated SqlValue	List of allowed values for the column
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

BusinessQueryTest

(synq.datachecks.sqltests.v1.BusinessQueryTest)

Field	Type	Description
sql_query	string	Full SELECT statement. Result rows are reported as failures.

Format: a single SELECT (CTEs allowed); no semicolon. May read any tables the integration has access to. The engine wraps it as WITH raw_query AS (<sql_query>) SELECT * FROM raw_query. Use this when the failure set requires GROUP BY, JOINs, window functions, or other shape that a per-row predicate (BusinessRuleTest) cannot express. Example: SELECT customer_id, SUM(amount) AS total FROM orders WHERE status = ‘paid’ GROUP BY customer_id HAVING SUM(amount) < 0 Template.identifier still anchors the test to a primary table for ownership, alerts, and UI grouping. Note: this test does not expose a select_columns option. The author controls the SELECT shape directly in sql_query. |

BusinessRuleTest

(synq.datachecks.sqltests.v1.BusinessRuleTest)

Field	Type	Description
sql_expression	string	Boolean SQL predicate evaluated per row of the anchor table (Template.identifier); rows where the predicate is TRUE are reported as failures.

Format: a single boolean expression — no SELECT, WITH, or semicolons. References columns on the anchor table. The engine executes it as SELECT * FROM <anchor_table> WHERE <sql_expression>. Example: “total_amount != subtotal + tax” reports rows where totals disagree. Use BusinessQueryTest for SELECT / GROUP BY / multi-table logic. | | select_columns | repeated string | Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned. |

CountDistinctTest

(synq.datachecks.sqltests.v1.CountDistinctTest) Note: this test does not expose a select_columns option. The result is an aggregate count, not a set of failure rows.

Field	Type	Description
column_names	repeated string	List of columns to count distinct combinations

CountDuplicatesTest

(synq.datachecks.sqltests.v1.CountDuplicatesTest) Note: this test does not expose a select_columns option. The result is an aggregate count, not a set of failure rows.

Field	Type	Description
column_names	repeated string	List of columns to check for duplicate combinations

EmptyTest

(synq.datachecks.sqltests.v1.EmptyTest)

Field	Type	Description
column_names	repeated string	List of column names to check for empty values
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

Evaluator

(synq.datachecks.sqltests.v1.Evaluator) Evaluator is a named condition attached to a SqlTest that produces an independent pass/fail signal. A single SqlTest may carry multiple evaluators, each targeting a different concern (nullability, value ranges, row counts, etc.).

Field	Type	Description
id	string	Stable identifier for the evaluator, unique within the parent SqlTest. Must contain only ASCII letters, digits, hyphens, or underscores.
name	string	Human friendly name.
sql_expression	string	SQL expression evaluated against the test rows. The expression is a FAIL condition: a row is flagged when the expression evaluates to TRUE. NULL evaluates as pass (equivalent to FALSE).
severity	Severity	Severity routed to alerting when this evaluator fails. Defaults to the parent SqlTest severity when left unspecified.

EvaluatorResult

(synq.datachecks.sqltests.v1.EvaluatorResult) EvaluatorResult is the execution outcome of a single Evaluator within a SqlTest run. Fields id/name/sql_expression/severity are a snapshot of the evaluator definition at execution time so historical results survive later edits to the test.

Field	Type	Description
id	string	Evaluator id, matching Evaluator.id on the parent SqlTest.
name	string	Human-friendly evaluator name at time of execution.
sql_expression	string	SQL expression that was evaluated.
severity	Severity	Severity of this evaluator as configured at execution time.
fail_count	int64	Number of rows that failed this evaluator’s condition.
status	ExecutionStatus	Execution outcome for this evaluator.
message	string	Human-readable result message (e.g. “OK” or “Got 3 failure(s)”).

FreshnessTest

(synq.datachecks.sqltests.v1.FreshnessTest)

Field	Type	Description
time_partition_column_name	string	Name of the timestamp column used for freshness check
time_window_seconds	int64	Time window for freshness check (in seconds)
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

InputTable

(synq.datachecks.sqltests.v1.InputTable) InputTable is a table reference resolved from the SQL expression of a SqlTest.

Field	Type	Description
fqn	Fqn	Fully-qualified name of the referenced table.
table_path	string	Synq-internal path for the table asset (e.g. “bq-prod::project::dataset::table”).

MaxValueTest

(synq.datachecks.sqltests.v1.MaxValueTest)

Field	Type	Description
column_name	string	Name of the numeric column to validate
max_value	SqlValue	Maximum allowed value (inclusive)
strictly	bool	If true, the maximum value is exclusive
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

MinMaxTest

(synq.datachecks.sqltests.v1.MinMaxTest)

Field	Type	Description
column_name	string	Name of the numeric column to validate
min_value	SqlValue	Minimum allowed value (inclusive)
max_value	SqlValue	Maximum allowed value (inclusive)
strictly	bool	If true, bounds are exclusive
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

MinValueTest

(synq.datachecks.sqltests.v1.MinValueTest)

Field	Type	Description
column_name	string	Name of the numeric column to validate
min_value	SqlValue	Minimum allowed value (inclusive)
strictly	bool	If true, the minimum value is exclusive
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

NotNullTest

(synq.datachecks.sqltests.v1.NotNullTest)

Field	Type	Description
column_names	repeated string	List of column names to check for NULL values
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

RejectedValuesTest

(synq.datachecks.sqltests.v1.RejectedValuesTest)

Field	Type	Description
column_name	string	Name of the column to validate
rejected_values	repeated SqlValue	List of disallowed values for the column
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

RelationshipColumn

(synq.datachecks.sqltests.v1.RelationshipColumn)

Field	Type	Description
source	string	Column name in the source table
reference	string	Column name in the reference table

RelationshipReference

(synq.datachecks.sqltests.v1.RelationshipReference)

Field	Type	Description
entity	Identifier	The reference entity (table to check foreign keys against)
columns	repeated RelationshipColumn	Column mappings between source and reference tables

RelationshipsTest

(synq.datachecks.sqltests.v1.RelationshipsTest)

Field	Type	Description
references	repeated RelationshipReference	List of reference table relationships to check
ignore_nulls	bool	If true, source rows where all join columns are NULL are excluded from results
time_partition_column	string	Column name used to filter source rows by time (e.g., “created_at”)
time_window_seconds	int64	Time window in seconds - only check source rows within this window
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

RelativeTimeTest

(synq.datachecks.sqltests.v1.RelativeTimeTest)

Field	Type	Description
column_name	string	Name of the first time column to compare
relative_column_name	string	Name of the second time column that should be later than the first
select_columns	repeated string	Optional list of columns to include in the SELECT clause of the generated SQL. When empty (default), SELECT * is used — all columns are returned.

SqlTest

(synq.datachecks.sqltests.v1.SqlTest) The SqlTest is a SQL test that is executed on a Coalesce Quality entity.

Field	Type	Description
platform	DataPlatformIdentifier	Identifier for the data platform which the SqlTest would be executed on.
id	string	Unique resource identifier for the SqlTest. This is externally maintained and can be used to fetch/update/delete this test.
name	string	Human friendly name.
description	string	Description of purpose and motivation.
severity	Severity	none
sql_expression	string	A valid SQL expression which is the test.
recurrence_rule	string	Recurrence rule for the execution schedule of the SqlTest.
annotations	repeated Annotation	Annotations for the given SqlTest.These help filter the SqlTests for later operations like listing by API, selection in UI, analytics, etc.
save_failures	bool	Boolean flag to to toggle saving of failure runs.
template	Template	Template for the SqlTest. required when sql_expression is not provided
oneof _config_id.config_id	optional string	Config ID for the SqlTest.
source	Source	none
timezone	string	IANA timezone name (e.g., “Europe/Prague”, “America/New_York”). Used to interpret the recurrence_rule in the given timezone. If empty, defaults to UTC.
evaluators	repeated Evaluator	Named evaluators attached to this test. Each evaluator has its own SQL boolean expression and severity. When present, the test outcome is determined by the worst severity among failing evaluators; tests with no evaluators fall back to the single-expression pass/fail rule.
input_tables	repeated InputTable	Tables referenced by the SQL expression, resolved at upsert time.

SqlTestAudit

(synq.datachecks.sqltests.v1.SqlTestAudit)

Field	Type	Description
execution_id	string	none
rows_count	int32	none
result	string	JSON array of failing-row objects. Each object contains the original SELECT-list columns plus an `_failed_evaluators` array of evaluator IDs that flagged that row (only present when the SqlTest has evaluators).
created_at	Timestamp	none
evaluators	repeated EvaluatorResult	Per-evaluator metadata for the run that produced this audit. Empty when the SqlTest has no evaluators. Use to resolve the evaluator IDs found in each row’s `_failed_evaluators` array to their names and severities.
sql_test_path	string	Path of the SqlTest that produced this audit.
status	ExecutionStatus	Overall run status of the SqlTest execution that produced this audit.
status_message	string	Short human-readable status message describing the overall run outcome.

SqlValue

(synq.datachecks.sqltests.v1.SqlValue) Represents a value that can be either a literal (to be quoted in SQL) or a SQL expression (to be used as plain text).

Field	Type	Description
string_literal	string	Literal value that should be quoted in SQL (e.g., ‘2025-05-12’, ‘active’)
expression	string	SQL expression, numbers to be used as plain text (e.g., NOW(), COUNT(*), true, 1.1)

Template

(synq.datachecks.sqltests.v1.Template)

Field	Type	Description
identifier	Identifier	Read-only path of matched entity. This is a unique path that can be used to access the entity in the Coalesce Quality UI.
oneof test.not_null_test	NotNullTest	Checks if specified columns contain no NULL values (e.g., user_id should never be null)
oneof test.empty_test	EmptyTest	Checks if specified columns contain empty values (e.g., description field can be empty)
oneof test.accepted_values_test	AcceptedValuesTest	Validates that column values are within an allowed set (e.g., status in [‘active’, ‘inactive’, ‘pending’])
oneof test.rejected_values_test	RejectedValuesTest	Validates that column values are not in a forbidden set (e.g., country not in [‘UNKNOWN’, ‘TEST’])
oneof test.unique_test	UniqueTest	Ensures specified columns form a unique key combination (e.g., order_id is unique)
oneof test.freshness_test	FreshnessTest	Checks if data is up-to-date based on a time column (e.g., latest event_timestamp within 24h)
oneof test.min_max_test	MinMaxTest	Validates numeric values are within specified range (e.g., price between 0 and 1000)
oneof test.relative_time_test	RelativeTimeTest	Compares time-based columns for logical order (e.g., start_date before end_date)
oneof test.business_rule_test	BusinessRuleTest	Per-row boolean predicate; rows matching are reported as failures (e.g., total_amount != subtotal + tax)
oneof test.min_value_test	MinValueTest	Validates numeric values are greater than or equal to a minimum value (e.g., price >= 0)
oneof test.max_value_test	MaxValueTest	Validates numeric values are less than or equal to a maximum value (e.g., price <= 1000)
oneof test.relationships_test	RelationshipsTest	Validates referential integrity between source and reference tables
oneof test.business_query_test	BusinessQueryTest	Full SELECT whose result rows are reported as failures; supports GROUP BY, JOINs, etc.

UniqueTest

(synq.datachecks.sqltests.v1.UniqueTest) Note: this test does not expose a select_columns option. The SELECT shape is fixed by the aggregation (DISTINCT columns + duplicate count); failure rows are the duplicate keys, not raw table rows.

Field	Type	Description
column_names	repeated string	List of columns that should form a unique combination
time_partition_column_name	string	If provided, the check will be applied to the time window of the time partition column If not provided, the check will be applied to all rows
time_window_seconds	int64	Time window for uniqueness check (in seconds)

BatchDeleteSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsRequest)

Field	Type	Description
ids	repeated string	IDs of the SqlTests to delete.

BatchDeleteSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsResponse)

BatchGetSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchGetSqlTestsRequest)

Field	Type	Description
ids	repeated string	IDs of the SqlTests to fetch.

BatchGetSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchGetSqlTestsResponse)

Field	Type	Description
sql_tests	map SqlTestsEntry	none

BatchGetSqlTestsResponse.SqlTestsEntry

(synq.datachecks.sqltests.v1.BatchGetSqlTestsResponse.SqlTestsEntry)

Field	Type	Description
key	string	none
value	SqlTest	none

BatchUpsertSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchUpsertSqlTestsRequest)

Field	Type	Description
sql_tests	repeated SqlTest	List of SqlTests to upsert. The upsert is performed based on the unique path provided for each SqlTest.
sql_test_ids_to_reset	repeated string	List of SqlTest IDs to reset. Some updates might require resetting the SqlTest to a fresh state.

BatchUpsertSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchUpsertSqlTestsResponse)

Field	Type	Description
created_ids	repeated string	IDs for which SqlTests were created without error.
updated_ids	repeated string	IDs for which SqlTests were updated without error.
errors	repeated UpsertError	Errors raised while upsert. This list will be empty if there were no errors.

BatchUpsertSqlTestsResponse.UpsertError

(synq.datachecks.sqltests.v1.BatchUpsertSqlTestsResponse.UpsertError) Details of errors encountered during the upsert operation.

Field	Type	Description
id	string	none
reason	string	none

ConfigsFilter

(synq.datachecks.sqltests.v1.ConfigsFilter)

Field	Type	Description
ids	repeated string	none

GetSqlTestAuditRequest

(synq.datachecks.sqltests.v1.GetSqlTestAuditRequest)

GetSqlTestAuditResponse

(synq.datachecks.sqltests.v1.GetSqlTestAuditResponse)

Field	Type	Description
audit	SqlTestAudit	none

ListSqlTestsRequest

(synq.datachecks.sqltests.v1.ListSqlTestsRequest)

Field	Type	Description
annotations	repeated Annotation	Optional annotations to fetch SqlTests for.
integration_ids	repeated string	none
ids	repeated string	none
config_ids	repeated string	none
configs_filter	ConfigsFilter	Filter SqlTests by config IDs. Pass `ConfigsFilter{ids: ["config1", "config2"]}` to filter by specific configs. If nil, no config_id filtering is applied. If empty, the one with NULL config_id will be excluded.
sources	repeated Source	none
oneof _pagination.pagination	optional Pagination	none

ListSqlTestsResponse

(synq.datachecks.sqltests.v1.ListSqlTestsResponse)

Field	Type	Description
sql_tests	repeated SqlTest	none
page_info	PageInfo	Paging information

MonitorInfoRequest

(synq.monitors.info.v1.MonitorInfoRequest)

Field	Type	Description
id	Identifier	none

MonitorInfoResponse

(synq.monitors.info.v1.MonitorInfoResponse)

Field	Type	Description
oneof _monitor_info.monitor_info	optional MonitorInfo	none

ColumnSource

(synq.monitors.info.v1.ColumnSource)

Field	Type	Description
column	string	none

Condition

(synq.monitors.info.v1.Condition)

Field	Type	Description
expression	string	none

CountRows

(synq.monitors.info.v1.CountRows)

DatabaseFqn

(synq.monitors.info.v1.DatabaseFqn)

Field	Type	Description
oneof _instance.instance	optional string	Usually it is the hostname of the server
oneof _database_name.database_name	optional string	Database name for databases with multi-db support
schema_name	string	One level
object_name	string	Name of the table or view

ExpressionSource

(synq.monitors.info.v1.ExpressionSource)

Field	Type	Description
expression	string	none

MetadataSource

(synq.monitors.info.v1.MetadataSource)

Metric

(synq.monitors.info.v1.Metric)

Field	Type	Description
metric_id	string	none
oneof metric_type.freshness	MonitorFreshness	none
oneof metric_type.volume	MonitorVolume	none
oneof metric_type.value	MonitorValue	none
oneof metric_type.failed_rows	MonitorFailedRows	none
oneof metric_type.field_stats	MonitorFieldStats	A statistical profile of a single column (for example null counts, uniqueness, minimum/maximum, mean/standard deviation or byte size). The specific statistic is identified by metric_id; this variant carries the column the statistic is computed on.
oneof metric_type.category_distribution	MonitorCategoryDistribution	A shift in the distribution of the distinct values of a categorical column, scored against a learned baseline. This variant carries the column whose value distribution is monitored.

MonitorCategoryDistribution

(synq.monitors.info.v1.MonitorCategoryDistribution)

Field	Type	Description
column	string	Name of the categorical column whose value distribution is monitored.

MonitorFailedRows

(synq.monitors.info.v1.MonitorFailedRows)

Field	Type	Description
sql	string	none

MonitorFieldStats

(synq.monitors.info.v1.MonitorFieldStats)

Field	Type	Description
column	string	Name of the column whose statistical profile is monitored, as it appears in the monitored object. Empty when the statistic is computed at the table level rather than on a specific column.

MonitorFreshness

(synq.monitors.info.v1.MonitorFreshness)

Field	Type	Description
oneof freshness_source.expression	string	none
oneof freshness_source.table_metadata	MetadataSource	none

MonitorInfo

(synq.monitors.info.v1.MonitorInfo)

Field	Type	Description
id	MonitorIdentifier	Identifier of the monitor
monitor_id	Identifier	Identifier of the monitor
monitor_synq_path	string	Coalesce Quality Path to the entity.
name	string	Name of the monitor
oneof _segmentation.segmentation	optional Segmentation	Information how this monitor segments the data
oneof _partitioning.partitioning	optional Partitioning	Information how this monitor partitions the data
conditions	repeated Condition	Optional conditions which are applied to the monitor metrics retrieval
metrics	repeated Metric	Metrics which this monitor monitors
monitored	repeated Monitored	Entity which is monitored
managed_by_rule	bool	Whether this monitor is governed by a deployment rule. When true, the monitor’s configuration is managed centrally by a rule and manual edits may be overwritten the next time the rule is applied. False for monitors that are configured individually.

MonitorValue

(synq.monitors.info.v1.MonitorValue)

Field	Type	Description
expression	string	none

MonitorVolume

(synq.monitors.info.v1.MonitorVolume)

Field	Type	Description
oneof volume_source.expression	string	none
oneof volume_source.count_rows	CountRows	none
oneof volume_source.table_metadata	MetadataSource	none

Monitored

(synq.monitors.info.v1.Monitored)

Field	Type	Description
id	Identifier	Identifier of the monitored entity.
synq_path	string	Coalesce Quality Path to the monitored entity.
name	string	Name of the monitored entity
oneof _description.description	optional string	Description of the monitored entity
oneof _integration_id.integration_id	optional string	Id of the integration which provided information about monitored entity.
oneof _object_fqn.object_fqn	optional DatabaseFqn	Coordinates to the physical table/view which is monitored (when applicable)
sql_dialect	SqlDialect	SQL dialect used for monitoring

Partitioning

(synq.monitors.info.v1.Partitioning)

Field	Type	Description
column	string	none
period	Duration	none

Segmentation

(synq.monitors.info.v1.Segmentation)

Field	Type	Description
column	string	none

AutomatedMonitorSettings

(synq.monitors.automated_monitors.v1.AutomatedMonitorSettings)

Field	Type	Description
severity	Severity	none
sensitivity	Sensitivity	LEGACY - global sensitivity
metric_ids	repeated MetricId	LEGACY - which metrics to monitor
metric_options	repeated MetricOption	NEW - per-metric sensitivity

CustomMonitorSettingsChange

(synq.monitors.automated_monitors.v1.CustomMonitorSettingsChange)

Field	Type	Description
monitored_asset_path	string	none
original_settings	AutomatedMonitorSettings	none
new_settings	AutomatedMonitorSettings	none
oneof _resolved_freshness_field.resolved_freshness_field	optional string	none

EntitySelectionQuery

(synq.monitors.automated_monitors.v1.EntitySelectionQuery)

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	none

EntitySelectionQuery.QueryPart

(synq.monitors.automated_monitors.v1.EntitySelectionQuery.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_folder	InFolder	synq.queries.v1.InDataPlatform in_data_platform = 5;
oneof part.query	EntitySelectionQuery	none
oneof part.unsupported	Unsupported	none

ExclusiveQueryConfig

(synq.monitors.automated_monitors.v1.ExclusiveQueryConfig)

Field	Type	Description
query	EntitySelectionQuery	none
resolver_ql	string	ResolverQL selection string for the exclusion set. Same semantics as QueryConfig.resolver_ql: when set on write it takes precedence over `query`; on read it is echoed back VERBATIM for ResolverQL-authored rules and is empty for structured-`query` rules (whose ResolverQL form is in `rendered_resolver_ql`). `query` is always populated.
rendered_resolver_ql	string	Canonical ResolverQL rendering of the exclusion selection. Same semantics as QueryConfig.rendered_resolver_ql: OUTPUT ONLY, populated for every rule, ignored on write.

ExclusiveStaticConfig

(synq.monitors.automated_monitors.v1.ExclusiveStaticConfig)

Field	Type	Description
path	string	none

MetricOption

(synq.monitors.automated_monitors.v1.MetricOption)

Field	Type	Description
sensitivity	Sensitivity	none
metric_id	MetricId	none

MonitorSettingsChange

(synq.monitors.automated_monitors.v1.MonitorSettingsChange)

Field	Type	Description
monitored_asset_path	string	none
original_settings	AutomatedMonitorSettings	none
new_settings	AutomatedMonitorSettings	none

MonitorsDeploymentOverview

(synq.monitors.automated_monitors.v1.MonitorsDeploymentOverview)

Field	Type	Description
monitors_to_create_for	repeated string	none
monitors_to_delete_for	repeated string	none
active_monitors_for	repeated string	none
monitor_settings_changes	repeated MonitorSettingsChange	none
custom_monitors_to_create_for	repeated string	none
custom_monitors_to_delete_for	repeated string	none
active_custom_monitors_for	repeated string	none
custom_monitor_settings_changes	repeated CustomMonitorSettingsChange	none
skipped_assets	repeated SkippedAsset	none

MonitorsDeploymentRule

(synq.monitors.automated_monitors.v1.MonitorsDeploymentRule)

Field	Type	Description
id	string	none
title	string	none
oneof config.query_config	QueryConfig	none
oneof config.exclusive_query_config	ExclusiveQueryConfig	none
oneof config.static_config	StaticConfig	none
oneof config.exclusive_static_config	ExclusiveStaticConfig	none
oneof config.product_config	ProductConfig	none
source	Source	none
oneof _config_id.config_id	optional string	none

MonitorsDeploymentRuleView

(synq.monitors.automated_monitors.v1.MonitorsDeploymentRuleView)

Field	Type	Description
id	string	none
title	string	none
monitor_count	int32	none
oneof config.query_config	QueryConfig	none
oneof config.exclusive_query_config	ExclusiveQueryConfig	none
oneof config.static_config	StaticConfig	none
oneof config.exclusive_static_config	ExclusiveStaticConfig	none
oneof config.product_config	ProductConfig	none
source	Source	none
oneof _config_id.config_id	optional string	none

ProductConfig

(synq.monitors.automated_monitors.v1.ProductConfig)

Field	Type	Description
product_id	string	none
severity	Severity	none
sensitivity	Sensitivity	none
metric_ids	repeated MetricId	none
upstream	ProductConfigUpstreamStrategy	none
self	ProductConfigSelfStrategy	none
keep_deleted_monitors	bool	none
metric_options	repeated MetricOption	NEW

ProductConfigSelfStrategy

(synq.monitors.automated_monitors.v1.ProductConfigSelfStrategy)

Field	Type	Description
oneof strategy.all	ProductConfigSelfStrategyAll	none
oneof strategy.selection	ProductConfigSelfStrategySelection	none

ProductConfigSelfStrategyAll

(synq.monitors.automated_monitors.v1.ProductConfigSelfStrategyAll)

ProductConfigSelfStrategySelection

(synq.monitors.automated_monitors.v1.ProductConfigSelfStrategySelection)

Field	Type	Description
query	EntitySelectionQuery	none

ProductConfigUpstreamStrategy

(synq.monitors.automated_monitors.v1.ProductConfigUpstreamStrategy)

Field	Type	Description
oneof strategy.all	ProductConfigUpstreamStrategyAll	none
oneof strategy.sources	ProductConfigUpstreamStrategySources	none

ProductConfigUpstreamStrategyAll

(synq.monitors.automated_monitors.v1.ProductConfigUpstreamStrategyAll)

ProductConfigUpstreamStrategySources

(synq.monitors.automated_monitors.v1.ProductConfigUpstreamStrategySources)

QueryConfig

(synq.monitors.automated_monitors.v1.QueryConfig)

Field	Type	Description
query	EntitySelectionQuery	none
severity	Severity	none
sensitivity	Sensitivity	none
metric_ids	repeated MetricId	none
keep_deleted_monitors	bool	none
metric_options	repeated MetricOption	NEW - optional per-metric config
resolver_ql	string	ResolverQL selection string — an advanced, more expressive alternative to `query`. ResolverQL is a superset of the structured `query`: use it for selections `query` cannot express (e.g. lineage walks, column predicates). When set (non-empty) on write, `resolver_ql` is the source of truth and the structured `query` is ignored. On read it is echoed back VERBATIM (exactly as written, not normalized) for rules authored via ResolverQL, and is empty for rules authored via the structured `query` — so writing a read response back unchanged preserves the rule’s authored form (a structured rule stays structured rather than being silently rewritten to ResolverQL). To read the ResolverQL form of a structured rule, use `rendered_resolver_ql`. `query` is always populated regardless.
rendered_resolver_ql	string	Canonical ResolverQL rendering of this rule’s selection, populated for every query rule regardless of how it was authored. OUTPUT ONLY — it is ignored on write; set `resolver_ql` to author a selection in ResolverQL. Use it to read the ResolverQL form of a rule authored via the structured `query`; for ResolverQL-authored rules it equals `resolver_ql`. Empty only for selections that have no ResolverQL representation.

SkippedAsset

(synq.monitors.automated_monitors.v1.SkippedAsset)

Field	Type	Description
asset_path	string	none
reason	string	none

StaticConfig

(synq.monitors.automated_monitors.v1.StaticConfig)

Field	Type	Description
path	string	none
severity	Severity	none
sensitivity	Sensitivity	none
metric_ids	repeated MetricId	none
metric_options	repeated MetricOption	NEW

BatchDeleteDeploymentRulesRequest

(synq.monitors.automated_monitors.v1.BatchDeleteDeploymentRulesRequest)

Field	Type	Description
ids	repeated string	IDs of the DeploymentRules to delete.

BatchDeleteDeploymentRulesResponse

(synq.monitors.automated_monitors.v1.BatchDeleteDeploymentRulesResponse)

BatchDeployDeploymentRulesRequest

(synq.monitors.automated_monitors.v1.BatchDeployDeploymentRulesRequest)

Field	Type	Description
deployment_rules	repeated MonitorsDeploymentRule	List of DeploymentRules to deploy.

BatchDeployDeploymentRulesResponse

(synq.monitors.automated_monitors.v1.BatchDeployDeploymentRulesResponse)

Field	Type	Description
deployed_ids	repeated string	IDs for which DeploymentRules were deployed without error.
errors	repeated DeployError	Errors raised while deploying. This list will be empty if there were no errors.

BatchDeployDeploymentRulesResponse.DeployError

(synq.monitors.automated_monitors.v1.BatchDeployDeploymentRulesResponse.DeployError) Details of errors encountered during the deploy operation.

Field	Type	Description
id	string	none
reason	string	none

BatchGetDeploymentRulesRequest

(synq.monitors.automated_monitors.v1.BatchGetDeploymentRulesRequest)

Field	Type	Description
ids	repeated string	none

BatchGetDeploymentRulesResponse

(synq.monitors.automated_monitors.v1.BatchGetDeploymentRulesResponse)

Field	Type	Description
deployment_rules	map DeploymentRulesEntry	none

BatchGetDeploymentRulesResponse.DeploymentRulesEntry

(synq.monitors.automated_monitors.v1.BatchGetDeploymentRulesResponse.DeploymentRulesEntry)

Field	Type	Description
key	string	none
value	MonitorsDeploymentRuleView	none

BatchUpdateDeploymentRuleTitleRequest

(synq.monitors.automated_monitors.v1.BatchUpdateDeploymentRuleTitleRequest)

Field	Type	Description
deployment_rules	repeated UpdateDeploymentRuleTitleRequest	none

BatchUpdateDeploymentRuleTitleResponse

(synq.monitors.automated_monitors.v1.BatchUpdateDeploymentRuleTitleResponse)

BatchUpsertDeploymentRulesRequest

(synq.monitors.automated_monitors.v1.BatchUpsertDeploymentRulesRequest)

Field	Type	Description
deployment_rules	repeated MonitorsDeploymentRule	List of DeploymentRules to upsert.

BatchUpsertDeploymentRulesResponse

(synq.monitors.automated_monitors.v1.BatchUpsertDeploymentRulesResponse)

Field	Type	Description
created_ids	repeated string	IDs for which DeploymentRules were created without error.
updated_ids	repeated string	IDs for which DeploymentRules were updated without error.
errors	repeated UpsertError	Errors raised while upsert. This list will be empty if there were no errors.

BatchUpsertDeploymentRulesResponse.UpsertError

(synq.monitors.automated_monitors.v1.BatchUpsertDeploymentRulesResponse.UpsertError) Details of errors encountered during the upsert operation.

Field	Type	Description
id	string	none
reason	string	none

ConfigsFilter

(synq.monitors.automated_monitors.v1.ConfigsFilter)

Field	Type	Description
ids	repeated string	none

DeleteDeploymentRuleRequest

(synq.monitors.automated_monitors.v1.DeleteDeploymentRuleRequest)

Field	Type	Description
id	string	none

DeleteDeploymentRuleResponse

(synq.monitors.automated_monitors.v1.DeleteDeploymentRuleResponse)

DeployDeploymentRuleRequest

(synq.monitors.automated_monitors.v1.DeployDeploymentRuleRequest)

Field	Type	Description
deployment_rule	MonitorsDeploymentRule	none

DeployDeploymentRuleResponse

(synq.monitors.automated_monitors.v1.DeployDeploymentRuleResponse)

GetDeployDeleteOverviewRequest

(synq.monitors.automated_monitors.v1.GetDeployDeleteOverviewRequest)

Field	Type	Description
id	string	none

GetDeployDeleteOverviewResponse

(synq.monitors.automated_monitors.v1.GetDeployDeleteOverviewResponse)

Field	Type	Description
overview	MonitorsDeploymentOverview	none

GetDeployOverviewRequest

(synq.monitors.automated_monitors.v1.GetDeployOverviewRequest)

Field	Type	Description
deployment_rule	MonitorsDeploymentRule	none

GetDeployOverviewResponse

(synq.monitors.automated_monitors.v1.GetDeployOverviewResponse)

Field	Type	Description
overview	MonitorsDeploymentOverview	none

ListDeploymentRulesForAssetRequest

(synq.monitors.automated_monitors.v1.ListDeploymentRulesForAssetRequest)

Field	Type	Description
asset_path	string	none

ListDeploymentRulesForAssetResponse

(synq.monitors.automated_monitors.v1.ListDeploymentRulesForAssetResponse)

Field	Type	Description
deployment_rules	repeated MonitorsDeploymentRuleView	none

ListDeploymentRulesRequest

(synq.monitors.automated_monitors.v1.ListDeploymentRulesRequest)

Field	Type	Description
sources	repeated Source	none
config_ids	repeated string	none
configs_filter	ConfigsFilter	Filter SqlTests by config IDs. Pass `ConfigsFilter{ids: ["config1", "config2"]}` to filter by specific configs. If nil, no config_id filtering is applied. If empty, the one with NULL config_id will be excluded.
rule_ids	repeated string	none
rule_types	repeated DeploymentRuleType	Filter by rule type. When empty, rules of every type are returned. When set, only rules whose type is listed are returned (e.g. pass [DEPLOYMENT_RULE_TYPE_QUERY, DEPLOYMENT_RULE_TYPE_PRODUCT] to exclude single-path rules). The filter is applied server-side before paging, so every page reflects only the selected types.
oneof _pagination.pagination	optional Pagination	Pagination. An unset/zero page_size applies the server default; the server never returns all rules in one response. Pass page_info.last_id from the previous response as the cursor to fetch the next page.

ListDeploymentRulesResponse

(synq.monitors.automated_monitors.v1.ListDeploymentRulesResponse)

Field	Type	Description
deployment_rules	repeated MonitorsDeploymentRuleView	none
page_info	PageInfo	Paging information for this response. Always populated. This response carries at most one bounded page of rules, never the full set. The cursor is the paging contract: to retrieve every rule, repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty. page_info.count is the number of rules in this page. page_info.total_count is a best-effort total for the same filter, but it is deprecated — do not drive paging off it; loop on last_id instead.

UpdateDeploymentRuleTitleRequest

(synq.monitors.automated_monitors.v1.UpdateDeploymentRuleTitleRequest)

Field	Type	Description
id	string	none
title	string	none

UpsertDeploymentRuleRequest

(synq.monitors.automated_monitors.v1.UpsertDeploymentRuleRequest)

Field	Type	Description
deployment_rule	MonitorsDeploymentRule	none

UpsertDeploymentRuleResponse

(synq.monitors.automated_monitors.v1.UpsertDeploymentRuleResponse)

HistoryRequest

(synq.monitors.history.v1.HistoryRequest)

Field	Type	Description
monitor_path	string	Experimental: Will be replaced with identifier
metrics_version	int32	none
segments	repeated string	none
from	Timestamp	none
to	Timestamp	none

HistoryResponse

(synq.monitors.history.v1.HistoryResponse)

Field	Type	Description
predictions	repeated Prediction	none

Prediction

(synq.monitors.history.v1.Prediction)

Field	Type	Description
f	string	Field
s	string	Segment
m	string	Metric
v	double	Value
vu	DoubleValue	Upper bound
vl	DoubleValue	Lower bound
p	string	Pattern
e	double	Expected value
st	double	Standard deviation
t	Timestamp	Timestamp

BatchCreateMonitorRequest

(synq.monitors.custom_monitors.v1.BatchCreateMonitorRequest)

Field	Type	Description
monitors	repeated MonitorDefinition	none

BatchCreateMonitorResponse

(synq.monitors.custom_monitors.v1.BatchCreateMonitorResponse)

Field	Type	Description
created_monitor_ids	repeated string	none

BatchDeleteMonitorRequest

(synq.monitors.custom_monitors.v1.BatchDeleteMonitorRequest)

Field	Type	Description
ids	repeated string	none

BatchDeleteMonitorResponse

(synq.monitors.custom_monitors.v1.BatchDeleteMonitorResponse)

Field	Type	Description
deleted_ids	repeated string	none

BatchUpdateMonitorModeRequest

(synq.monitors.custom_monitors.v1.BatchUpdateMonitorModeRequest)

Field	Type	Description
ids	repeated string	none
oneof mode.anomaly_engine	ModeAnomalyEngine	none
oneof mode.fixed_thresholds	ModeFixedThresholds	none

BatchUpdateMonitorModeResponse

(synq.monitors.custom_monitors.v1.BatchUpdateMonitorModeResponse)

Field	Type	Description
updated_ids	repeated string	none

BatchUpdateMonitorRequest

(synq.monitors.custom_monitors.v1.BatchUpdateMonitorRequest)

Field	Type	Description
monitor_ids_to_reset	repeated string	none
monitors	repeated MonitorDefinition	none

BatchUpdateMonitorResponse

(synq.monitors.custom_monitors.v1.BatchUpdateMonitorResponse)

Field	Type	Description
updated_ids	repeated string	none

BatchUpdateMonitorSeverityRequest

(synq.monitors.custom_monitors.v1.BatchUpdateMonitorSeverityRequest)

Field	Type	Description
ids	repeated string	none
severity	Severity	none

BatchUpdateMonitorSeverityResponse

(synq.monitors.custom_monitors.v1.BatchUpdateMonitorSeverityResponse)

Field	Type	Description
updated_ids	repeated string	none

ChangeOverview

(synq.monitors.custom_monitors.v1.ChangeOverview)

Field	Type	Description
monitor_id	string	none
origin_definition	MonitorDefinition	none
new_definition	MonitorDefinition	none
changes	string	none
changes_delta_json	string	none
should_reset	bool	none

ConfigChangesOverviewRequest

(synq.monitors.custom_monitors.v1.ConfigChangesOverviewRequest)

Field	Type	Description
config_ids	repeated string	none
monitors	repeated MonitorDefinition	none

ConfigChangesOverviewResponse

(synq.monitors.custom_monitors.v1.ConfigChangesOverviewResponse)

Field	Type	Description
monitors_managed_by_app	repeated MonitorDefinition	none
monitors_managed_by_other_configs	repeated MonitorDefinition	none
monitors_to_create	repeated MonitorDefinition	none
monitors_to_delete	repeated MonitorDefinition	none
monitors_unchanged	repeated MonitorDefinition	none
monitors_changes_overview	repeated ChangeOverview	none

ConfigsFilter

(synq.monitors.custom_monitors.v1.ConfigsFilter)

Field	Type	Description
ids	repeated string	none

ListConfigsMonitorsRequest

(synq.monitors.custom_monitors.v1.ListConfigsMonitorsRequest)

Field	Type	Description
config_ids	repeated string	none

ListConfigsMonitorsResponse

(synq.monitors.custom_monitors.v1.ListConfigsMonitorsResponse)

Field	Type	Description
monitors	repeated MonitorDefinition	none

ListMonitorsRequest

(synq.monitors.custom_monitors.v1.ListMonitorsRequest)

Field	Type	Description
integration_ids	repeated string	none
monitored_asset_paths	repeated string	none
monitor_ids	repeated string	none
source	repeated string	none
config_ids	repeated string	none
configs_filter	ConfigsFilter	Filter SqlTests by config IDs. Pass `ConfigsFilter{ids: ["config1", "config2"]}` to filter by specific configs. If nil, no config_id filtering is applied. If empty, the one with NULL config_id will be excluded.
sources	repeated Source	none
oneof _pagination.pagination	optional Pagination	Pagination

ListMonitorsResponse

(synq.monitors.custom_monitors.v1.ListMonitorsResponse)

Field	Type	Description
monitors	repeated MonitorDefinition	none
page_info	PageInfo	Paging information.

ModeAnomalyEngine

(synq.monitors.custom_monitors.v1.ModeAnomalyEngine)

Field	Type	Description
sensitivity	Sensitivity	none

ModeFixedThresholds

(synq.monitors.custom_monitors.v1.ModeFixedThresholds)

Field	Type	Description
min	DoubleValue	none
max	DoubleValue	none

MonitorCategoryDistribution

(synq.monitors.custom_monitors.v1.MonitorCategoryDistribution)

Field	Type	Description
field	string	Categorical column whose value distribution is monitored.
top_k_limit	int32	Max categories to track; the rest are aggregated into “other”. 0 = use default.

MonitorCustomNumeric

(synq.monitors.custom_monitors.v1.MonitorCustomNumeric)

Field	Type	Description
metric_aggregation	string	none

MonitorDefinition

(synq.monitors.custom_monitors.v1.MonitorDefinition)

Field	Type	Description
id	string	none
monitored_id	Identifier	none
time_partitioning	TimePartitioning	none
oneof _segmentation.segmentation	optional Segmentation	none
oneof _filter.filter	optional string	none
severity	Severity	none
name	string	none
description	string	none
oneof _config_id.config_id	optional string	none
source	Source	Source of the monitor.
timezone	string	none
oneof monitor.freshness	MonitorFreshness	none
oneof monitor.volume	MonitorVolume	none
oneof monitor.custom_numeric	MonitorCustomNumeric	none
oneof monitor.field_stats	MonitorFieldStats	none
oneof monitor.table_stats	MonitorTableStats	none
oneof monitor.category_distribution	MonitorCategoryDistribution	none
oneof mode.anomaly_engine	ModeAnomalyEngine	none
oneof mode.fixed_thresholds	ModeFixedThresholds	none
oneof schedule.daily	ScheduleDaily	none
oneof schedule.hourly	ScheduleHourly	none
oneof schedule.on_demand	ScheduleOnDemand	none
oneof _sql_source.sql_source	optional SqlSource	Optional SQL source. When set, the monitor queries against this SQL (wrapped as a CTE) instead of the table identified by monitored_id directly. Column references in time_partitioning, segmentation, and filter refer to columns in the SQL output.

MonitorFieldStats

(synq.monitors.custom_monitors.v1.MonitorFieldStats)

Field	Type	Description
fields	repeated string	none

MonitorFreshness

(synq.monitors.custom_monitors.v1.MonitorFreshness)

Field	Type	Description
expression	string	The expression to filter on (eg. “created_at”, “meta[‘created_at’]“)

MonitorTableStats

(synq.monitors.custom_monitors.v1.MonitorTableStats)

Field	Type	Description
metric_options	repeated MetricOption	Metrics to monitor. If empty, all metrics are monitored.
oneof freshness_source.field	string	Timestamp column name, e.g. “updated_at” (used as max(updated_at)).
oneof freshness_source.sql	string	Row-level SQL expression yielding a timestamp, e.g. “coalesce(updated_at, created_at)”. Do NOT wrap it in an aggregate — max() is applied automatically.

MonitorVolume

(synq.monitors.custom_monitors.v1.MonitorVolume)

ScheduleDaily

(synq.monitors.custom_monitors.v1.ScheduleDaily)

Field	Type	Description
minutes_since_midnight	int32	Minutes since midnight (0-1439)
oneof _delay_num_days.delay_num_days	optional int32	Delay monitoring by given number of days.
only_schedule_delay	bool	if true, the minutes_since_midnight will be related to delay scheduling/execution instead of time shifting time partitions

ScheduleHourly

(synq.monitors.custom_monitors.v1.ScheduleHourly)

Field	Type	Description
minute_of_hour	int32	Minute of hour (0-59)
oneof _delay_num_hours.delay_num_hours	optional int32	Delay monitoring by given number of hours.
only_schedule_delay	bool	if true, the minute_of_hour will be related to delay scheduling/execution instead of time shifting time partitions

ScheduleOnDemand

(synq.monitors.custom_monitors.v1.ScheduleOnDemand)

Segmentation

(synq.monitors.custom_monitors.v1.Segmentation)

Field	Type	Description
expression	string	The expression to segment on (eg. “country”, “meta[‘country’]”) You can optionally specify values to include or exclude from segmentation. If neither are provided, all values are included by default.
oneof _include_values.include_values	optional ValueList	List of expression values to include for segmentation (eg. “UK”, “France”)
oneof _exclude_values.exclude_values	optional ValueList	List of expression values to exclude for segmentation (eg. “NA”, "")

SqlSource

(synq.monitors.custom_monitors.v1.SqlSource) SQL query to use as the data source for a monitor instead of querying a table directly. The SQL is wrapped as a CTE, and the monitor’s metric query runs against its output. Column references (time partitioning, segmentation, filter) refer to columns in the SQL output.

Field	Type	Description
sql	string	The SQL query providing the data source. Example: “SELECT created_at, country, amount FROM orders WHERE status = ‘completed‘“

TimePartitioning

(synq.monitors.custom_monitors.v1.TimePartitioning)

Field	Type	Description
expression	string	The expression to partition on (eg. “created_at”, “meta[‘created_at’]”). Required and must be non-empty whenever time partitioning is set (i.e. for every non-table-stats monitor); an empty expression produces a monitor that cannot run.
interval	Duration	none

ValueList

(synq.monitors.custom_monitors.v1.ValueList)

Field	Type	Description
values	repeated string	none

BatchGetLatestEntityMetricsRequest

(synq.monitors.predictions.v1.BatchGetLatestEntityMetricsRequest)

Field	Type	Description
synq_paths	repeated string	Entity synq_paths to look up. Duplicates are allowed and de-duplicated server-side.

BatchGetLatestEntityMetricsResponse

(synq.monitors.predictions.v1.BatchGetLatestEntityMetricsResponse)

Field	Type	Description
latest_by_synq_path	map LatestBySynqPathEntry	Latest observed data point keyed by the requested synq_path. Entities with no recent sample are omitted — callers should treat a missing key as “no metrics available”.

BatchGetLatestEntityMetricsResponse.LatestBySynqPathEntry

(synq.monitors.predictions.v1.BatchGetLatestEntityMetricsResponse.LatestBySynqPathEntry)

Field	Type	Description
key	string	none
value	EntityMetricDataPoint	none

GetEntityMetricsRequest

(synq.monitors.predictions.v1.GetEntityMetricsRequest)

Field	Type	Description
synq_path	string	Entity synq_path (table, view, or dbt model).
oneof _from.from	optional Timestamp	Start of time range. Defaults to 30 days before `to`. Max lookback: 30 days.
oneof _to.to	optional Timestamp	End of time range. Defaults to now.

GetEntityMetricsResponse

(synq.monitors.predictions.v1.GetEntityMetricsResponse)

Field	Type	Description
data_points	repeated EntityMetricDataPoint	none

GetMonitorPredictionsRequest

(synq.monitors.predictions.v1.GetMonitorPredictionsRequest)

Field	Type	Description
synq_path	string	Monitor synq_path.
oneof _metrics_version.metrics_version	optional int32	Metrics version. Defaults to the monitor’s current version.
segments	repeated string	Segment filters. If empty, all segments are returned.
oneof _from.from	optional Timestamp	Start of time range. Defaults to 30 days before `to`. Max lookback: 30 days.
oneof _to.to	optional Timestamp	End of time range. Defaults to now.

GetMonitorPredictionsResponse

(synq.monitors.predictions.v1.GetMonitorPredictionsResponse)

Field	Type	Description
predictions	repeated MonitorPrediction	none

EntityMetricDataPoint

(synq.monitors.predictions.v1.EntityMetricDataPoint) Single observation of table-level metrics collected from the data warehouse.

Field	Type	Description
synq_path	string	Entity synq_path.
oneof _num_rows.num_rows	optional Int64Value	Row count.
oneof _last_loaded_at.last_loaded_at	optional Timestamp	Last loaded time as reported by the data warehouse.
scheduled_at	Timestamp	When the metric was scheduled for collection.
oneof _snapshotted_at.snapshotted_at	optional Timestamp	Data warehouse snapshot time.
oneof _size_bytes.size_bytes	optional Int64Value	Physical size in bytes as reported by the data warehouse.

MonitorPrediction

(synq.monitors.predictions.v1.MonitorPrediction) Single prediction data point from the anomaly detection model.

Field	Type	Description
field	string	Monitored field.
oneof _segment.segment	optional string	Segment.
metric_id	string	Metric identifier.
value	double	Observed value.
expected	double	Model’s expected value.
oneof _stddev.stddev	optional double	Prediction standard deviation.
oneof _upper_bound.upper_bound	optional DoubleValue	Confidence band upper bound.
oneof _lower_bound.lower_bound	optional DoubleValue	Confidence band lower bound.
oneof _pattern.pattern	optional string	Anomaly pattern (e.g., “spike”, “drop”).
scheduled_at	Timestamp	When the prediction was scheduled.
is_corrected	bool	Whether a user has marked this prediction as expected behavior.

BatchResolveIdentifiersRequest

(synq.entities.resolve.v1.BatchResolveIdentifiersRequest)

Field	Type	Description
ids	repeated Identifier	Identifiers to resolve.
check_existence	bool	When true, also verify that the resolved entities actually exist in the system.

BatchResolveIdentifiersResponse

(synq.entities.resolve.v1.BatchResolveIdentifiersResponse)

Field	Type	Description
resolved_identifiers	repeated ResolvedIdentifier	none

ResolvedIdentifier

(synq.entities.resolve.v1.ResolvedIdentifier) ResolvedIdentifier contains the resolution result for a single input identifier.

Field	Type	Description
id	Identifier	The original input identifier.
synq_path	string	The Coalesce Quality path for this identifier.
identities	repeated Identifier	All identifiers that are part of the same identity group (including the input identifier).
identity_synq_paths	repeated string	All Coalesce Quality paths in the identity group.
oneof _exists.exists	optional bool	Whether the entity exists in the system. Only populated when check_existence is true in the request.

BatchDatabaseCoordinatesRequest

(synq.entities.coordinates.v1.BatchDatabaseCoordinatesRequest) BatchGetEntitiesRequest is the request message for the BatchGetEntities method.

Field	Type	Description
ids	repeated Identifier	Identifiers of the entities to get.

BatchDatabaseCoordinatesResponse

(synq.entities.coordinates.v1.BatchDatabaseCoordinatesResponse) BatchGetEntitiesResponse is the response message for the BatchGetEntities method.

Field	Type	Description
coordinates	repeated DatabaseCoordinates	The entities that were retrieved.

BatchIdsByCoordinatesRequest

(synq.entities.coordinates.v1.BatchIdsByCoordinatesRequest)

Field	Type	Description
sql_fqn	repeated string	Databases coordinates as present in the SQL, e.g. `db.schema.table`

BatchIdsByCoordinatesResponse

(synq.entities.coordinates.v1.BatchIdsByCoordinatesResponse)

Field	Type	Description
matched_coordinates	repeated MatchedCoordinates	none

BatchIdsByCoordinatesResponse.MatchedCoordinates

(synq.entities.coordinates.v1.BatchIdsByCoordinatesResponse.MatchedCoordinates)

Field	Type	Description
sql_fqn	string	none
candidates	repeated DatabaseCoordinates	none

DatabaseCoordinates

(synq.entities.coordinates.v1.DatabaseCoordinates)

Field	Type	Description
identifiers	repeated Identifier	none
synq_paths	repeated string	none
dialect_name	string	none
dialect	SqlDialect	none
oneof _data_platform.data_platform	optional DataPlatformIdentifier	none
data_platform_type	DataPlatformType	none
oneof _connection_id.connection_id	optional string	none
instance_name	string	none
database_name	string	none
schema_name	string	none
object_name	string	none
sql_fqn	string	none
oneof _sql_database_name.sql_database_name	optional string	SQL-addressable components (only parts usable in SQL queries). For Postgres, sql_database_name is empty since cross-database queries are not supported.
sql_schema_name	string	none
sql_object_name	string	none

DatabaseContext

(synq.entities.coordinates.v1.DatabaseContext) DatabaseContext provides the default database execution context for resolving unqualified references (e.g. table names in SQL).

Field	Type	Description
instance_name	string	Instance identifier (e.g. Snowflake account, Databricks workspace URL, BigQuery project)
database_name	string	Database or catalog name
schema_name	string	Schema name
object_name	string	Object name (e.g. table or view name) that the SQL writes to or creates. Only set when the SQL defines or materializes an object, e.g. `CREATE TABLE <object_name> AS SELECT ...`. Leave empty for read-only SQL such as dashboard queries or SELECT statements.

EntitiesStartPoint

(synq.entities.lineage.v1.EntitiesStartPoint)

Field	Type	Description
entities	repeated Identifier	none

EntityColumnsStartPoint

(synq.entities.lineage.v1.EntityColumnsStartPoint)

Field	Type	Description
id	Identifier	none
column_names	repeated string	none

GetLineageRequest

(synq.entities.lineage.v1.GetLineageRequest)

Field	Type	Description
lineage_direction	LineageDirection	none
start_point	GetLineageStartPoint	none
oneof _max_depth.max_depth	optional int32	none

GetLineageResponse

(synq.entities.lineage.v1.GetLineageResponse)

Field	Type	Description
lineage	Lineage	none

GetLineageStartPoint

(synq.entities.lineage.v1.GetLineageStartPoint) Possible starting points to get lineage from.

Field	Type	Description
oneof from.entities	EntitiesStartPoint	none
oneof from.entity_columns	EntityColumnsStartPoint	none

CllDetails

(synq.entities.lineage.v1.CllDetails)

Field	Type	Description
columns	repeated Column	Column details for CLL.
cll_state	CllState	State of the CLL parse. UNSPECIFIED if CLL was not requested.
cll_messages	repeated string	Messages related to CLL. e.g. Description of parse errors, etc.

Column

(synq.entities.lineage.v1.Column) Column in a table-like asset (used in CLL mode).

Field	Type	Description
column_id	string	ID string for the column. This is the parsed column name.
oneof _name.name	optional string	Original column name as fetched from the table.
oneof _native_type.native_type	optional string	Column type as fetched from the table.

ColumnDependency

(synq.entities.lineage.v1.ColumnDependency) Indicates data flow between columns. Source columns are used to compute value of target columns.

Field	Type	Description
source_node_idx	uint32	Index of source node in the lineage nodes list.
source_node_column_id	string	none
target_node_idx	uint32	Index of target node in the lineage nodes list.
target_node_column_id	string	none

Lineage

(synq.entities.lineage.v1.Lineage) Lineage defines the lineage of table-like entities.

Field	Type	Description
nodes	repeated LineageNode	Nodes in the lineage with their identities and columns.
node_dependencies	repeated NodeDependency	All edges in the lineage between nodes. This can be parsed to create a graph of all the nodes.
is_cll	bool	Indicates whether the lineage was filtered for column level lineage (CLL).
column_dependencies	repeated ColumnDependency	Dependencies between columns. Populated only for CLL.

LineageNode

(synq.entities.lineage.v1.LineageNode) Node in a lineage graph representing one or more entities (e.g. database table).

Field	Type	Description
ids	repeated Identifier	All entities which have the same identity as this node. Must be at least one item. These are sorted by closeness to the type of the start point entities. e.g. if requesting lineage of a DBT source, first entity should be from DBT, similarly when viewing table it will be other tables.
position	NodePosition	Position of the node in the lineage.
oneof _cll_details.cll_details	optional CllDetails	Populated only for Column Level Lineage (CLL).

NodeDependency

(synq.entities.lineage.v1.NodeDependency) Indicates data flow between nodes. Source nodes are used to compute value of target nodes.

Field	Type	Description
source_node_idx	uint32	Index of source node in the lineage nodes list.
target_node_idx	uint32	Index of target node in the lineage nodes list.

ImpactedDataproduct

(synq.entities.impact.v1.ImpactedDataproduct)

Field	Type	Description
id	DataproductIdentifier	none
title	string	none
description	string	none
folder	string	none
priority	Priority	none
impacted_entities	repeated ImpactedEntityGroup	none

ImpactedEntityGroup

(synq.entities.impact.v1.ImpactedEntityGroup) Multiple Entities which form logical group, e.g. dbt Model and it’s table

Field	Type	Description
oneof _name.name	optional string	none
ids	repeated Identifier	none
synq_paths	repeated string	none

ImpactedOwner

(synq.entities.impact.v1.ImpactedOwner)

Field	Type	Description
id	OwnerIdentifier	none
title	string	none
impacted_entities	repeated ImpactedEntityGroup	none

GetImpactRequest

(synq.entities.impact.v1.GetImpactRequest)

Field	Type	Description
ids	repeated Identifier	none

GetImpactResponse

(synq.entities.impact.v1.GetImpactResponse)

Field	Type	Description
entities	repeated ImpactedEntityGroup	none
downstream_entities	repeated ImpactedEntityGroup	none
dataproducts	repeated ImpactedDataproduct	none
downstream_dataproducts	repeated ImpactedDataproduct	none
owners	repeated ImpactedOwner	none
downstream_owners	repeated ImpactedOwner	none

ListAnnotationsRequest

(synq.entities.annotations.v1.ListAnnotationsRequest) ListAnnotationsRequest is the request message for the ListAnnotations method.

ListAnnotationsResponse

(synq.entities.annotations.v1.ListAnnotationsResponse) ListAnnotationsResponse is the response message for the ListAnnotations method.

Field	Type	Description
annotation_counts	repeated AnnotationCount	The annotation counts grouped by name and value.

AnnotationCount

(synq.entities.annotations.v1.AnnotationCount) AnnotationCount represents the count of entities that have a specific annotation name-value pair. This is used for aggregating and reporting annotation statistics across entities.

Field	Type	Description
name	string	The annotation name (key).
value	string	The annotation value. If empty, represents the count for all values of this annotation name.
count	int32	The number of entities that have this annotation name-value pair.

IdentityRule

(synq.entities.identities.v2.IdentityRule) IdentityRule declares how entities are recognized as the same logical entity. A rule is evaluated against the current set of entities, so it automatically applies to entities that appear after the rule is created. The kind field selects the matching strategy and must be set to a supported rule type.

Field	Type	Description
oneof kind.prefix_rewrite_identity_rule	PrefixRewriteIdentityRule	none

PrefixRewriteIdentityRule

(synq.entities.identities.v2.PrefixRewriteIdentityRule) PrefixRewriteIdentityRule treats two identifier prefixes as the same instance: any entity whose identifier begins with source_prefix is considered identical to the entity with the same identifier under target_prefix. The relationship is bidirectional.

Field	Type	Description
source_prefix	string	Identifier prefix to match (for example, an instance or account prefix).
target_prefix	string	Identifier prefix that matched entities are unified with.

BatchChangeRequest

(synq.entities.changes.v1.BatchChangeRequest) BatchChangeRequest contains the parameters needed to retrieve multiple changes by their IDs.

Field	Type	Description
change_ids	repeated string	List of change IDs to retrieve. Each ID uniquely identifies a specific change in the system.

BatchChangeResponse

(synq.entities.changes.v1.BatchChangeResponse) BatchChangeResponse contains the requested changes mapped by their IDs.

Field	Type	Description
changes	map ChangesEntry	Map of change ID to EntityChange. Only includes changes that were found and accessible. Missing changes are omitted from the response.

BatchChangeResponse.ChangesEntry

(synq.entities.changes.v1.BatchChangeResponse.ChangesEntry)

Field	Type	Description
key	string	none
value	EntityChange	none

ListRequest

(synq.entities.changes.v1.ListRequest) ListRequest contains the parameters needed to retrieve changes for a specific entity.

Field	Type	Description
id	Identifier	Identifier of the entity to get changes for. This can be a path identifier that uniquely identifies the entity in the system.
ids	repeated Identifier	Identifiers of entities for which to get changes. Change is returned when it affects id.
oneof _change_before.change_before	optional Timestamp	Return changes older than or on `before`. Defaults to `now()`.
oneof _change_after.change_after	optional Timestamp	Return changes newer than until. Defaults to before - 7days,
limit_to_change_types	repeated EntityChangeType	Return only changes of specific types.
oneof _pagination.pagination	optional Pagination	Pagination parameters for limiting and cursoring through results.

ListResponse

(synq.entities.changes.v1.ListResponse) ListResponse contains the list of changes made to the requested entity.

Field	Type	Description
changes	repeated EntityChange	List of recent changes to the state of entity. Changes are returned from newest to oldest. Each change includes: - The type of change (git commit, schema change, SQL definition change) - When the change occurred - Details specific to the type of change - Metadata about who made the change
oneof _page_info.page_info	optional PageInfo	Pagination information for navigating through results.

BatchGetIssuesStatusRequest

(synq.entities.status.v1.BatchGetIssuesStatusRequest) BatchGetIssuesStatusRequest is the request message for the BatchGetIssues method.

Field	Type	Description
requests	repeated GetIssuesStatusRequest	none

BatchGetIssuesStatusResponse

(synq.entities.status.v1.BatchGetIssuesStatusResponse) BatchGetIssuesStatusResponse is the response message for the BatchGetIssues method.

Field	Type	Description
responses	repeated GetIssuesStatusResponse	none

GetIssuesStatusRequest

(synq.entities.status.v1.GetIssuesStatusRequest) GetIssuesStatusRequest is the request message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to get status for.
fetch_upstream_status	bool	Retrieve status of upstream entities.

GetIssuesStatusResponse

(synq.entities.status.v1.GetIssuesStatusResponse) GetIssuesStatusResponse is the response message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity.
entity_issues_status	IssueStatus	Status of the entity requested.
entity_issues_summary	IssuesSummary	none
upstream_issues_status	IssueStatus	Optionally, the status of all upstream entities.
upstream_issues_summary	IssuesSummary	none

GetIssuesStatusResponse.IssuesSummary

(synq.entities.status.v1.GetIssuesStatusResponse.IssuesSummary)

Field	Type	Description
total_count	int32	Number of issues for the entity.
warn_count	int32	Number of issues for the entity with status ‘warn’.
error_count	int32	Number of issues for the entity with status ‘error’.
critical_count	int32	Number of issues for the entity with status ‘critical’.

EntityIncident

(synq.entities.status.v1.EntityIncident)

Field	Type	Description
id	string	Unique identifier of the incident.
url	string	URL of the incident.
name	string	Name of the incident give by the user.
created_by	string	Information about author of the incident.
created_at	Timestamp	Time when the incident was created.
updated_by	string	Information about the user who last updated the incident.
updated_at	Timestamp	Time when the incident was last updated.
is_resolved	bool	Indicates if all issues inside the incident are resolved.

BatchGetIncidentsRequest

(synq.entities.status.v1.BatchGetIncidentsRequest) BatchGetIncidentsRequest is the request message for the BatchGetIssues method.

Field	Type	Description
requests	repeated GetIncidentsRequest	none

BatchGetIncidentsResponse

(synq.entities.status.v1.BatchGetIncidentsResponse) BatchGetIncidentsResponse is the response message for the BatchGetIssues method.

Field	Type	Description
responses	repeated GetIncidentsResponse	none

GetIncidentsRequest

(synq.entities.status.v1.GetIncidentsRequest) GetIncidentsRequest is the request message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to get incidents for.
fetch_upstream_incidents	bool	Retrieve incidents of upstream entities.

GetIncidentsResponse

(synq.entities.status.v1.GetIncidentsResponse) GetIncidentsResponse is the response message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity.
entity_open_incidents	repeated EntityIncident	Open incident associated with the entity requested.
upstream_open_incidents	repeated EntityIncident	Open incidents associated with the upstream entities if requested.

Code

(synq.entities.v1.Code) Code represents a piece of code or configuration that can be processed by Coalesce Quality. This message is used to store and manage various types of code artifacts, such as SQL queries, Python scripts, dbt models, and other code configurations. Each code piece is associated with a specific entity that defines or owns it, and includes metadata about its type and state.

Field	Type	Description
definer_identifier	Identifier	Identifier of the entity that defines or owns this code piece. This could be a dbt model, SQLMesh model, or any other entity type that contains code.
definer_synq_path	string	Coalesce Quality Path to the entity. This is a unique path that can be used to access the entity in the Coalesce Quality UI.
definer_entity_type	EntityType	Information about entity type of the entity defining code
state_at	Timestamp	Timestamp indicating when this specific version of the code was captured or last modified. This helps track the evolution of code over time.
code_type	CodeType	Type of code being stored, which determines how Coalesce Quality will process and analyze it. This can be SQL, Python, dbt, SQLMesh, or other supported code types.
oneof _sql_dialect.sql_dialect	optional SqlDialect	SQL dialect used in the code, if the code_type is SQL. This helps Coalesce Quality understand the specific SQL syntax and features being used.
content	string	The actual content of the code. This can be SQL queries, Python scripts, dbt models, or any other supported code format.
oneof _code_name.code_name	optional string	Optional human-readable name for the code piece that can be used for display purposes. Might also indicate name of the file.
oneof _file_path.file_path	optional string	Optional path in e.g. git or project directory which is source of the code

TypeTraits

(synq.entities.v1.TypeTraits) TypeTraits are the behavioral traits a custom entity Type can declare. Declaring a trait makes every entity of that type behave platform-wide as if it carried the trait natively (e.g. is_model => transformation-model ranking, monitorability and lineage). Every field is optional so an unset trait means “not declared, fall through to the trait default” — distinct from an explicit false. An unset/nil message means no declared traits (every trait at its default).

Field	Type	Description
oneof _is_model.is_model	optional bool	model-like: the dbt-model / Coalesce-node / SQLMesh-model analog. Default when unset: false.
oneof _is_source.is_source	optional bool	source-like: an external/raw input to the transformation graph. Default when unset: false.
oneof _is_bi_like.is_bi_like	optional bool	BI-like: a dashboard, report or other business-intelligence artifact. Default when unset: false.
oneof _is_test_type.is_test_type	optional bool	check-like: pairs with declarative checks. Default when unset: false.
oneof _is_ignored_in_lineage.is_ignored_in_lineage	optional bool	excluded from lineage rendering. Default when unset: false.

Schema

(synq.entities.v1.Schema) Schema represents a schema of a table like entity

Field	Type	Description
workspace	string	Immutable workspace identifier that this entity belongs to.
id	Identifier	Unique identifier for this entity.
synq_path	string	Coalesce Quality Path to the entity. This is a unique path that can be used to access the entity in the Coalesce Quality UI.
state_at	Timestamp	Time when the schema was defined.
oneof _description.description	optional string	Optional description of the schema, might differ from the entity itself
columns	repeated SchemaColumn	Columns of the schema

SchemaColumn

(synq.entities.v1.SchemaColumn)

Field	Type	Description
name	string	Human readable name of the column as present in dbt or data warehouse.
native_type	string	Native data type of the column as present in data warehouse.
description	string	Description of the column
ordinal_position	int32	Ordinal position of the column in the table, starting from 1
is_struct	bool	Indicates that the column type could be used as a struct/json in a data warehouse
is_repeated	bool	Indicates that the column is a repeated field in a data warehouse (e.g. array)
fields	repeated SchemaColumnField	Fields inside of the struct/record like column

SchemaColumnField

(synq.entities.v1.SchemaColumnField)

Field	Type	Description
name	string	Human readable name of the column as present in dbt or data warehouse.
native_type	string	Native data type of the column as present in data warehouse.
description	string	Description of the column
ordinal_position	int32	Ordinal position of the column in the struct, starting from 1
is_struct	bool	Indicates that the field type could be used as a struct/json in a data warehouse
is_repeated	bool	Indicates that the field is a repeated field in a data warehouse (e.g. array)
fields	repeated SchemaColumnField	Fields inside of the struct/record like field

AirflowDagIdentifier

(synq.entities.v1.AirflowDagIdentifier)

Field	Type	Description
integration_id	string	Coalesce Quality integration_id that identifies the Airflow instance
dag_id	string	Airflow dag_id that identifies the DAG

AirflowTaskIdentifier

(synq.entities.v1.AirflowTaskIdentifier)

Field	Type	Description
integration_id	string	Coalesce Quality integration_id that identifies the Airflow instance
dag_id	string	Airflow dag_id that identifies the DAG
task_id	string	Airflow task_id that identifies the task within the DAG

AthenaTableIdentifier

(synq.entities.v1.AthenaTableIdentifier)

Field	Type	Description
instance	string	AWS account and region the Athena workgroup runs in, formatted as “<account-id>.<region>” (e.g. “123456789012.eu-west-1”). Auto-derived from sts:GetCallerIdentity at integration setup time.
catalog	string	Glue Data Catalog name. Almost always “AwsDataCatalog” — the default catalog for Athena unless the customer registered a federated catalog.
database	string	Glue database (the namespace users typically filter on).
table	string	Glue table or view name.

BigqueryTableIdentifier

(synq.entities.v1.BigqueryTableIdentifier)

Field	Type	Description
project	string	BigQuery project
dataset	string	BigQuery dataset id
table	string	BigQuery table name

ClickhouseTableIdentifier

(synq.entities.v1.ClickhouseTableIdentifier)

Field	Type	Description
host	string	Clickhouse hostname without port
schema	string	Clickhouse database
table	string	Clickhouse table

CustomIdentifier

(synq.entities.v1.CustomIdentifier)

Field	Type	Description
id	string	Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

DatabricksTableIdentifier

(synq.entities.v1.DatabricksTableIdentifier)

Field	Type	Description
workspace	string	URL of Databricks workspace
catalog	string	Databricks catalog
schema	string	Databricks schema
table	string	Databricks table or view

DataproductIdentifier

(synq.entities.v1.DataproductIdentifier)

Field	Type	Description
id	string	Dataproduct id that identifies the Dataproduct

DbtCloudNodeIdentifier

(synq.entities.v1.DbtCloudNodeIdentifier)

Field	Type	Description
project_id	string	Your dbt Cloud project id
account_id	string	Your dbt Cloud account id
node_id	string	Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

DbtCoreNodeIdentifier

(synq.entities.v1.DbtCoreNodeIdentifier)

Field	Type	Description
integration_id	string	Opaque identifier of the dbt Core project. Usually the Coalesce Quality integration id (a UUID), but may also be the dbt project name from manifest.json when the integration is configured to identify assets by project name. Treat it as an opaque string, not a UUID.
node_id	string	Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

FabricTableIdentifier

(synq.entities.v1.FabricTableIdentifier) Microsoft Fabric warehouse/lakehouse table identifier. Fabric is workspace-scoped with cross-database three-part [database].[schema].[table] T-SQL names.

Field	Type	Description
instance	string	Workspace SQL analytics endpoint host, e.g. “<workspace-id>.datawarehouse.fabric.microsoft.com”.
database	string	Fabric warehouse / lakehouse (database).
schema	string	Schema within the database.
table	string	Table or view name.
workspace_id	string	Fabric workspace GUID, decoded from the endpoint host in `instance`. Optional and informational: the table is addressed by instance/database/schema/table, so leave it empty if you don’t have it — it does not affect how the identifier resolves.
tenant_id	string	Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance`. Optional and informational, like workspace_id.

Identifier

(synq.entities.v1.Identifier) Identifier is a unique reference to an entity in Coalesce Quality 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.

Field	Type	Description
oneof id.dbt_core_node	DbtCoreNodeIdentifier	Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Core project
oneof id.dbt_cloud_node	DbtCloudNodeIdentifier	Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Cloud project
oneof id.bigquery_table	BigqueryTableIdentifier	BigQuery table identifier
oneof id.snowflake_table	SnowflakeTableIdentifier	Snowflake table identifier
oneof id.redshift_table	RedshiftTableIdentifier	Redshift table identifier
oneof id.postgres_table	PostgresTableIdentifier	Postgres table identifier
oneof id.mysql_table	MysqlTableIdentifier	Mysql table identifier
oneof id.clickhouse_table	ClickhouseTableIdentifier	Clickhouse table identifier
oneof id.airflow_dag	AirflowDagIdentifier	Airflow DAG identifier
oneof id.airflow_task	AirflowTaskIdentifier	Airflow task identifier within a given DAG
oneof id.custom	CustomIdentifier	Custom identifier to be used with all custom created entities
oneof id.dataproduct	DataproductIdentifier	Dataproduct identifier
oneof id.synq_path	SynqPathIdentifier	SynqPath identifier
oneof id.databricks_table	DatabricksTableIdentifier	Databricks table identifier
oneof id.trino_table	TrinoTableIdentifier	Trino table identifier
oneof id.sql_mesh_model	SqlMeshModelIdentifier	SQLMesh Model identifier
oneof id.sql_mesh_audit	SqlMeshAuditIdentifier	SQLMesh Audit identifier
oneof id.monitor	MonitorIdentifier	Monitor identifier
oneof id.mssql_table	MssqlTableIdentifier	SQL Server table identifier
oneof id.oracle_table	OracleTableIdentifier	Oracle table identifier
oneof id.athena_table	AthenaTableIdentifier	Amazon Athena (Glue) table identifier
oneof id.saved_view	SavedViewIdentifier	Saved view identifier
oneof id.fabric_table	FabricTableIdentifier	Microsoft Fabric table identifier

MonitorIdentifier

(synq.entities.v1.MonitorIdentifier)

Field	Type	Description
monitored_id	Identifier	Identifier of the monitored entity
monitor_id	string	Identifier of the monitor
oneof _segment.segment	optional string	Optional monitor segmentation identifier
oneof _integration_id.integration_id	optional string	Coalesce Quality integration_id of the monitored identifier

MssqlTableIdentifier

(synq.entities.v1.MssqlTableIdentifier)

Field	Type	Description
host	string	Hostname of the SQL Server instance
database	string	SQL Server database
schema	string	SQL Server schema (e.g. “dbo”)
table	string	SQL Server table or view

MysqlTableIdentifier

(synq.entities.v1.MysqlTableIdentifier)

Field	Type	Description
host	string	Mysql hostname without port
schema	string	Mysql database
table	string	Mysql table

OracleTableIdentifier

(synq.entities.v1.OracleTableIdentifier)

Field	Type	Description
host	string	Hostname of the Oracle instance
service_name	string	Oracle service name (PDB)
schema	string	Oracle schema (= owning user)
table	string	Oracle table or view

OwnerIdentifier

(synq.entities.v1.OwnerIdentifier)

Field	Type	Description
id	string	Owner id that identifies the Owner

PostgresTableIdentifier

(synq.entities.v1.PostgresTableIdentifier)

Field	Type	Description
host	string	Postgres hostname without port
database	string	Postgres database
schema	string	Postgres schema
table	string	Postgres table

RedshiftTableIdentifier

(synq.entities.v1.RedshiftTableIdentifier)

Field	Type	Description
cluster	string	Redshift cluster
database	string	Redshift database
schema	string	Redshift schema
table	string	Redshift table

SavedViewIdentifier

(synq.entities.v1.SavedViewIdentifier)

Field	Type	Description
id	string	Saved view id (client-supplied UUID) that identifies the saved view

SnowflakeTableIdentifier

(synq.entities.v1.SnowflakeTableIdentifier)

Field	Type	Description
account	string	Snowflake account
database	string	Snowflake database
schema	string	Snowflake schema
table	string	Snowflake table

SqlMeshAuditIdentifier

(synq.entities.v1.SqlMeshAuditIdentifier)

Field	Type	Description
integration_id	string	Coalesce Quality integration_id that identifies the dbt Core project
fqn	string	SQLMesh model fully qualified name
audit_id	string	Identifier of the audit

SqlMeshModelIdentifier

(synq.entities.v1.SqlMeshModelIdentifier)

Field	Type	Description
integration_id	string	Coalesce Quality integration_id that identifies the dbt Core project
fqn	string	SQLMesh model fully qualified name

SynqPathIdentifier

(synq.entities.v1.SynqPathIdentifier)

Field	Type	Description
path	string	Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths

TrinoTableIdentifier

(synq.entities.v1.TrinoTableIdentifier)

Field	Type	Description
host	string	Hostname of the Trino instance
catalog	string	Trino catalog
schema	string	Trino schema
table	string	Trino table or view

EntityChange

(synq.entities.v1.EntityChange) EntityChange represents a change detected in an entity within the system. It tracks modifications to entities like Git commits, SQL definitions, and database schemas.

Field	Type	Description
entity_id	Identifier	Identifier of the entity on which the change was detected when available.
oneof _entity_synq_path.entity_synq_path	optional string	Coalesce Quality path representing entity on which the change was detected when available,
affected_entities	repeated Identifier	Identifiers of entities directly affected by this change.
affected_entities_synq_paths	repeated string	Coalesce Quality paths of entities directly affected by this change.
change_id	string	Internal identifier of the change event.
change_detected_at	Timestamp	Timestamp when the change was detected by Coalesce Quality.
oneof change_type.git_commit	GitCommitChange	none
oneof change_type.sql_definition	SqlDefinitionChange	none
oneof change_type.schema	SchemaChange	none

GitCommitChange

(synq.entities.v1.GitCommitChange) GitCommitChange represents a change detected in a Git repository.

Field	Type	Description
hash	string	Hash of the Git commit.
author	Signature	Author information of the Git commit.
committer	Signature	Committer information of the Git commit.
message	string	Commit message describing the changes.
short_message	string	First non-empty line of the message
file_change_stats	map FileChangeStatsEntry	Statistics about changes made to each modified file.
changed_file_paths	repeated string	All file paths changed in this commit (complete list). For commits with many files, this may be a large array.
related_changed_file_paths	repeated string	File paths that directly affect the queried entity (filtered subset of changed_file_paths). When querying changes for a specific entity (e.g., dbt model “customers”), this contains only the files that directly impact that entity (e.g., “models/customers.sql”, “models/staging/stg_customers.sql”). Empty when retrieving a change by change_id directly (not scoped to a specific entity). Empty when it’s impossible to determine entity-specific file mappings. Example: If a commit changes 50 files but only 2 affect your queried dbt model, this contains those 2 files.
oneof _branch_name.branch_name	optional string	Name of the branch associated with the commit, if any.
clone_url	string	URL of the Git repository where the commit was made.
oneof _web_commit_url.web_commit_url	optional string	URL to e.g. Github which opens the Commit
directory_changes	repeated DirectoryChangeSummary	Hierarchical directory summaries showing where changes occurred.
changes_by_file_type	map ChangesByFileTypeEntry	Aggregated statistics by file type/extension.
oneof _statistics.statistics	optional ChangeStatistics	Overall statistical summary of the commit.

GitCommitChange.ChangeStatistics

(synq.entities.v1.GitCommitChange.ChangeStatistics) ChangeStatistics provides statistical summaries of the entire commit.

Field	Type	Description
total_files	int32	Total number of files changed.
total_lines_added	int32	Total lines added across all files.
total_lines_removed	int32	Total lines removed across all files.
distribution	FileChangeDistribution	Distribution of changes by magnitude.
top_changes	repeated TopChange	Top 10 files by total lines changed.

GitCommitChange.ChangeStats

(synq.entities.v1.GitCommitChange.ChangeStats) ChangeStats contains statistics about changes made to a single file.

Field	Type	Description
additions	int32	Number of lines added to the file.
deletions	int32	Number of lines removed from the file.

GitCommitChange.ChangesByFileTypeEntry

(synq.entities.v1.GitCommitChange.ChangesByFileTypeEntry)

Field	Type	Description
key	string	none
value	FileTypeChangeSummary	none

GitCommitChange.DirectoryChangeSummary

(synq.entities.v1.GitCommitChange.DirectoryChangeSummary) DirectoryChangeSummary provides hierarchical directory-level statistics.

Field	Type	Description
directory_path	string	Path of the directory.
files_changed	int32	Number of files changed in this directory (excluding subdirectories).
total_lines_added	int32	Total lines added in this directory (excluding subdirectories).
total_lines_removed	int32	Total lines removed in this directory (excluding subdirectories).
subdirs	repeated DirectoryChangeSummary	Subdirectory summaries.
top_files	repeated TopFileChange	Top 3-5 most significant file changes in this directory.

GitCommitChange.FileChangeDistribution

(synq.entities.v1.GitCommitChange.FileChangeDistribution) FileChangeDistribution categorizes files by change magnitude.

Field	Type	Description
files_with_small_changes	int32	Files with fewer than 10 lines changed.
files_with_medium_changes	int32	Files with 10-100 lines changed.
files_with_large_changes	int32	Files with more than 100 lines changed.
files_added	int32	Files that were newly added.
files_modified	int32	Files that were modified.
files_deleted	int32	Files that were deleted.

GitCommitChange.FileChangeStatsEntry

(synq.entities.v1.GitCommitChange.FileChangeStatsEntry)

Field	Type	Description
key	string	none
value	ChangeStats	none

GitCommitChange.FileTypeChangeSummary

(synq.entities.v1.GitCommitChange.FileTypeChangeSummary) FileTypeChangeSummary aggregates changes by file type/extension.

Field	Type	Description
file_extension	string	File extension (e.g., “.sql”, “.py”, “.yml”).
files_count	int32	Number of files with this extension that were changed.
total_lines_added	int32	Total lines added across all files of this type.
total_lines_removed	int32	Total lines removed across all files of this type.
example_files	repeated string	Example file paths (up to 5) showing where these changes occurred.
common_directories	repeated string	Common directories where files of this type were modified.

GitCommitChange.Signature

(synq.entities.v1.GitCommitChange.Signature) Signature contains information about the Git user who made the changes.

Field	Type	Description
name	string	Name of the Git user.
email	string	Email address of the Git user.
created_at	Timestamp	Timestamp when the signature was created.

GitCommitChange.TopChange

(synq.entities.v1.GitCommitChange.TopChange) TopChange represents one of the most significant file changes.

Field	Type	Description
file_path	string	Path of the file.
lines_added	int32	Lines added.
lines_removed	int32	Lines removed.
total_lines_changed	int32	Total lines changed (added + removed).

GitCommitChange.TopFileChange

(synq.entities.v1.GitCommitChange.TopFileChange) TopFileChange represents a significant file change within a directory.

Field	Type	Description
file_path	string	Path of the file relative to the directory.
lines_added	int32	Number of lines added.
lines_removed	int32	Number of lines removed.

SchemaChange

(synq.entities.v1.SchemaChange) SchemaChange represents a change detected in a database schema.

Field	Type	Description
column_changes	repeated SchemaColumnChange	List of changes made to individual columns in the schema.

SchemaColumnChange

(synq.entities.v1.SchemaColumnChange) SchemaColumnChange represents a specific change to a column in the schema.

Field	Type	Description
oneof column_change.column_addition	ColumnAdditionChangeType	none
oneof column_change.column_native_type	ColumnNativeTypeChangeType	none
oneof column_change.column_removal	ColumnRemovalChangeType	none

SchemaColumnChange.ColumnAdditionChangeType

(synq.entities.v1.SchemaColumnChange.ColumnAdditionChangeType) ColumnAdditionChangeType represents the addition of a new column to the schema.

Field	Type	Description
column_id	string	Identifier of the new column.
native_type	string	Data type of the new column.
ordinal_position	int32	Position where the column was added in the schema.

SchemaColumnChange.ColumnNativeTypeChangeType

(synq.entities.v1.SchemaColumnChange.ColumnNativeTypeChangeType) ColumnNativeTypeChangeType represents a change in a column’s data type.

Field	Type	Description
column_id	string	Identifier of the modified column.
previous_native_type	string	Previous data type of the column.
current_native_type	string	New data type of the column.

SchemaColumnChange.ColumnRemovalChangeType

(synq.entities.v1.SchemaColumnChange.ColumnRemovalChangeType) ColumnRemovalChangeType represents the removal of a column from the schema.

Field	Type	Description
column_id	string	Identifier of the removed column.
native_type	string	Native data type of the removed column.
ordinal_position	int32	Original position of the column in the schema.

SqlDefinitionChange

(synq.entities.v1.SqlDefinitionChange) SqlDefinitionChange represents a change detected in a SQL definition.

Field	Type	Description
previous_sql	string	Previous version of the SQL definition.
previous_sql_state_at	Timestamp	Timestamp when the previous SQL state was valid.
current_sql	string	Current version of the SQL definition.
current_sql_state_at	Timestamp	Timestamp when the current SQL state became valid.
sql_diff	string	Diff showing the changes between previous and current SQL.

Annotation

(synq.entities.v1.Annotation) Annotations can be used to annotate any entity with a key:value pair. These annotations can be used for filtering and searching entities.

Field	Type	Description
name	string	String key for the annotation.
values	repeated string	Optional list of values that the annotation can carry.

ForeignKeyReference

(synq.entities.v1.ForeignKeyReference) ForeignKeyReference describes the target of a foreign key constraint.

Field	Type	Description
database	string	Target database name
schema	string	Target schema name
table	string	Target table name
columns	repeated string	Target column names in the referenced table

TableConstraint

(synq.entities.v1.TableConstraint) TableConstraint represents a single constraint or index on a database table.

Field	Type	Description
name	string	Name of the constraint or index
type	TableConstraintType	Type of the constraint (best-effort mapping to enum)
columns	repeated string	Column names involved in this constraint or index
oneof _foreign_key_reference.foreign_key_reference	optional ForeignKeyReference	Foreign key reference details (only set when type is FOREIGN_KEY)
index_type	string	Index type (e.g. “btree”, “hash”, “gin”, “gist”) - only relevant for INDEX type
expression	string	Expression for check constraints or expression-based indexes
is_unique	bool	Whether this constraint or index enforces uniqueness
raw_type	string	Raw constraint type string from the data warehouse (e.g. “PRIMARY KEY”, “SORTING KEY”, “PARTITION BY”, “CLUSTER BY”, “DISTRIBUTION KEY”, “PROJECTION”, “INDEX”, “UNIQUE INDEX”). Preserved verbatim for consumers that need platform-specific details beyond the enum.
oneof _is_enforced.is_enforced	optional bool	Whether this constraint is enforced by the database. nil/unset = unknown, true = enforced, false = not enforced (e.g. Snowflake NORELY, Oracle DISABLED).

Type

(synq.entities.v1.Type) Custom entity type that is used to categorize custom entities.

Field	Type	Description
workspace	string	Immutable workspace identifier that this custom entity type belongs to.
type_id	int32	none
name	string	Name of the custom entity type that is displayed to the user.
svg_icon	bytes	SVG icon of the custom entity type that is displayed to the user.
svg_icon_id	string	Coalesce Quality identifier used for CDN purposes, read-only.
created_at	Timestamp	Timestamp when the custom entity type was created.
updated_at	Timestamp	Timestamp when the custom entity type was last updated.
deleted_at	Timestamp	Timestamp when the custom entity type was deleted. If this is set, the custom entity type is considered deleted.
traits	TypeTraits	Behavioral traits declared on this type. Every entity of the type inherits them: declaring is_model, for example, makes its entities rank and behave as transformation models (canonical-entity ranking, monitorability, lineage), the same way a dbt model does. Unset means no declared traits (all false).

Entity

(synq.entities.v1.Entity) Entity is the base type for all entities in the system. Its always attached to a given client workspace and can be uniquely identified by its id.

Field	Type	Description
workspace	string	Immutable workspace identifier that this entity belongs to.
id	Identifier	Unique identifier for this entity.
type_id	int32	Id of custom type or default type when 0, ignored for non-custom entities
oneof _entity_type.entity_type	optional EntityType	Information about entity type
name	string	Name of the entity that is displayed to the user.
description	string	Description of the entity that is displayed in relevant contexts. Can contain Markdown.
created_at	Timestamp	Timestamp when the entity was created.
updated_at	Timestamp	Timestamp when the entity was last updated.
deleted_at	Timestamp	Timestamp when the entity was deleted. If this is set, the entity is considered deleted.
synq_path	string	Return only value. Coalesce Quality Path to the entity. This is a unique path that can be used to access the entity in the Coalesce Quality UI.
synq_catalog_url	string	Return only value. Coalesce Quality URL to the entity. This is a unique URL that can be used to access the entity in the Coalesce Quality UI.
ids	repeated Identifier	Return only value. All identifiers of entities which are tightly related
synq_paths	repeated string	Return only value. Coalesce Quality Path to the all identifiers of entities which are tightly related
annotations	repeated Annotation	Annotations attached to the entity. Annotations are key-value pairs that can be used to store metadata about the entity.
is_dwh_table	bool	none
is_dwh_view	bool	none

BatchOrchestrationRequest

(synq.entities.orchestration.v1.BatchOrchestrationRequest)

Field	Type	Description
entities	repeated Identifier	Entities to query for orchestration relationships (e.g., Airflow tasks, dbt models, SQLMesh models, tables)

BatchOrchestrationResponse

(synq.entities.orchestration.v1.BatchOrchestrationResponse)

Field	Type	Description
orchestrations	repeated Orchestration	Orchestration relationships for each requested entity. The order corresponds to the order of entities in the request.

Orchestration

(synq.entities.orchestration.v1.Orchestration) Orchestration represents the orchestration relationships for a given entity. It shows both what the entity orchestrates (downstream) and what orchestrates it (upstream).

Field	Type	Description
entity	OrchestrationGroup	The entity being queried along with its other identities. For example, if querying a dbt or SQLMesh model, this group includes both the model and the table it creates, as they represent the same logical concept.
downstream	repeated OrchestrationGroup	Downstream entities that this entity orchestrates. Each group contains all identities of the orchestrated concept. Examples: - If entity is an Airflow task: groups containing [dbt model, table] or [SQLMesh model, table] - If entity is an Airflow task: groups containing downstream Airflow tasks and their orchestrated entities
upstream	repeated OrchestrationGroup	Upstream entities that orchestrate this entity. Each group contains all identities of the orchestrating concept. Examples: - If entity is a dbt/SQLMesh model or table: groups containing the Airflow task that executes it - If entity is an Airflow task: groups containing upstream Airflow tasks that trigger it

OrchestrationGroup

(synq.entities.orchestration.v1.OrchestrationGroup) OrchestrationGroup represents different identities of the same logical concept. For example, a dbt model and the table it creates are different representations of the same entity, so they appear together in one group. An Airflow task typically has only one identity (the task itself).

Field	Type	Description
entities	repeated Identifier	Identifiers of all representations of this logical entity. Examples: - For a dbt model: [dbt model, table it creates] - For a SQLMesh model: [SQLMesh model, table it creates] - For an Airflow task: [Airflow task]
synq_paths	repeated string	Coalesce Quality paths of the entities for easier reference, in the same order as entities

CheckCategory

(synq.entities.checks.v1.CheckCategory) CheckCategory is the complete explicit category state for one check, carrying both dimensions. It overrides the categories the categorisation rules would otherwise compute for the check.

Field	Type	Description
check_path	string	check_path of the check this applies to (matches the check’s identifier in the catalogue).
category	string	Explicit structural category (empty = no explicit structural category; the rule-computed one is used instead).
governance_category	string	Explicit governance category (empty = no explicit governance category; the rule-computed one is used instead).
actor_identity	string	Identity of the actor that last set this category. Server-derived from the request context; ignored on input.
updated_at	Timestamp	When this category was last updated. Server-set; ignored on input.

DeleteCheckCategoriesRequest

(synq.entities.checks.v1.DeleteCheckCategoriesRequest)

Field	Type	Description
check_paths	repeated string	check_paths whose explicit categories (both dimensions) should be cleared.

DeleteCheckCategoriesResponse

(synq.entities.checks.v1.DeleteCheckCategoriesResponse)

ListCheckCategoriesRequest

(synq.entities.checks.v1.ListCheckCategoriesRequest)

ListCheckCategoriesResponse

(synq.entities.checks.v1.ListCheckCategoriesResponse)

Field	Type	Description
categories	repeated CheckCategory	none

UpsertCheckCategoriesRequest

(synq.entities.checks.v1.UpsertCheckCategoriesRequest)

Field	Type	Description
categories	repeated CheckCategory	none

UpsertCheckCategoriesResponse

(synq.entities.checks.v1.UpsertCheckCategoriesResponse)

Field	Type	Description
categories	repeated CheckCategory	Echoed categories with server-set actor_identity / updated_at.

GetCoverageRequest

(synq.entities.checks.v1.GetCoverageRequest) GetCoverageRequest contains the parameters needed to retrieve check coverage for a specific entity.

Field	Type	Description
id	Identifier	Identifier of the entity to get checks coverage for. This can be a path identifier that uniquely identifies the entity in the system.
propagation_filter	PropagationFilter	Filter to control which checks are included in the coverage response. Default (UNSPECIFIED) returns both direct and propagated checks.

GetCoverageResponse

(synq.entities.checks.v1.GetCoverageResponse) GetCoverageResponse contains the check coverage information for the requested entity.

Field	Type	Description
coverage	ChecksSummary	The complete coverage information for the requested entity.

GetCoverageResponse.ChecksSummary

(synq.entities.checks.v1.GetCoverageResponse.ChecksSummary) ChecksSummary provides a comprehensive overview of checks and their coverage.

Field	Type	Description
all_columns	repeated string	List of all column names in the entity.
table_checks	repeated CheckEntity	List of table-level checks applied to this entity.
propagated_table_checks	repeated PropagatedTableCheck	List of table-level checks propagated from upstream entities.
column_info	repeated ColumnInformation	Detailed information about each column in the entity.

GetCoverageResponse.ChecksSummary.ColumnInformation

(synq.entities.checks.v1.GetCoverageResponse.ChecksSummary.ColumnInformation) ColumnInformation contains detailed information about a specific column.

Field	Type	Description
name	string	Human readable name of the column as present in dbt or data warehouse.
native_type	string	Native data type of the column as present in data warehouse.
direct_check_entities	repeated CheckEntity	Checks running on current model on this column
propagated_check_entities	repeated PropagatedColumnCheck	Checks running on upstream model column, where this is a passthrough of it
is_transformed	bool	Indicates that there is an expression transforming the data
is_renamed	bool	Indicates that there is a rename operation
is_passthrough	bool	Indicates that there is no transformation or rename
used_by_downstream	bool	Is this column used by any downstream model column
referenced_by_downstream	bool	Is any downstream model referencing this column e.g. in WHERE
using_upstream	bool	Does this column pull any data from upstream
referencing_upstream	bool	Does this column reference any columns in upstream
downstream_usage	ColumnUsage	Statistics about column impact

GetCoverageResponse.ColumnUpstream

(synq.entities.checks.v1.GetCoverageResponse.ColumnUpstream) ColumnUpstream represents an upstream column that a check is propagated from.

Field	Type	Description
id	Identifier	Identifier of the upstream entity.
column	string	Name of the column in the upstream entity.

GetCoverageResponse.ColumnUsage

(synq.entities.checks.v1.GetCoverageResponse.ColumnUsage) ColumnUsage contains statistics about how a column is used by downstream entities.

Field	Type	Description
used_as_data_direct	int32	Number of times this column is directly used as data.
used_as_data_cumulative	int32	Total number of times this column is used as data (including indirect usage).
used_as_logic_direct	int32	Number of times this column is directly used in logic (e.g., WHERE clauses).
used_as_logic_cumulative	int32	Total number of times this column is used in logic (including indirect usage).

GetCoverageResponse.PropagatedColumnCheck

(synq.entities.checks.v1.GetCoverageResponse.PropagatedColumnCheck) PropagatedColumnCheck represents a check that is propagated from an upstream column.

Field	Type	Description
check	CheckEntity	The check entity being propagated.
propagation	repeated ColumnUpstream	List of upstream columns where this check originates from.

GetCoverageResponse.PropagatedColumnChecks

(synq.entities.checks.v1.GetCoverageResponse.PropagatedColumnChecks) PropagatedColumnChecks contains a list of checks propagated from upstream columns.

Field	Type	Description
checks	repeated PropagatedColumnCheck	List of propagated column checks.

GetCoverageResponse.PropagatedTableCheck

(synq.entities.checks.v1.GetCoverageResponse.PropagatedTableCheck) PropagatedTableCheck represents a check that is propagated from an upstream table.

Field	Type	Description
check	CheckEntity	The check entity being propagated.
upstream_ids	repeated Identifier	List of upstream entity identifiers where this check originates from.

CheckEntity

(synq.entities.checks.v1.CheckEntity)

Field	Type	Description
check_id	Identifier	Identifier of the check
name	string	The name of the check
oneof _package.package	optional string	The package of the check, e.g. “dbt”, “sqlmesh”, “dbt-utils”
kind	string	General kind of the test, e.g. “not_null”, “unique”, “foreign_key”
entity_type	EntityType	Entity type of the check itself, e.g. ENTITY_TYPE_DBT_TEST. ENTITY_TYPE_UNSPECIFIED when the type is unknown.
data_platform_type	DataPlatformType	Platform the check runs on, e.g. DATA_PLATFORM_TYPE_DBT. DATA_PLATFORM_TYPE_UNSPECIFIED when the platform is unknown.
is_platform_native	bool	Whether the check is platform native
oneof _category.category	optional string	Explicit name of the structural category to use for this check
oneof _governance_category.governance_category	optional string	Explicit name of the governance category to use for this check

Code

(synq.entities.custom.features.v1.Code) Code feature represents a code snippet associated with the entity. If support for code parsing and dependency extraction is needed use SqlDefinition.

Field	Type	Description
name	string	Might be e.g. name of the file or a function.
code_type	CodeType	Type of the code.
content	string	Content of the code. Displayed in the UI.

Schema

(synq.entities.custom.features.v1.Schema) Schema represents a schema of a table like entity

Field	Type	Description
state_at	Timestamp	Time when the schema was defined, will default to `now` if not set.
columns	repeated SchemaColumn	Columns of the schema Columns are ordered by ordinal_position, it has to be defined for all or none of the columns, when not defined, ordinal positions are attached according to the order of columns in the list.

CheckCategory

(synq.entities.custom.features.v1.CheckCategory) Checks feature indicates that the entity is testing in some way different entity. To define the kind of the check use the kind field. The package field is optional. It is used to categorize the entities which check other entities.

Field	Type	Description
package	string	Grouping of check kinds. e.g. “gcs”, “sql”, “queue”
kind	string	Kind of the check. e.g “not_null”, “unique”, “foreign_key”, “row_count”.
oneof _category.category	optional string	Explicit name of the Check category. If it is not defined categorisation rules are applied based on package + kind.

GitFileReference

(synq.entities.custom.features.v1.GitFileReference) GitFileReference represents a reference to a file in a git repository.

Field	Type	Description
repository_url	string	URL of the git repository. Preferably SSH clone URL.
branch_name	string	Name of the branch in the git repository.
file_path	string	Path to the file in the git repository.

SqlDefinition

(synq.entities.custom.features.v1.SqlDefinition) SqlDefinition is a feature that allows to define lineage via SQL for a custom entity. Used to generate dependencies and other metadata. If parsed successfully, it will provide a code and column level lineage. Can be used to define simplified transformation of data which component performs using e.g. INSERT INTO foo SELECT * FROM bar.

Field	Type	Description
state_at	Timestamp	Time when the sql was defined, will default to `now` if not set.
dialect	SqlDialect	SQL dialect used in the SQL.
sql	string	Final form of the SQL as executed in the database/data warehouse. Must be a valid SQL in the selected dialect.
oneof _database_context.database_context	optional DatabaseContext	Optional database context for resolving unqualified table references in the SQL. When provided, helps CLL resolve schema-qualified references (e.g. `PROD.TABLE_NAME`) to the correct database instance and catalog.

DeleteTypeRequest

(synq.entities.custom.v1.DeleteTypeRequest)

Field	Type	Description
type_id	int32	Identifier of the custom entity type to delete.

DeleteTypeResponse

(synq.entities.custom.v1.DeleteTypeResponse)

ListTypesRequest

(synq.entities.custom.v1.ListTypesRequest)

ListTypesResponse

(synq.entities.custom.v1.ListTypesResponse)

Field	Type	Description
types	repeated Type	List of entities.

UpsertTypeRequest

(synq.entities.custom.v1.UpsertTypeRequest)

Field	Type	Description
type	Type	Entity to create or update.

UpsertTypeResponse

(synq.entities.custom.v1.UpsertTypeResponse)

Execution

(synq.entities.custom.v1.Execution)

Field	Type	Description
id	Identifier	none
status	ExecutionStatus	none
message	string	none
created_at	Timestamp	none
started_at	Timestamp	none
finished_at	Timestamp	none
annotations	repeated Annotation	none
extras	repeated ExecutionExtra	none

ExecutionExtra

(synq.entities.custom.v1.ExecutionExtra)

Field	Type	Description
oneof extra.executed_sql	string	none

LogEntry

(synq.entities.custom.v1.LogEntry)

Field	Type	Description
id	Identifier	none
message	string	none
created_at	Timestamp	none
started_at	Timestamp	none
finished_at	Timestamp	none
annotations	repeated Annotation	none

UpsertExecutionRequest

(synq.entities.custom.v1.UpsertExecutionRequest)

Field	Type	Description
execution	Execution	none

UpsertExecutionResponse

(synq.entities.custom.v1.UpsertExecutionResponse)

UpsertLogEntryRequest

(synq.entities.custom.v1.UpsertLogEntryRequest)

Field	Type	Description
log_entry	LogEntry	none

UpsertLogEntryResponse

(synq.entities.custom.v1.UpsertLogEntryResponse)

DeleteEntityRequest

(synq.entities.custom.v1.DeleteEntityRequest) DeleteEntityRequest is the request message for the DeleteEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to delete.

DeleteEntityResponse

(synq.entities.custom.v1.DeleteEntityResponse) DeleteEntityResponse is the response message for the DeleteEntity method.

ListEntitiesRequest

(synq.entities.custom.v1.ListEntitiesRequest)

ListEntitiesResponse

(synq.entities.custom.v1.ListEntitiesResponse)

Field	Type	Description
entities	repeated Entity	none

UpsertEntityRequest

(synq.entities.custom.v1.UpsertEntityRequest) UpsertEntityRequest is the request message for the UpsertEntity method.

Field	Type	Description
entity	Entity	The entity to create or update.

UpsertEntityResponse

(synq.entities.custom.v1.UpsertEntityResponse) UpsertEntityResponse is the response message for the UpsertEntity method.

DeleteEntityFeatureRequest

(synq.entities.custom.v1.DeleteEntityFeatureRequest)

Field	Type	Description
entity_id	Identifier	Identifier of the entity to delete feature from.
feature_id	string	Identifier of the feature to delete.

DeleteEntityFeatureResponse

(synq.entities.custom.v1.DeleteEntityFeatureResponse)

Feature

(synq.entities.custom.v1.Feature)

Field	Type	Description
workspace	string	Immutable workspace identifier that this entity belongs to.
entity_id	Identifier	The identifier of the entity to create or update feature for.
feature_id	string	Identifier of the feature. Can be any string, e.g. “sql” for SQL feature. Use same identifier to update the feature. Do not use random identifier as it will create a new feature on every update.
oneof feature.sql_definition	SqlDefinition	Only one feature per entity.
oneof feature.git_file_reference	GitFileReference	Multiple features per entity.
oneof feature.code	Code	Multiple features per entity.
oneof feature.schema	Schema	Only one feature per entity.
oneof feature.check_category	CheckCategory	Only one feature per entity.
created_at	Timestamp	Timestamp when the entity was created.
updated_at	Timestamp	Timestamp when the entity was last updated.
deleted_at	Timestamp	Timestamp when the entity was deleted. If this is set, the entity is considered deleted.

ListEntityFeaturesRequest

(synq.entities.custom.v1.ListEntityFeaturesRequest)

Field	Type	Description
entity_id	Identifier	Identifier of the entity to get features for.

ListEntityFeaturesResponse

(synq.entities.custom.v1.ListEntityFeaturesResponse)

Field	Type	Description
features	repeated Feature	List of features for the entity.

UpsertEntityFeatureRequest

(synq.entities.custom.v1.UpsertEntityFeatureRequest)

Field	Type	Description
feature	Feature	The feature to create or update.

UpsertEntityFeatureResponse

(synq.entities.custom.v1.UpsertEntityFeatureResponse)

DeleteEntitiesGroupRequest

(synq.entities.custom.v1.DeleteEntitiesGroupRequest)

Field	Type	Description
group_id	string	none

DeleteEntitiesGroupResponse

(synq.entities.custom.v1.DeleteEntitiesGroupResponse)

Group

(synq.entities.custom.v1.Group) Group is a collection of entities.

Field	Type	Description
group_id	string	Identifier of the group.
entity_ids	repeated Identifier	Identifiers of entities that belong to the group.
created_at	Timestamp	Timestamp when the group was created.
updated_at	Timestamp	Timestamp when the group was last updated.

ListEntityGroupsRequest

(synq.entities.custom.v1.ListEntityGroupsRequest)

ListEntityGroupsResponse

(synq.entities.custom.v1.ListEntityGroupsResponse)

Field	Type	Description
entities_groups	repeated Group	none

UpsertEntitiesGroupRequest

(synq.entities.custom.v1.UpsertEntitiesGroupRequest)

Field	Type	Description
group	Group	none

UpsertEntitiesGroupResponse

(synq.entities.custom.v1.UpsertEntitiesGroupResponse)

Field	Type	Description
deleted_ids	repeated Identifier	none

DeleteRelationshipsRequest

(synq.entities.custom.v1.DeleteRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

DeleteRelationshipsResponse

(synq.entities.custom.v1.DeleteRelationshipsResponse)

ListRelationshipsRequest

(synq.entities.custom.v1.ListRelationshipsRequest)

Field	Type	Description
ids	repeated Identifier	Return relationships for the given entity_id. Either upstream or downstream.

ListRelationshipsResponse

(synq.entities.custom.v1.ListRelationshipsResponse)

Field	Type	Description
relationships	repeated Relationship	none

Relationship

(synq.entities.custom.v1.Relationship)

Field	Type	Description
upstream	Identifier	none
downstream	Identifier	none

UpsertRelationshipsRequest

(synq.entities.custom.v1.UpsertRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

UpsertRelationshipsResponse

(synq.entities.custom.v1.UpsertRelationshipsResponse)

CheckRelationship

(synq.entities.custom.v1.CheckRelationship)

Field	Type	Description
check	Identifier	none
checked	Identifier	none
checked_columns	repeated string	none

DeleteCheckRelationshipsRequest

(synq.entities.custom.v1.DeleteCheckRelationshipsRequest)

Field	Type	Description
check_relationships	repeated CheckRelationship	none

DeleteCheckRelationshipsResponse

(synq.entities.custom.v1.DeleteCheckRelationshipsResponse)

UpsertCheckRelationshipsRequest

(synq.entities.custom.v1.UpsertCheckRelationshipsRequest)

Field	Type	Description
check_relationships	repeated CheckRelationship	none

UpsertCheckRelationshipsResponse

(synq.entities.custom.v1.UpsertCheckRelationshipsResponse)

BatchGetEntitiesRequest

(synq.entities.entities.v1.BatchGetEntitiesRequest) BatchGetEntitiesRequest is the request message for the BatchGetEntities method.

Field	Type	Description
ids	repeated Identifier	Identifiers of the entities to get.

BatchGetEntitiesResponse

(synq.entities.entities.v1.BatchGetEntitiesResponse) BatchGetEntitiesResponse is the response message for the BatchGetEntities method.

Field	Type	Description
entities	repeated Entity	The entities that were retrieved.

GetEntityRequest

(synq.entities.entities.v1.GetEntityRequest) GetEntityRequest is the request message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to get.

GetEntityResponse

(synq.entities.entities.v1.GetEntityResponse) GetEntityResponse is the response message for the GetEntity method.

Field	Type	Description
entity	Entity	The entity that was retrieved.

ListEntitiesRequest

(synq.entities.entities.v1.ListEntitiesRequest)

Field	Type	Description
query	Query	none
pagination	Pagination	none

ListEntitiesResponse

(synq.entities.entities.v1.ListEntitiesResponse)

Field	Type	Description
page_info	PageInfo	none
entity_ids	repeated Identifier	none

SearchEntitiesRequest

(synq.entities.entities.v1.SearchEntitiesRequest)

Field	Type	Description
query	string	Full text search query, it will search in name but also in description and columns of the entities
limit_to_types	repeated EntityType	Limit results to specific entity types, leave empty to use only the query
oneof _page.page	optional uint32	none
oneof _limit_per_page.limit_per_page	optional uint32	none

SearchEntitiesResponse

(synq.entities.entities.v1.SearchEntitiesResponse)

Field	Type	Description
hits	repeated SearchHit	The entities that were retrieved.
estimated_total_hits	uint64	Estimated number of all search results
entity_type_estimates	repeated EntityTypeSearchFacet	Estimated number of all search results by entity type

EntityTypeSearchFacet

(synq.entities.entities.v1.EntityTypeSearchFacet)

Field	Type	Description
entity_type	EntityType	none
count	uint32	none

SearchHit

(synq.entities.entities.v1.SearchHit)

Field	Type	Description
name	string	Name of the found entity with optional folder like path
description	string	Description is used for display and search
oneof _entity_id.entity_id	optional Identifier	Identifier of the entity
oneof _synq_path.synq_path	optional string	Coalesce Quality path, as used in frontend
oneof _entity_type.entity_type	optional EntityType	Information about entity type
ranking_score	float	Ranking score, higher is better

BatchGetExecutionsRequest

(synq.entities.executions.v2.BatchGetExecutionsRequest) BatchGetExecutionsRequest requests specific executions by ID.

Field	Type	Description
execution_ids	repeated string	Execution IDs to retrieve.

BatchGetExecutionsResponse

(synq.entities.executions.v2.BatchGetExecutionsResponse) BatchGetExecutionsResponse contains the requested executions.

Field	Type	Description
executions	map ExecutionsEntry	Map of execution ID to EntityExecution. Only includes executions that were found and accessible.

BatchGetExecutionsResponse.ExecutionsEntry

(synq.entities.executions.v2.BatchGetExecutionsResponse.ExecutionsEntry)

Field	Type	Description
key	string	none
value	EntityExecution	none

EntityExecution

(synq.entities.executions.v2.EntityExecution) EntityExecution represents a single execution event on an entity. This is a public representation of internal Run data, excluding sensitive metadata.

Field	Type	Description
id	string	Unique identifier for this execution.
entities	repeated Identifier	Primary entities affected by this execution. These are the main entities this execution ran on or modified.
entities_synq_paths	repeated string	Coalesce Quality paths of primary entities affected by this execution.
targets	repeated Identifier	Target entities referenced by this execution. These are secondary entities that were targets of the execution.
targets_synq_paths	repeated string	Coalesce Quality paths of target entities referenced by this execution.
extra_references	repeated Identifier	Additional entity references. These are other entities referenced during the execution.
extra_references_synq_paths	repeated string	Coalesce Quality paths of additional entity references.
execution_type	ExecutionType	Type of execution (e.g., query, job, test run).
status	ExecutionStatus	Status of the execution.
skipped	bool	Whether this execution was skipped.
message	string	Human-readable message describing the execution result. This typically contains error messages, warnings, or success information.
created_at	Timestamp	When the execution record was created in Coalesce Quality.
oneof _started_at.started_at	optional Timestamp	When the execution actually started.
oneof _finished_at.finished_at	optional Timestamp	When the execution finished.
parent_execution_ids	repeated string	IDs of parent executions, if this is a nested execution. For example, a task execution might have a parent DAG execution.
oneof _duration_seconds.duration_seconds	optional double	Duration of the execution in seconds. Only populated if both started_at and finished_at are present.

ExecutionStatusCount

(synq.entities.executions.v2.ExecutionStatusCount) ExecutionStatusCount represents the count of executions by status.

Field	Type	Description
status	ExecutionStatus	none
count	int64	none

ExecutionTypeCount

(synq.entities.executions.v2.ExecutionTypeCount) ExecutionTypeCount represents the count of executions by type.

Field	Type	Description
execution_type	ExecutionType	none
count	int64	none

GetExecutionsSummaryRequest

(synq.entities.executions.v2.GetExecutionsSummaryRequest) GetExecutionsSummaryRequest requests summary statistics for entities.

Field	Type	Description
entity_ids	repeated Identifier	Entity identifiers to get summary for.
oneof _execution_started_after.execution_started_after	optional Timestamp	Return executions that started after this timestamp. If not provided, defaults to 30 days before execution_started_before.
oneof _execution_started_before.execution_started_before	optional Timestamp	Return executions that started before this timestamp. If not provided, defaults to now().

GetExecutionsSummaryResponse

(synq.entities.executions.v2.GetExecutionsSummaryResponse) GetExecutionsSummaryResponse contains aggregated execution statistics.

Field	Type	Description
total_executions	int64	Total number of executions matching the criteria.
execution_type_counts	repeated ExecutionTypeCount	Count of executions by type.
status_counts	repeated ExecutionStatusCount	Count of executions by status.
oneof _earliest_execution.earliest_execution	optional Timestamp	Time range of available executions.
oneof _latest_execution.latest_execution	optional Timestamp	none
latest_by_entity	map LatestByEntityEntry	Latest execution for each requested entity.

GetExecutionsSummaryResponse.LatestByEntityEntry

(synq.entities.executions.v2.GetExecutionsSummaryResponse.LatestByEntityEntry)

Field	Type	Description
key	string	none
value	EntityExecution	none

GetLatestExecutionsRequest

(synq.entities.executions.v2.GetLatestExecutionsRequest) GetLatestExecutionsRequest requests the latest execution for each entity.

Field	Type	Description
entity_ids	repeated Identifier	Entity identifiers to get latest executions for. Only returns executions where these entities appear in EntityExecution.entities (what executed). Examples that WILL return results: monitors, dbt models, airflow tasks, tests Examples that WON’T return results: tables (they don’t execute, they are created/updated by models)
statuses	repeated ExecutionStatus	Filter by execution status. If provided, returns the latest execution with one of these statuses. If empty, returns the latest execution regardless of status.
execution_types	repeated ExecutionType	Filter by execution types. If provided, returns the latest execution of one of these types. If empty, returns the latest execution regardless of type.

GetLatestExecutionsResponse

(synq.entities.executions.v2.GetLatestExecutionsResponse) GetLatestExecutionsResponse contains the latest execution for each requested entity.

Field	Type	Description
latest_executions	map LatestExecutionsEntry	Map of entity identifier (as string) to latest execution. Entities with no matching executions are omitted.

GetLatestExecutionsResponse.LatestExecutionsEntry

(synq.entities.executions.v2.GetLatestExecutionsResponse.LatestExecutionsEntry)

Field	Type	Description
key	string	none
value	EntityExecution	none

ListExecutionsRequest

(synq.entities.executions.v2.ListExecutionsRequest) ListExecutionsRequest specifies filters for listing executions.

Field	Type	Description
entity_ids	repeated Identifier	Entity identifiers to get executions for. Executions affecting any of these entities will be returned.
oneof _execution_started_after.execution_started_after	optional Timestamp	Return executions that started after this timestamp. If not provided, defaults to 7 days before execution_started_before.
oneof _execution_started_before.execution_started_before	optional Timestamp	Return executions that started before this timestamp. If not provided, defaults to now().
execution_types	repeated ExecutionType	Filter by specific execution types. If empty, all execution types are included.
statuses	repeated ExecutionStatus	Filter by execution status. If empty, all statuses are included.
include_referenced_executions	bool	Include executions that reference the specified entities (not just primary entities). If true, executions where entity_ids appear in targets or extra_references are also returned.
pagination	Pagination	Pagination parameters.

ListExecutionsResponse

(synq.entities.executions.v2.ListExecutionsResponse) ListExecutionsResponse contains the paginated list of executions.

Field	Type	Description
executions	repeated EntityExecution	List of executions matching the filter criteria, ordered by started_at descending.
page_info	PageInfo	Pagination information.

Execution

(synq.entities.executions.v1.Execution)

Field	Type	Description
id	Identifier	none
status	ExecutionStatus	none
message	string	none
created_at	Timestamp	none
started_at	Timestamp	none
finished_at	Timestamp	none
annotations	repeated Annotation	none
extras	repeated ExecutionExtra	none

ExecutionExtra

(synq.entities.executions.v1.ExecutionExtra)

Field	Type	Description
oneof extra.executed_sql	string	none

LogEntry

(synq.entities.executions.v1.LogEntry)

Field	Type	Description
id	Identifier	none
message	string	none
created_at	Timestamp	none
started_at	Timestamp	none
finished_at	Timestamp	none
annotations	repeated Annotation	none

UpsertExecutionRequest

(synq.entities.executions.v1.UpsertExecutionRequest)

Field	Type	Description
execution	Execution	none

UpsertExecutionResponse

(synq.entities.executions.v1.UpsertExecutionResponse)

UpsertLogEntryRequest

(synq.entities.executions.v1.UpsertLogEntryRequest)

Field	Type	Description
log_entry	LogEntry	none

UpsertLogEntryResponse

(synq.entities.executions.v1.UpsertLogEntryResponse)

BatchSqlDetailsRequest

(synq.entities.sql_insights.v1.BatchSqlDetailsRequest) BatchSqlDetailsRequest requests SQL details for a set of entities.

Field	Type	Description
paths	repeated string	The synq paths of the entities to fetch SQL details for. A synq path uniquely identifies an entity and can be obtained from the `synq_paths` field of other entity responses.

BatchSqlDetailsResponse

(synq.entities.sql_insights.v1.BatchSqlDetailsResponse) BatchSqlDetailsResponse maps each requested synq path to its SQL details.

Field	Type	Description
sql_details	map SqlDetailsEntry	SQL details keyed by synq path. Paths with no SQL details are omitted.

BatchSqlDetailsResponse.SqlDetailsEntry

(synq.entities.sql_insights.v1.BatchSqlDetailsResponse.SqlDetailsEntry)

Field	Type	Description
key	string	none
value	SqlDetails	none

ListSqlConstructsRequest

(synq.entities.sql_insights.v1.ListSqlConstructsRequest) ListSqlConstructsRequest has no fields: the result is scoped to the workspace of the authenticated request.

ListSqlConstructsResponse

(synq.entities.sql_insights.v1.ListSqlConstructsResponse) ListSqlConstructsResponse carries the per-construct occurrence counts for the workspace.

Field	Type	Description
sql_constructs	repeated SqlConstructCount	One entry per construct that appears at least once in the workspace.

ListSqlConstructsResponse.SqlConstructCount

(synq.entities.sql_insights.v1.ListSqlConstructsResponse.SqlConstructCount) SqlConstructCount pairs a SQL construct with the number of entities in the workspace whose SQL uses it.

Field	Type	Description
sql_construct	SqlConstruct	The SQL construct being counted.
count	int32	How many entities in the workspace use this construct.

SqlDetails

(synq.entities.sql_insights.v1.SqlDetails) SqlDetails describes the SQL used by a single entity.

Field	Type	Description
path	string	The synq path of the entity these details belong to.
sql_constructs	repeated SqlConstruct	The set of SQL constructs detected in the entity’s SQL. Multiple constructs can be present on a single entity (e.g. a query with both a CTE and an INNER JOIN reports HAS_CTE, HAS_ANY_JOIN and INNER_JOIN).

BatchSchemaMismatchesRequest

(synq.entities.schemas.v1.BatchSchemaMismatchesRequest) BatchGetSchemaMismatchesRequest is the request message for the BatchGetSchemaMismatches method.

Field	Type	Description
ids	repeated Identifier	Identifiers of the entities to get schema mismatches for.

BatchSchemaMismatchesResponse

(synq.entities.schemas.v1.BatchSchemaMismatchesResponse) BatchGetSchemaMismatchesResponse is the response message for the BatchGetSchemaMismatches method.

Field	Type	Description
schema_mismatches	repeated SchemaMismatch	Schema mismatches found for the requested entities.

SchemaMismatch

(synq.entities.schemas.v1.SchemaMismatch) SchemaMismatch represents a schema drift between a definer entity (e.g., dbt model) and an origin entity (e.g., BigQuery table) where columns are defined but missing in origin.

Field	Type	Description
definer_id	Identifier	Identifier of the entity that defines the columns (e.g., dbt model).
origin_id	Identifier	Identifier of the entity where the columns are expected but missing (e.g., BigQuery table).
missing_origin_column_names	repeated string	Names of the columns that are defined but missing in the origin.
missing_origin_column_human_names	repeated string	Human-readable names of the columns that are defined but missing in the origin.

GetSchemaRequest

(synq.entities.schemas.v1.GetSchemaRequest) GetEntityRequest is the request message for the GetEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to get.

GetSchemaResponse

(synq.entities.schemas.v1.GetSchemaResponse) GetEntityResponse is the response message for the GetEntity method.

Field	Type	Description
oneof _schema.schema	optional Schema	Schema of the entity, might be empty

ListCodeRequest

(synq.entities.code.v1.ListCodeRequest) ListCodeRequest is the request message for the ListCode method.

Field	Type	Description
id	Identifier	Identifier of the entity to retrieve code for. This can be any entity type that contains code artifacts.

ListCodeResponse

(synq.entities.code.v1.ListCodeResponse) ListCodeResponse is the response message for the ListCode method.

Field	Type	Description
codes	repeated Code	List of code artifacts associated with the requested entity. Each code artifact includes its content, type, and metadata about when it was captured.
identifiers	repeated Identifier	none
synq_paths	repeated string	none

GetTableConstraintsRequest

(synq.entities.constraints.v1.GetTableConstraintsRequest)

Field	Type	Description
id	Identifier	Identifier of the entity to get constraints for.

GetTableConstraintsResponse

(synq.entities.constraints.v1.GetTableConstraintsResponse)

Field	Type	Description
id	Identifier	Identifier of the entity whose constraints are returned. May differ from the requested identifier if identity resolution mapped the request to an underlying table (e.g. dbt model → warehouse table).
synq_path	string	Coalesce Quality path of the resolved entity.
constraints	repeated TableConstraint	Constraints and indexes defined on the table.
database_instance	string	Database coordinates of the table whose constraints are returned.
database_name	string	none
schema_name	string	none
object_name	string	none

LineageColumnEdge

(synq.ingest.dwh.v1.LineageColumnEdge) LineageColumnEdge is a single column-to-column dependency carried inside a table-level edge. Optional: omit to declare table-level lineage only. The columns name positions on the parent LineageEdge’s upstream and downstream objects respectively.

Field	Type	Description
upstream_column	string	Column on the upstream (source) object.
downstream_column	string	Column on the downstream (target) object that derives from it.

LineageEdge

(synq.ingest.dwh.v1.LineageEdge) LineageEdge is one directed dependency: data flows from upstream into downstream. Represent multi-hop lineage as the set of its direct (distance-1) edges; do not collapse intermediate hops, so the graph stays explicit and each hop keeps its own object domain and column edges.

Field	Type	Description
upstream	LineageNode	Object the data flows from.
downstream	LineageNode	Object the data flows into.
column_edges	repeated LineageColumnEdge	Optional column-level dependencies within this edge. When any edge for a given downstream object carries column edges, that object’s lineage is treated as column-level; otherwise it is table-level only.
meta	Struct	Free-form provenance about how this edge was established (for example the query id, or the warehouse’s own description of the deriving process). Stored as-is and not interpreted by the platform.

LineageNode

(synq.ingest.dwh.v1.LineageNode) LineageNode identifies one object that participates in a lineage edge.

Field	Type	Description
fqn	Fqn	Fully-qualified name of the object. `object_name` is required; set the higher levels (instance / database / schema) to whatever the warehouse exposes so the platform can resolve the object to a known asset.
domain	LineageObjectDomain	What kind of object this is. Lets the platform separate true table-to-table lineage from edges that involve warehouse-internal objects.

Fqn

(synq.ingest.dwh.v1.Fqn)

Field	Type	Description
instance_name	string	none
database_name	string	none
schema_name	string	none
object_name	string	none

ObjectInformation

(synq.ingest.dwh.v1.ObjectInformation)

Field	Type	Description
fqn	Fqn	none
object_native_type	string	none
is_view	bool	none
is_table	bool	none
tags	repeated Tag	none
oneof _description.description	optional string	none

ObjectMetrics

(synq.ingest.dwh.v1.ObjectMetrics)

Field	Type	Description
fqn	Fqn	none
oneof _row_count.row_count	optional int64	none
oneof _updated_at.updated_at	optional Timestamp	none
oneof _size_bytes.size_bytes	optional int64	none

Schema

(synq.ingest.dwh.v1.Schema)

Field	Type	Description
fqn	Fqn	none
columns	repeated SchemaColumn	none

SchemaColumn

(synq.ingest.dwh.v1.SchemaColumn)

Field	Type	Description
name	string	none
native_type	string	none
ordinal_position	int32	none
oneof _description.description	optional string	none
tags	repeated Tag	none
is_struct	bool	none
is_repeated	bool	none
fields	repeated SchemaColumnField	none

SchemaColumnField

(synq.ingest.dwh.v1.SchemaColumnField)

Field	Type	Description
name	string	none
native_type	string	none
oneof _description.description	optional string	none
ordinal_position	int32	none
is_struct	bool	none
is_repeated	bool	none
fields	repeated SchemaColumnField	none

SqlDefinition

(synq.ingest.dwh.v1.SqlDefinition)

Field	Type	Description
fqn	Fqn	none
sql	string	none

TableConstraint

(synq.ingest.dwh.v1.TableConstraint) TableConstraint represents a single constraint or index on a database table.

Field	Type	Description
name	string	Name of the constraint or index
type	string	Type of the constraint (e.g. PRIMARY_KEY, FOREIGN_KEY, UNIQUE, CHECK, INDEX)
columns	repeated string	Column names involved in this constraint or index
oneof _foreign_key_target.foreign_key_target	optional Fqn	For foreign key: referenced table FQN
foreign_key_target_columns	repeated string	For foreign key: referenced column names
index_type	string	Index type (e.g. “btree”, “hash”, “gin”)
expression	string	Expression for check constraints or expression-based indexes
is_unique	bool	Whether this constraint or index enforces uniqueness
oneof _is_enforced.is_enforced	optional bool	Whether this constraint is enforced by the database. nil/unset = unknown, true = enforced, false = not enforced.

TableConstraints

(synq.ingest.dwh.v1.TableConstraints) TableConstraints contains all constraints and indexes for a single table.

Field	Type	Description
fqn	Fqn	none
constraints	repeated TableConstraint	none

Tag

(synq.ingest.dwh.v1.Tag)

Field	Type	Description
tag_name	string	none
tag_value	string	none

QueryLog

(synq.ingest.dwh.v1.QueryLog) QueryLog represents a single query execution log entry from a data warehouse. This is the format used for ingesting query logs via the DWH agent. The structure mirrors the internal QueryLogRawRow with protobuf serialization.

Field	Type	Description
workspace	string	Workspace and integration identifiers (for multi-tenancy)
integration_id	string	none
oneof _connection_id.connection_id	optional string	Empty for direct connections, populated for agent uploads
query_id	string	Query identifiers
created_at	Timestamp	none
oneof _started_at.started_at	optional Timestamp	Query start time (optional, uses created_at if not set)
oneof _finished_at.finished_at	optional Timestamp	Query finish time (optional, uses created_at if not set)
sql	string	Query content

QueryLogDwhContext

(synq.ingest.dwh.v1.QueryLogDwhContext) QueryLogDwhContext represents the execution context of a query. Contains information about where and by whom the query was executed. Platform-specific mappings (Instance, Database, Schema):

Snowflake: account, database_name, schema_name
Databricks: workspace_url, catalog_name, schema_name
BigQuery: "", project_id, dataset_id
Redshift: host, database_name, schema_name
Postgres: host, database_name, schema_name
Trino: host, catalog, schema
MySQL: "", host, schema_name
ClickHouse: hostname, database_name, "" (2-level: hostname.database)
DuckDB: motherduck_account, database_name, schema_name

Field	Type	Description
oneof _instance.instance	optional string	Instance identifier (account, workspace_url, host, etc.)
oneof _database.database	optional string	Database/catalog name
oneof _schema.schema	optional string	Schema name
oneof _warehouse.warehouse	optional string	Warehouse identifier (Snowflake, Databricks)
oneof _user.user	optional string	User who executed the query
oneof _role.role	optional string	Role used for execution
oneof _cluster.cluster	optional string	Cluster identifier (Redshift, ClickHouse)

QueryLogNativeLineage

(synq.ingest.dwh.v1.QueryLogNativeLineage) QueryLogNativeLineage contains lineage information provided natively by the data warehouse. Not all platforms provide this - when available, it can be more accurate than SQL parsing.

Field	Type	Description
input_tables	repeated Fqn	Tables read by the query
output_tables	repeated Fqn	Tables written to by the query

DatabasesScope

(synq.ingest.dwh.v1.DatabasesScope) DatabasesScope makes the batch authoritative for the listed databases only.

Field	Type	Description
databases	repeated string	Each entry is “database” or “instance.database”.

IngestLineageRequest

(synq.ingest.dwh.v1.IngestLineageRequest) IngestLineageRequest carries one batch of lineage edges for a single warehouse connection. Send many batches with the same connection_id over time; each batch is interpreted against the others according to replace_mode.

Field	Type	Description
connection_id	string	Identifier of the warehouse connection this lineage was read from. Use the same connection_id you use for the other Ingest* calls of this warehouse so the lineage attaches to the right objects.
upload_id	string	A unique id for this batch (UUID). Re-sending a batch with the same upload_id is de-duplicated, so it is safe to retry.
state_at	Timestamp	Time at which the lineage was extracted from the warehouse.
source	LineageSource	How the lineage was derived. Drives the precedence of the resulting edges and keeps lineage of different origins from overwriting one another.
replace_mode	LineageReplaceMode	How this batch supersedes previously-ingested lineage. Defaults to MERGE (incremental) when unset.
scope	LineageScope	Required when replace_mode is REPLACE_SCOPE; ignored otherwise.
edges	repeated LineageEdge	The lineage edges in this batch. Empty in REPLACE_SCOPE mode is a valid way to expire all lineage inside the scope.

IngestLineageResponse

(synq.ingest.dwh.v1.IngestLineageResponse) IngestLineageResponse is intentionally empty; a successful call means the batch was accepted for processing.

IngestObjectInformationRequest

(synq.ingest.dwh.v1.IngestObjectInformationRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
objects	repeated ObjectInformation	none

IngestObjectInformationResponse

(synq.ingest.dwh.v1.IngestObjectInformationResponse)

IngestObjectMetricsRequest

(synq.ingest.dwh.v1.IngestObjectMetricsRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
metrics	repeated ObjectMetrics	none

IngestObjectMetricsResponse

(synq.ingest.dwh.v1.IngestObjectMetricsResponse)

IngestQueryLogsRequest

(synq.ingest.dwh.v1.IngestQueryLogsRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
query_logs	repeated QueryLog	none

IngestQueryLogsResponse

(synq.ingest.dwh.v1.IngestQueryLogsResponse)

IngestSchemasRequest

(synq.ingest.dwh.v1.IngestSchemasRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
schemas	repeated Schema	none

IngestSchemasResponse

(synq.ingest.dwh.v1.IngestSchemasResponse)

IngestSqlDefinitionsRequest

(synq.ingest.dwh.v1.IngestSqlDefinitionsRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
sql_definitions	repeated SqlDefinition	none

IngestSqlDefinitionsResponse

(synq.ingest.dwh.v1.IngestSqlDefinitionsResponse)

IngestTableConstraintsRequest

(synq.ingest.dwh.v1.IngestTableConstraintsRequest)

Field	Type	Description
connection_id	string	none
upload_id	string	none
state_at	Timestamp	Time at which state was collected
table_constraints	repeated TableConstraints	none

IngestTableConstraintsResponse

(synq.ingest.dwh.v1.IngestTableConstraintsResponse)

IngestTaskResultsRequest

(synq.ingest.dwh.v1.IngestTaskResultsRequest)

Field	Type	Description
connection_id	string	none
task_id	string	none
state_at	Timestamp	Time at which state was collected
task_data	AgentTaskData	none

IngestTaskResultsResponse

(synq.ingest.dwh.v1.IngestTaskResultsResponse)

LineageScope

(synq.ingest.dwh.v1.LineageScope) LineageScope declares the set of downstream objects a REPLACE_SCOPE batch is authoritative for — the boundary inside which omitted edges are expired. The scope is always additionally bounded by the request’s connection_id. Ignored when the mode is MERGE.

Field	Type	Description
oneof scope.whole_connection	WholeConnectionScope	Authoritative for the whole connection: every downstream object previously ingested under this request’s connection_id.
oneof scope.databases	DatabasesScope	Authoritative only for the listed databases.
oneof scope.schemas	SchemasScope	Authoritative only for the listed schemas.

SchemasScope

(synq.ingest.dwh.v1.SchemasScope) SchemasScope makes the batch authoritative for the listed schemas only.

Field	Type	Description
schemas	repeated string	Each entry is “database.schema” or “instance.database.schema”.

WholeConnectionScope

(synq.ingest.dwh.v1.WholeConnectionScope) WholeConnectionScope makes the batch authoritative for the entire connection.

GitContext

(synq.ingest.git.v1.GitContext)

Field	Type	Description
clone_url	string	none
branch	string	none
commit_sha	string	none

IngestRequest

(synq.ingest.openlineage.v1.IngestRequest)

Field	Type	Description
payload	Struct	none

IngestResponse

(synq.ingest.openlineage.v1.IngestResponse)

CloudwatchLogsLogEvent

(synq.ingest.cloudwatch.v1.CloudwatchLogsLogEvent)

Field	Type	Description
id	string	none
timestamp	Timestamp	none
message	string	none

IngestCloudwatchLogsDataRequest

(synq.ingest.cloudwatch.v1.IngestCloudwatchLogsDataRequest)

Field	Type	Description
owner	string	none
log_group	string	none
log_stream	string	none
subscription_filters	repeated string	none
message_type	string	none
log_events	repeated CloudwatchLogsLogEvent	none

IngestCloudwatchLogsDataResponse

(synq.ingest.cloudwatch.v1.IngestCloudwatchLogsDataResponse)

IngestDatahubAspectsRequest

(synq.ingest.airflow.v1.IngestDatahubAspectsRequest)

Field	Type	Description
aspects	repeated Struct	none
oneof _action.action	optional string	none

IngestDatahubAspectsResponse

(synq.ingest.airflow.v1.IngestDatahubAspectsResponse)

IngestLogRequest

(synq.ingest.airflow.v1.IngestLogRequest)

Field	Type	Description
dag_id	string	none
task_id	string	none
run_id	string	none
attempt	int32	none
log	string	none
log_time	Timestamp	none

IngestLogResponse

(synq.ingest.airflow.v1.IngestLogResponse)

IngestExecutionRequest

(synq.ingest.sqlmesh.v1.IngestExecutionRequest)

Field	Type	Description
command	repeated string	Command passed to the sqlmesh tool
exit_code	int32	Exit code of the sqlmesh command
std_out	bytes	Standard output log of the SqlMesh command
std_err	bytes	Standard error log of the SqlMesh command
environment_vars	map EnvironmentVarsEntry	Environment variables collected during execution
uploader_version	string	Version of the uploader tool
uploader_build_time	string	Build time of the uploader tool
started_at	Timestamp	Time at which the execution started
finished_at	Timestamp	Time at which the execution finished
git_context	GitContext	Git context of the project

IngestExecutionRequest.EnvironmentVarsEntry

(synq.ingest.sqlmesh.v1.IngestExecutionRequest.EnvironmentVarsEntry)

Field	Type	Description
key	string	none
value	string	none

IngestExecutionResponse

(synq.ingest.sqlmesh.v1.IngestExecutionResponse)

IngestMetadataRequest

(synq.ingest.sqlmesh.v1.IngestMetadataRequest)

Field	Type	Description
api_meta	bytes	Data from /api/meta
models	bytes	Data from /api/models
model_details	map ModelDetailsEntry	Data from /api/models/{model_id}
model_lineage	map ModelLineageEntry	Data from /api/lineage/{model_id}
files	bytes	Data from /api/files
file_content	map FileContentEntry	Data from /api/file/{file_path}
environments	bytes	Data from /api/environments
uploader_version	string	Version of the uploader tool
uploader_build_time	string	Build time of the uploader tool
state_at	Timestamp	Time at which state was collected
git_context	GitContext	Git context of the project
errors	repeated Error	Optional errors indicating why some data wasn’t loaded

IngestMetadataRequest.Error

(synq.ingest.sqlmesh.v1.IngestMetadataRequest.Error)

Field	Type	Description
oneof _path.path	optional string	none
oneof _code.code	optional int64	none
message	string	none

IngestMetadataRequest.FileContentEntry

(synq.ingest.sqlmesh.v1.IngestMetadataRequest.FileContentEntry)

Field	Type	Description
key	string	none
value	bytes	none

IngestMetadataRequest.ModelDetailsEntry

(synq.ingest.sqlmesh.v1.IngestMetadataRequest.ModelDetailsEntry)

Field	Type	Description
key	string	none
value	bytes	none

IngestMetadataRequest.ModelLineageEntry

(synq.ingest.sqlmesh.v1.IngestMetadataRequest.ModelLineageEntry)

Field	Type	Description
key	string	none
value	bytes	none

IngestMetadataResponse

(synq.ingest.sqlmesh.v1.IngestMetadataResponse)

DbtArtifact

(synq.ingest.dbt.v1.DbtArtifact) https://docs.getdbt.com/reference/artifacts/dbt-artifacts

Field	Type	Description
oneof artifact.manifest_json	bytes	none
oneof artifact.run_results_json	bytes	none
oneof artifact.catalog_json	bytes	none
oneof artifact.sources_json	bytes	none
oneof artifact.semantic_manifest_json	bytes	none

IngestInvocationRequest

(synq.ingest.dbt.v1.IngestInvocationRequest)

Field	Type	Description
args	repeated string	Arguments passed to the dbt executable
exit_code	int32	Exit code of the dbt command
std_out	bytes	Standard output log of the dbt command
std_err	bytes	Standard error log of the dbt command
environment_vars	map EnvironmentVarsEntry	Environment variables collected during execution
artifacts	repeated DbtArtifact	Artifacts generated by the dbt command
uploader_version	string	Version of the uploader tool
uploader_build_time	string	Build time of the uploader tool
git_context	GitContext	Git context of the project

IngestInvocationRequest.EnvironmentVarsEntry

(synq.ingest.dbt.v1.IngestInvocationRequest.EnvironmentVarsEntry)

Field	Type	Description
key	string	none
value	string	none

IngestInvocationResponse

(synq.ingest.dbt.v1.IngestInvocationResponse)

AddDomainMembersRequest

(synq.domains.members.v1.AddDomainMembersRequest)

Field	Type	Description
domain_id	string	none
user_ids	repeated string	none

AddDomainMembersResponse

(synq.domains.members.v1.AddDomainMembersResponse)

ListDomainMembersRequest

(synq.domains.members.v1.ListDomainMembersRequest)

Field	Type	Description
domain_id	string	none

ListDomainMembersResponse

(synq.domains.members.v1.ListDomainMembersResponse)

Field	Type	Description
memberships	repeated DomainMembership	none

ListUserDomainsRequest

(synq.domains.members.v1.ListUserDomainsRequest)

Field	Type	Description
user_id	string	none

ListUserDomainsResponse

(synq.domains.members.v1.ListUserDomainsResponse)

Field	Type	Description
memberships	repeated DomainMembership	none

RemoveDomainMembersRequest

(synq.domains.members.v1.RemoveDomainMembersRequest)

Field	Type	Description
domain_id	string	none
user_ids	repeated string	none

RemoveDomainMembersResponse

(synq.domains.members.v1.RemoveDomainMembersResponse)

SetDefaultUserDomainRequest

(synq.domains.members.v1.SetDefaultUserDomainRequest)

Field	Type	Description
domain_id	string	none
user_id	string	none

SetDefaultUserDomainResponse

(synq.domains.members.v1.SetDefaultUserDomainResponse)

DomainMembership

(synq.domains.members.v1.DomainMembership)

Field	Type	Description
user_id	string	none
domain_id	string	none
is_default	bool	none

BatchGetRequest

(synq.domains.v1.BatchGetRequest)

Field	Type	Description
domain_ids	repeated string	none

BatchGetResponse

(synq.domains.v1.BatchGetResponse)

Field	Type	Description
domains	map DomainsEntry	none

BatchGetResponse.DomainsEntry

(synq.domains.v1.BatchGetResponse.DomainsEntry)

Field	Type	Description
key	string	none
value	Domain	none

DeleteRequest

(synq.domains.v1.DeleteRequest)

Field	Type	Description
domain_id	string	none

DeleteResponse

(synq.domains.v1.DeleteResponse)

FetchDomainWithSubDomainsRequest

(synq.domains.v1.FetchDomainWithSubDomainsRequest)

Field	Type	Description
domain_id	string	none
exclude_definition	bool	none

FetchDomainWithSubDomainsResponse

(synq.domains.v1.FetchDomainWithSubDomainsResponse)

Field	Type	Description
domains	map DomainsEntry	none

FetchDomainWithSubDomainsResponse.DomainsEntry

(synq.domains.v1.FetchDomainWithSubDomainsResponse.DomainsEntry)

Field	Type	Description
key	string	none
value	Domain	none

GetUsageRequest

(synq.domains.v1.GetUsageRequest)

GetUsageResponse

(synq.domains.v1.GetUsageResponse)

Field	Type	Description
num_domains	int32	none
num_sub_domains	int32	none

ListRequest

(synq.domains.v1.ListRequest)

Field	Type	Description
oneof _parent_id.parent_id	optional string	none
exclude_definition	bool	none

ListResponse

(synq.domains.v1.ListResponse)

Field	Type	Description
domains	repeated Domain	none

RemoveDefinitionPartRequest

(synq.domains.v1.RemoveDefinitionPartRequest)

Field	Type	Description
domain_id	string	none
part_id	string	none

RemoveDefinitionPartResponse

(synq.domains.v1.RemoveDefinitionPartResponse)

SetDefinitionRequest

(synq.domains.v1.SetDefinitionRequest)

Field	Type	Description
domain_id	string	none
definition	DomainDefinition	none

SetDefinitionResponse

(synq.domains.v1.SetDefinitionResponse)

UpsertDefinitionPartRequest

(synq.domains.v1.UpsertDefinitionPartRequest)

Field	Type	Description
domain_id	string	none
part	Part	none

UpsertDefinitionPartResponse

(synq.domains.v1.UpsertDefinitionPartResponse)

UpsertRequest

(synq.domains.v1.UpsertRequest)

Field	Type	Description
id	string	none
name	string	none
description	string	none
oneof _parent_id.parent_id	optional string	none
source	Source	none

UpsertResponse

(synq.domains.v1.UpsertResponse)

AssetSelectionQuery

(synq.domains.v1.AssetSelectionQuery)

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	none

AssetSelectionQuery.QueryPart

(synq.domains.v1.AssetSelectionQuery.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_data_platform	InDataPlatform	none
oneof part.in_folder	InFolder	none
oneof part.with_data_platform_type	WithDataPlatformType	none
oneof part.query	AssetSelectionQuery	none
oneof part.unsupported	Unsupported	none

DomainDefinition

(synq.domains.v1.DomainDefinition)

Field	Type	Description
parts	repeated Part	none

DomainDefinition.Part

(synq.domains.v1.DomainDefinition.Part)

Field	Type	Description
id	string	part identifier
oneof part.identifier	Identifier	none
oneof part.dataproduct	DataproductIdentifier	none
oneof part.query	AssetSelectionQuery	none

Domain

(synq.domains.v1.Domain)

Field	Type	Description
id	string	none
name	string	none
description	string	none
created_at	Timestamp	none
oneof _deleted_at.deleted_at	optional Timestamp	none
definition	DomainDefinition	none
oneof _parent_id.parent_id	optional string	none
source	Source	Source for creation and management of domain.

Grant

(synq.savedviews.v1.Grant) A single access grant on a saved view.

Field	Type	Description
grantee_identity	string	Identity of the grantee. Currently a user email (`user@example.com`); the view becomes visible to that user once they exist in the workspace, so a view can be shared with someone before their first login.
role	GrantRole	What the grantee may do. Defaults to VIEW.

GrantList

(synq.savedviews.v1.GrantList) A wrapper giving the grant set explicit presence on write, so a partial update can distinguish “replace the grants” (present, possibly empty) from “leave grants unchanged” (absent).

Field	Type	Description
grants	repeated Grant	none

SavedView

(synq.savedviews.v1.SavedView) A saved view: a named, reusable selection over entities (or another context) with display configuration, sharing and per-user pinning.

Field	Type	Description
id	string	Client-supplied UUID identifying the view.
context	SavedViewContext	The surface this view applies to.
title	string	Human-readable title.
description	string	Optional longer description.
selection	SavedViewSelection	The selection captured by the view.
config	SavedViewConfig	Display configuration.
visibility	SavedViewVisibility	Sharing state.
grants	repeated Grant	Access grants (populated for GRANTED views).
owner	Actor	Who created the view. Output-only.
updated_by	Actor	Who last edited the view. Output-only.
relationship	SavedViewRelationship	How this view relates to the calling user. Output-only.
permissions	SavedViewPermissions	What the calling user may do with this view. Output-only.
pinned	bool	Whether the calling user has pinned this view to their main screen. Output-only; change with SetPin.
etag	string	Entity tag for optimistic concurrency: pass back on Upsert/Delete to guard against overwriting a concurrent change. Form: `W/"<id>-<version>"`.
created_at	Timestamp	When the view was created. Output-only.
updated_at	Timestamp	When the view was last updated. Output-only.

SavedViewConfig

(synq.savedviews.v1.SavedViewConfig) How a saved view is displayed once opened. This message is intentionally permissive and forward-compatible: new presentation options are added as new fields, never as a breaking change, so older clients keep working.

Field	Type	Description
layout	Layout	How results are laid out (list, cards, table). Unspecified lets the client pick its default for the context.
card_fields	repeated string	Which fields to surface on each result (e.g. “last_run”, “owner”, “status”, “platform”). Interpreted by the client; unknown field names are ignored.

SavedViewPermissions

(synq.savedviews.v1.SavedViewPermissions) What the calling user is allowed to do with a saved view. Output-only: computed per request from ownership, the caller’s grant (if any) and their workspace permissions. Viewing and pinning are always allowed for any view the caller can see, so they are not represented here.

Field	Type	Description
can_edit	bool	The caller can update the view’s definition, title, description and config.
can_delete	bool	The caller can delete the view.
can_manage_grants	bool	The caller can change the view’s sharing/visibility and grants.

SavedViewQuery

(synq.savedviews.v1.SavedViewQuery) The query behind a saved view, expressed for the public API. On write, provide the query in ONE of two forms:

public_query — a structured query (the same shape used elsewhere for asset selection), convenient to build from a filter UI; or
resolver_ql — the SYNQ resolver query language, a compact text form that additionally expresses severity/status and time-window filters (e.g. with_severity(statuses=["error"], since="24h")). When both are set, resolver_ql wins. The server compiles the query and stores it canonically; the raw text is not preserved verbatim.

On read, the server returns rendered_resolver_ql (the stored query rendered back to canonical resolver query language) and, best-effort, public_query (the structured representation; parts with no structured equivalent are marked unsupported). resolver_ql is not echoed back — read rendered_resolver_ql.

Field	Type	Description
resolver_ql	string	WRITE (option A). The query in resolver query language. Superset form — the only way to express severity/status and time-window filters.
rendered_resolver_ql	string	READ, output-only. The stored query rendered back to canonical resolver query language. Deterministically derived; does not preserve original hand-typed formatting or comments.
public_query	Query	WRITE (option B) and READ. On write, the structured query to store (used when `resolver_ql` is empty). On read, a structured representation of the stored query — lossy: parts with no structured equivalent are represented as unsupported, so prefer `rendered_resolver_ql` for full fidelity.

SavedViewSelection

(synq.savedviews.v1.SavedViewSelection) The selection that a saved view captures. Modelled as a oneof so future contexts (e.g. an issues filter) can add their own selection shape without reshaping the view.

Field	Type	Description
oneof selection.entity_query	SavedViewQuery	Entity-backed selection (catalog/assets and checks contexts).

BatchGetRequest

(synq.savedviews.v1.BatchGetRequest)

Field	Type	Description
ids	repeated string	Ids to fetch (1–200, unique).

BatchGetResponse

(synq.savedviews.v1.BatchGetResponse)

Field	Type	Description
views	map ViewsEntry	Views keyed by id. Ids the caller cannot see or that do not exist are absent.

BatchGetResponse.ViewsEntry

(synq.savedviews.v1.BatchGetResponse.ViewsEntry)

Field	Type	Description
key	string	none
value	SavedView	none

DeleteRequest

(synq.savedviews.v1.DeleteRequest)

Field	Type	Description
id	string	Id of the view to delete.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.

DeleteResponse

(synq.savedviews.v1.DeleteResponse)

ListRequest

(synq.savedviews.v1.ListRequest)

Field	Type	Description
scopes	repeated SavedViewRelationship	Relationship buckets to include. Empty returns every view the caller can see. For example [SAVED_VIEW_RELATIONSHIP_MINE] returns only the caller’s own views.
oneof _context.context	optional SavedViewContext	Restrict to a single surface. Omit to return views for all contexts.
oneof _only_pinned.only_pinned	optional bool	Restrict to views the caller has pinned.
pagination	Pagination	Pagination.

ListResponse

(synq.savedviews.v1.ListResponse)

Field	Type	Description
views	repeated SavedView	The matching views.
page_info	PageInfo	Pagination cursor for the next page.

SetPinRequest

(synq.savedviews.v1.SetPinRequest)

Field	Type	Description
id	string	Id of the view to pin/unpin for the calling user.
pinned	bool	Desired pin state: true to pin, false to unpin.

SetPinResponse

(synq.savedviews.v1.SetPinResponse)

UpsertRequest

(synq.savedviews.v1.UpsertRequest)

Field	Type	Description
id	string	Client-supplied UUID identifying the view. The same id updates the same view; a new id creates a new view.
oneof _title.title	optional string	Title. Required when creating; omit to keep the existing title on update.
oneof _description.description	optional string	Description. Omit to keep the existing description.
oneof _context.context	optional SavedViewContext	Surface the view applies to. Omit to keep the existing context.
oneof _selection.selection	optional SavedViewSelection	The selection. Required when creating; omit to keep the existing selection.
oneof _config.config	optional SavedViewConfig	Display configuration. Omit to keep the existing config.
oneof _visibility.visibility	optional SavedViewVisibility	Sharing state. Omit to keep the existing visibility.
oneof _grants.grants	optional GrantList	Access grants. When present, replaces the entire grant set (an empty list clears all grants); when omitted, grants are left unchanged. Changing grants requires manage/admin permission on the view.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard. When set, the update fails with a conflict if the view was modified since this etag was read.

UpsertResponse

(synq.savedviews.v1.UpsertResponse)

Field	Type	Description
view	SavedView	The stored view after the upsert.

Dataproduct

(synq.dataproducts.v2.Dataproduct) A data product: a named, owned grouping of data assets that share a purpose, with a membership definition, a priority and an optional folder.

Field	Type	Description
id	string	Opaque id of the data product (a UUID). Supplied by the caller on create, which makes Upsert idempotent.
entity_id	string	Stable, opaque platform identifier of this data product (of the form “dataproduct-<uuid>”). Output-only — the server derives it; never construct it by hand. This is the value other SYNQ APIs accept as an entity reference for this product (lineage, entities, alerts), so read it here and pass it there to point at the same product without needing to know how it is formed. `synq.owners.v1.OwnershipSelection.dataproduct_id` accepts this `entity_id` directly (or the bare `id`).
title	string	Human-readable title.
description	string	Optional longer description.
folder	string	Optional free-text folder used to group products in the UI.
priority	Priority	none
source	Source	none
definition	DataproductDefinition	The membership definition. Omitted when a read requests `exclude_definition`.
etag	string	Entity tag for optimistic concurrency: pass back on Upsert / Delete / definition writes to guard against overwriting a concurrent change. Form: `W/"<id>-<version>"`. Opaque — do not parse.
created_by	Actor	Who created the data product. Output-only.
updated_by	Actor	Who last edited the data product. Output-only.
created_at	Timestamp	When the data product was created. Output-only.
updated_at	Timestamp	When the data product was last updated. Output-only.
oneof _deleted_at.deleted_at	optional Timestamp	When the data product was soft-deleted, if it has been. Output-only.

BatchGetRequest

(synq.dataproducts.v2.BatchGetRequest)

Field	Type	Description
ids	repeated string	Ids to fetch (1–200, unique). Each accepts either the bare UUID or the `entity_id` form (`dataproduct-<uuid>`); the prefix is stripped server-side.
include_deleted	bool	Include soft-deleted products.
exclude_definition	bool	Omit the (potentially large) membership definition from each product.

BatchGetResponse

(synq.dataproducts.v2.BatchGetResponse)

Field	Type	Description
dataproducts	map DataproductsEntry	Products keyed by id. Ids that do not exist (or are deleted, unless requested) are absent.

BatchGetResponse.DataproductsEntry

(synq.dataproducts.v2.BatchGetResponse.DataproductsEntry)

Field	Type	Description
key	string	none
value	Dataproduct	none

DeleteRequest

(synq.dataproducts.v2.DeleteRequest)

Field	Type	Description
id	string	Id of the product to delete. Accepts the bare UUID or the `dataproduct-<uuid>` entity_id form (the prefix is stripped server-side).
purge	bool	Hard-delete instead of soft-delete, releasing the id for reuse.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.

DeleteResponse

(synq.dataproducts.v2.DeleteResponse)

ListMembersRequest

(synq.dataproducts.v2.ListMembersRequest)

Field	Type	Description
id	string	Id of the product whose members to list. Accepts the bare UUID or the `dataproduct-<uuid>` entity_id form (the prefix is stripped server-side).
pagination	Pagination	Pagination.

ListMembersResponse

(synq.dataproducts.v2.ListMembersResponse)

Field	Type	Description
entity_ids	repeated string	Opaque entity ids of the assets that currently belong to the product.
page_info	PageInfo	Pagination cursor for the next page.

ListRequest

(synq.dataproducts.v2.ListRequest)

Field	Type	Description
pagination	Pagination	Pagination.
oneof _folder.folder	optional string	Restrict to a single folder.
priorities	repeated Priority	Restrict to these priorities. Empty returns all priorities.
include_deleted	bool	Include soft-deleted products.
exclude_definition	bool	Omit the membership definition from each product.

ListResponse

(synq.dataproducts.v2.ListResponse)

Field	Type	Description
dataproducts	repeated Dataproduct	The matching products.
page_info	PageInfo	Pagination cursor for the next page.

RemoveDefinitionPartRequest

(synq.dataproducts.v2.RemoveDefinitionPartRequest)

Field	Type	Description
id	string	Id of the product. Accepts the bare UUID or the `dataproduct-<uuid>` entity_id form (the prefix is stripped server-side).
part_id	string	Id of the part to remove.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.
actor	Actor	Who is performing this write. Optional — identity is completed from the calling credentials; set it to attribute the change on behalf of a user.

RemoveDefinitionPartResponse

(synq.dataproducts.v2.RemoveDefinitionPartResponse)

Field	Type	Description
dataproduct	Dataproduct	The stored product after the part removal.

SetDefinitionRequest

(synq.dataproducts.v2.SetDefinitionRequest)

Field	Type	Description
id	string	Id of the product whose definition to replace. Accepts the bare UUID or the `dataproduct-<uuid>` entity_id form (the prefix is stripped server-side).
definition	DataproductDefinition	The new membership definition (replaces the existing one entirely).
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.
actor	Actor	Who is performing this write. Optional — identity is completed from the calling credentials; set it to attribute the change on behalf of a user.

SetDefinitionResponse

(synq.dataproducts.v2.SetDefinitionResponse)

Field	Type	Description
dataproduct	Dataproduct	The stored product after the definition write.

UpsertDefinitionPartRequest

(synq.dataproducts.v2.UpsertDefinitionPartRequest)

Field	Type	Description
id	string	Id of the product. Accepts the bare UUID or the `dataproduct-<uuid>` entity_id form (the prefix is stripped server-side).
part	Part	The part to add or replace (matched by its part id).
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.
actor	Actor	Who is performing this write. Optional — identity is completed from the calling credentials; set it to attribute the change on behalf of a user.

UpsertDefinitionPartResponse

(synq.dataproducts.v2.UpsertDefinitionPartResponse)

Field	Type	Description
dataproduct	Dataproduct	The stored product after the part write.

UpsertRequest

(synq.dataproducts.v2.UpsertRequest)

Field	Type	Description
id	string	Opaque id of the product. Accepts either the bare UUID or the `entity_id` form this API returns (`dataproduct-<uuid>`) — the prefix is stripped server-side, so the value you read back from any API can be passed straight in. The same id updates the same product; a new id creates a new product.
oneof _title.title	optional string	Title. Required when creating; omit to keep the existing title on update.
oneof _description.description	optional string	Description. Omit to keep the existing description.
oneof _folder.folder	optional string	Folder. Omit to keep the existing folder; pass an empty string to clear it.
oneof _priority.priority	optional Priority	Priority. Omit to keep the existing priority.
oneof _source.source	optional Source	Source. Omit to keep the existing source (defaults to SOURCE_SYNQ on create).
oneof _definition.definition	optional DataproductDefinition	Membership definition. Omit to keep the existing definition; pass a present (possibly empty) definition to replace it.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard. When set, the update fails with a conflict if the product was modified since this etag was read.
actor	Actor	Who is performing this write. Optional — identity is completed from the calling credentials; set it to attribute the change on behalf of a user.

UpsertResponse

(synq.dataproducts.v2.UpsertResponse)

Field	Type	Description
dataproduct	Dataproduct	The stored product after the upsert.

DataproductDefinition

(synq.dataproducts.v2.DataproductDefinition) The membership of a data product: which assets belong to it. A definition is an ordered list of parts; an asset is a member if it matches ANY part (the parts are OR’d together). A data product is a LEAF in the reference graph: its membership is defined only by asset-level predicates, static asset ids and lineage of those — never by referencing another data product or domain. The in_dataproduct / in_domain query operands are therefore rejected anywhere in a data product definition (see DataproductQuery). This keeps membership resolution finite: data products can never take part in a reference cycle.

Field	Type	Description
parts	repeated Part	The parts of the definition. An asset is a member if it matches any part.

DataproductDefinition.Part

(synq.dataproducts.v2.DataproductDefinition.Part) A single piece of a data product definition: either a pinned asset or a selection query.

Field	Type	Description
id	string	Stable id of this part (a UUID). Supplied by the caller for idempotent part upserts; the server mints one if left empty on create.
oneof part.entity_id	string	Pin a single asset by its opaque entity id (as returned by resolve / listing APIs). Never constructed by hand.
oneof part.query	DataproductQuery	Select assets by a query.

DataproductQuery

(synq.dataproducts.v2.DataproductQuery) The selection query behind a data product part, expressed for the public API. On write, provide the query in ONE of two forms:

public_query — a structured query (the same shape used elsewhere for asset selection), convenient to build from a filter UI; or
resolver_ql — the resolver query language, a compact text form that is the canonical way to author selections as code. When both are set, resolver_ql wins. The server compiles the query and stores it canonically; the raw text is not preserved verbatim.

On read, the server returns rendered_resolver_ql (the stored query rendered back to canonical resolver query language) and, best-effort, public_query (the structured representation). resolver_ql is not echoed back — read rendered_resolver_ql. Leaf rule: a data product may not reference another data product or domain. The in_dataproduct, in_domain and unsupported operands are rejected at the top level here (CEL) and, for nested sub-queries, by a server-side walk.

Field	Type	Description
resolver_ql	string	WRITE (option A). The query in resolver query language.
rendered_resolver_ql	string	READ, output-only. The stored query rendered back to canonical resolver query language. Deterministically derived; does not preserve original hand-typed formatting or comments.
public_query	Query	WRITE (option B) and READ. On write, the structured query to store (used when `resolver_ql` is empty). On read, a best-effort structured representation of the stored query.

Dataproduct

(synq.dataproducts.v1.Dataproduct)

Field	Type	Description
identifier	DataproductIdentifier	none
definition	DataproductDefinition	none
title	string	none
description	string	none
folder	string	none
priority	Priority	none
created_at	Timestamp	none
oneof _deleted_at.deleted_at	optional Timestamp	none
source	Source	Source for creation and management of dataproduct.

DeleteRequest

(synq.dataproducts.v1.DeleteRequest)

Field	Type	Description
identifier	DataproductIdentifier	none

DeleteResponse

(synq.dataproducts.v1.DeleteResponse)

GetRequest

(synq.dataproducts.v1.GetRequest)

Field	Type	Description
identifiers	repeated DataproductIdentifier	none

GetResponse

(synq.dataproducts.v1.GetResponse)

Field	Type	Description
products	repeated Dataproduct	none

ListRequest

(synq.dataproducts.v1.ListRequest)

Field	Type	Description
include_deleted	bool	none
exclude_definition	bool	none

ListResponse

(synq.dataproducts.v1.ListResponse)

Field	Type	Description
products	repeated Dataproduct	none

RemoveDefinitionPartRequest

(synq.dataproducts.v1.RemoveDefinitionPartRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
part_id	string	none

RemoveDefinitionPartResponse

(synq.dataproducts.v1.RemoveDefinitionPartResponse)

SetDefinitionRequest

(synq.dataproducts.v1.SetDefinitionRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
definition	DataproductDefinition	none

SetDefinitionResponse

(synq.dataproducts.v1.SetDefinitionResponse)

UpsertDefinitionPartRequest

(synq.dataproducts.v1.UpsertDefinitionPartRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
part	Part	none

UpsertDefinitionPartResponse

(synq.dataproducts.v1.UpsertDefinitionPartResponse)

UpsertRequest

(synq.dataproducts.v1.UpsertRequest)

Field	Type	Description
oneof _identifier.identifier	optional DataproductIdentifier	none
title	string	none
description	string	none
folder	string	none
priority	Priority	none
source	Source	none

UpsertResponse

(synq.dataproducts.v1.UpsertResponse)

Field	Type	Description
identifier	DataproductIdentifier	identifier of the updated or created dataproduct

AssetSelectionQuery

(synq.dataproducts.v1.AssetSelectionQuery)

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	none

AssetSelectionQuery.QueryPart

(synq.dataproducts.v1.AssetSelectionQuery.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_data_platform	InDataPlatform	none
oneof part.in_folder	InFolder	none
oneof part.with_data_platform_type	WithDataPlatformType	none
oneof part.query	AssetSelectionQuery	none
oneof part.unsupported	Unsupported	none

DataproductDefinition

(synq.dataproducts.v1.DataproductDefinition)

Field	Type	Description
parts	repeated Part	none

DataproductDefinition.Part

(synq.dataproducts.v1.DataproductDefinition.Part)

Field	Type	Description
id	string	part identifier
oneof part.identifier	Identifier	none
oneof part.query	AssetSelectionQuery	none

AddIssuesToIncidentRequest

(synq.incidents.v1.AddIssuesToIncidentRequest)

Field	Type	Description
incident_id	string	ID of the incident to add issues to
actor	Actor	Actor adding the issues
at	Timestamp	Time at which the issues were added. Defaults to the current time.
issue_ids	repeated string	IDs of issues to add to the incident

AddIssuesToIncidentResponse

(synq.incidents.v1.AddIssuesToIncidentResponse)

AssignIncidentOwnerRequest

(synq.incidents.v1.AssignIncidentOwnerRequest)

Field	Type	Description
incident_id	string	ID of the incident to assign the owner to
owner_email	string	none
actor	Actor	none

AssignIncidentOwnerResponse

(synq.incidents.v1.AssignIncidentOwnerResponse)

BatchGetIncidentsRequest

(synq.incidents.v1.BatchGetIncidentsRequest)

Field	Type	Description
incident_ids	repeated string	IDs of the incidents to get

BatchGetIncidentsResponse

(synq.incidents.v1.BatchGetIncidentsResponse)

Field	Type	Description
incidents	map IncidentsEntry	Incidents keyed by their IDs

BatchGetIncidentsResponse.IncidentsEntry

(synq.incidents.v1.BatchGetIncidentsResponse.IncidentsEntry)

Field	Type	Description
key	string	none
value	Incident	none

CancelIncidentRequest

(synq.incidents.v1.CancelIncidentRequest)

Field	Type	Description
incident_id	string	ID of the incident to cancel
actor	Actor	Actor cancelling the incident
at	Timestamp	Time at which the incident was cancelled. Defaults to the current time.

CancelIncidentResponse

(synq.incidents.v1.CancelIncidentResponse)

CloseIncidentRequest

(synq.incidents.v1.CloseIncidentRequest)

Field	Type	Description
incident_id	string	ID of the incident to close
actor	Actor	Actor closing the incident
at	Timestamp	Time at which the incident was closed. Defaults to the current time.

CloseIncidentResponse

(synq.incidents.v1.CloseIncidentResponse)

CreateIncidentRequest

(synq.incidents.v1.CreateIncidentRequest)

Field	Type	Description
issue_ids	repeated string	IDs of issues to add to the incident
name	string	Name of the incident
actor	Actor	Actor creating the incident
at	Timestamp	Time at which the incident was created. Defaults to the current time.
group_ids	repeated string	Optional group IDs associated with the incident
owner_email	string	none

CreateIncidentResponse

(synq.incidents.v1.CreateIncidentResponse)

Field	Type	Description
incident	Incident	none

ListIncidentsRequest

(synq.incidents.v1.ListIncidentsRequest)

Field	Type	Description
oneof _time.time	optional Time	Time range filter
oneof _sort.sort	optional Sort	Sort options
oneof _pagination.pagination	optional Pagination	Pagination
states	repeated State	Filter by states
affected_entities	repeated Identifier	Filter by affected entities

ListIncidentsRequest.Sort

(synq.incidents.v1.ListIncidentsRequest.Sort)

Field	Type	Description
sort_by	Field	none
order	Order	none

ListIncidentsRequest.Time

(synq.incidents.v1.ListIncidentsRequest.Time)

Field	Type	Description
field	Field	none
from	Timestamp	none
to	Timestamp	none

ListIncidentsResponse

(synq.incidents.v1.ListIncidentsResponse)

Field	Type	Description
incidents	repeated Incident	none

MergeIncidentsRequest

(synq.incidents.v1.MergeIncidentsRequest)

Field	Type	Description
incident_id	string	ID of the primary incident to merge into
actor	Actor	Actor performing the merge
at	Timestamp	Time at which the incidents were merged. Defaults to the current time.
other_incident_ids	repeated string	IDs of other incidents to merge into the primary incident

MergeIncidentsResponse

(synq.incidents.v1.MergeIncidentsResponse)

PostCommentRequest

(synq.incidents.v1.PostCommentRequest)

Field	Type	Description
incident_id	string	ID of the incident to post a comment on.
actor	Actor	Actor posting the comment.
comment	string	Comment to post.
oneof _at.at	optional Timestamp	Time at which the comment was posted. Defaults to the current time when not provided.

PostCommentResponse

(synq.incidents.v1.PostCommentResponse)

Field	Type	Description
comment_id	string	none

RemoveIssuesFromIncidentRequest

(synq.incidents.v1.RemoveIssuesFromIncidentRequest)

Field	Type	Description
incident_id	string	ID of the incident to remove issues from
actor	Actor	Actor removing the issues
at	Timestamp	Time at which the issues were removed. Defaults to the current time.
issue_ids	repeated string	IDs of issues to remove from the incident

RemoveIssuesFromIncidentResponse

(synq.incidents.v1.RemoveIssuesFromIncidentResponse)

RenameIncidentRequest

(synq.incidents.v1.RenameIncidentRequest)

Field	Type	Description
incident_id	string	ID of the incident to rename
actor	Actor	Actor renaming the incident
at	Timestamp	Time at which the incident was renamed. Defaults to the current time.
name	string	New name for the incident

RenameIncidentResponse

(synq.incidents.v1.RenameIncidentResponse)

SplitIncidentRequest

(synq.incidents.v1.SplitIncidentRequest)

Field	Type	Description
incident_id	string	ID of the incident to split
actor	Actor	Actor performing the split
at	Timestamp	Time at which the incident was split. Defaults to the current time.
split_issue_ids	repeated string	IDs of issues to move to the new incident
split_incident_name	string	Name for the new incident

SplitIncidentResponse

(synq.incidents.v1.SplitIncidentResponse)

Field	Type	Description
incident	Incident	none
split_incident	Incident	none

UpdateIncidentStateRequest

(synq.incidents.v1.UpdateIncidentStateRequest)

Field	Type	Description
incident_id	string	none
actor	Actor	Actor updating the incident state
at	Timestamp	Time at which the incident state was updated. Defaults to the current time.
state	State	New state for the incident

UpdateIncidentStateResponse

(synq.incidents.v1.UpdateIncidentStateResponse)

Field	Type	Description
incident	Incident	none

Incident

(synq.incidents.v1.Incident)

Field	Type	Description
id	string	ID of the incident.
index	int32	Index of the incident (for human-readable references).
name	string	Name of the incident.
issue_ids	repeated string	IDs of issues associated with this incident.
created_by	Actor	Actor who created the incident.
owner	User	Owner of the incident.
created_at	Timestamp	Time at which the incident was created.
updated_by	Actor	Actor who last updated the incident.
updated_at	Timestamp	Time at which the incident was last updated.
state	State	State of the incident.
comments	repeated IncidentComment	List of comments posted on the incident.

IncidentComment

(synq.incidents.v1.IncidentComment)

Field	Type	Description
id	string	none
message	string	none
created_at	Timestamp	none
actor	Actor	none

Enums

SnapDirection

(synq.schedule.v1.SnapDirection) SnapDirection constrains which way an occurrence may move to reach the grid.

Name	Number	Description
SNAP_DIRECTION_UNSPECIFIED	0	Move to whichever grid point is closest. Same as NEAREST.
SNAP_DIRECTION_NEAREST	1	Move to whichever grid point is closest.
SNAP_DIRECTION_FORWARD	2	Only delay an occurrence to a later grid point, never move it earlier.
SNAP_DIRECTION_BACKWARD	3	Only move an occurrence earlier to a prior grid point, never delay it.

DataPlatformType

(synq.platforms.v1.DataPlatformType)

Name	Number	Description
DATA_PLATFORM_TYPE_UNSPECIFIED	0	none
DATA_PLATFORM_TYPE_BIGQUERY	10	none
DATA_PLATFORM_TYPE_LOOKER	20	none
DATA_PLATFORM_TYPE_DBT	30	none
DATA_PLATFORM_TYPE_DBT_CLOUD	31	none
DATA_PLATFORM_TYPE_DBT_SELF_HOSTED	32	none
DATA_PLATFORM_TYPE_SNOWFLAKE	50	none
DATA_PLATFORM_TYPE_GCP	60	none
DATA_PLATFORM_TYPE_GIT	70	none
DATA_PLATFORM_TYPE_GITHUB	71	none
DATA_PLATFORM_TYPE_REDSHIFT	80	none
DATA_PLATFORM_TYPE_TABLEAU	110	none
DATA_PLATFORM_TYPE_AIRFLOW	120	none
DATA_PLATFORM_TYPE_CLICKHOUSE	130	none
DATA_PLATFORM_TYPE_POSTGRES	160	none
DATA_PLATFORM_TYPE_MYSQL	170	none
DATA_PLATFORM_TYPE_DATABRICKS	180	none
DATA_PLATFORM_TYPE_SQLMESH	190	none
DATA_PLATFORM_TYPE_DUCKDB	200	none
DATA_PLATFORM_TYPE_TRINO	210	none
DATA_PLATFORM_TYPE_ATLAN	220	none
DATA_PLATFORM_TYPE_COALESCE	230	none
DATA_PLATFORM_TYPE_CASTORDOC	240	none
DATA_PLATFORM_TYPE_POWERBI	300	none
DATA_PLATFORM_TYPE_THOUGHTSPOT	310	none
DATA_PLATFORM_TYPE_SIGMA	320	none
DATA_PLATFORM_TYPE_DOMO	330	none
DATA_PLATFORM_TYPE_MSSQL	340	none
DATA_PLATFORM_TYPE_ORACLE	350	none
DATA_PLATFORM_TYPE_ATHENA	360	none
DATA_PLATFORM_TYPE_FABRIC	370	none
DATA_PLATFORM_TYPE_SYNQ	1000	none

Owner.Source

(synq.owners.v1.Owner.Source) Where the owner is managed. Owners from an external source (e.g. Atlan) are read-only.

Name	Number	Description
SOURCE_SYNQ	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_ATLAN	1	none

QueryOperand

(synq.queries.v1.QueryOperand) QueryOperand defines how multiple QueryParts within a Query are combined.

Name	Number	Description
QUERY_OPERAND_UNSPECIFIED	0	Defaults to AND behaviour.
QUERY_OPERAND_AND	1	Intersection: returns only entities present in ALL parts.
QUERY_OPERAND_OR	2	Union: returns entities present in ANY part.
QUERY_OPERAND_EXCEPT	3	Set difference: requires exactly 2 parts. Returns entities from parts[0] that are NOT in parts[1].
QUERY_OPERAND_UPSTREAM	4	Lineage traversal: returns all upstream dependencies of the entities matched by the parts (combined with AND).
QUERY_OPERAND_DOWNSTREAM	5	Lineage traversal: returns all downstream dependents of the entities matched by the parts (combined with AND).

Event.EventType

(synq.webhooks.v1.Event.EventType)

Name	Number	Description
EVENT_TYPE_UNSPECIFIED	0	none
EVENT_TYPE_PING	10	none
EVENT_TYPE_ISSUE_CREATED	11	none
EVENT_TYPE_ISSUE_UPDATED	12	none
EVENT_TYPE_ISSUE_STATUS_UPDATED	13	none
EVENT_TYPE_ISSUE_CLOSED	14	none
EVENT_TYPE_INCIDENT_OPEN	20	none
EVENT_TYPE_INCIDENT_CLOSED	21	none
EVENT_TYPE_INCIDENT_CANCELLED	22	none

IssueSummary.IssueStatus

(synq.webhooks.v1.IssueSummary.IssueStatus)

Name	Number	Description
ISSUE_STATUS_UNSPECIFIED	0	none
ISSUE_STATUS_INVESTIGATING	1	none
ISSUE_STATUS_EXPECTED	2	none
ISSUE_STATUS_FIXED	3	none
ISSUE_STATUS_NO_ACTION_NEEDED	4	none

HealthStatus

(synq.integrations.v1.HealthStatus) Health status of an integration, derived from its most recent runs.

Name	Number	Description
HEALTH_STATUS_UNSPECIFIED	0	Unknown — no runs observed yet.
HEALTH_STATUS_OK	1	Last run succeeded.
HEALTH_STATUS_WARN	2	Last run completed with warnings.
HEALTH_STATUS_ERROR	3	Last run failed.
HEALTH_STATUS_CRITICAL	4	Last run failed critically (for example authentication or connectivity failure).

Status

(synq.extensions.atlan.workflows.v1.Status)

Name	Number	Description
STATUS_UNSPECIFIED	0	none
STATUS_OK	1	none
STATUS_FAILED	2	none

Severity

(synq.v1.Severity)

Name	Number	Description
SEVERITY_UNSPECIFIED	0	Invalid/unspecified severity
SEVERITY_WARN	1	Warning level failures
SEVERITY_ERROR	2	Error level failures
SEVERITY_FATAL	3	Fatal/critical failures

Source

(synq.v1.Source)

Name	Number	Description
SOURCE_APP	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_API	1	none

Scope

(synq.v1.Scope)

Name	Number	Description
SCOPE_UNSPECIFIED	0	none
SCOPE_ISSUES_EDIT	10	none
SCOPE_ISSUES_READ	11	none
SCOPE_INCIDENTS_EDIT	13	none
SCOPE_INCIDENTS_READ	14	none
SCOPE_ENTITY_EDIT	30	none
SCOPE_ENTITY_READ	31	none
SCOPE_ENTITY_TYPE_EDIT	32	none
SCOPE_ENTITY_TYPE_READ	33	none
SCOPE_LINEAGE_EDIT	34	none
SCOPE_LINEAGE_READ	35	none
SCOPE_CODE_READ	37	none
SCOPE_STATUS_READ	40	none
SCOPE_INGEST_DBT	41	none
SCOPE_INGEST_SQLMESH	42	none
SCOPE_INGEST_DWH	43	none
SCOPE_INGEST_SRE	44	none
SCOPE_INGEST_AIRFLOW	45	none
SCOPE_INGEST_CLOUDWATCH	46	none
SCOPE_INGEST_OPENLINEAGE	47	none
SCOPE_DATACHECKS_SQLTESTS_EDIT	50	none
SCOPE_DATACHECKS_SQLTESTS_READ	51	none
SCOPE_DATACHECKS_SQLTESTS_AUDIT_READ	52	none
SCOPE_DATACHECKS_TESTSUGGESTIONS_EDIT	53	none
SCOPE_DATACHECKS_TESTSUGGESTIONS_READ	54	none
SCOPE_DATACHECKS_TRIGGER	55	none
SCOPE_EXECUTION_EDIT	60	none
SCOPE_EXECUTION_LOG_EDIT	61	none
SCOPE_EXECUTION_READ	62	none
SCOPE_HOOK	70	none
SCOPE_SRE_AGENT	71	none
SCOPE_SRE_LLM	72	none
SCOPE_INTEGRATION_EDIT	80	none
SCOPE_INTEGRATION_READ	81	none
SCOPE_USER_EDIT	90	none
SCOPE_USER_READ	91	none
SCOPE_USER_ASSIGN	92	none
SCOPE_MONITORS_READ	111	none
SCOPE_MONITORS_AUTOMATIC_EDIT	112	none
SCOPE_MONITORS_CUSTOM_EDIT	113	none
SCOPE_MONITORS_CUSTOM_SQL_EDIT	116	none
SCOPE_ALERTS_EDIT	130	none
SCOPE_ALERTS_READ	131	none
SCOPE_OWNERS_EDIT	140	none
SCOPE_OWNERS_READ	141	none
SCOPE_OWNERSHIP_EDIT	144	none
SCOPE_OWNERSHIP_READ	145	none
SCOPE_DATAPRODUCT_EDIT	150	none
SCOPE_DATAPRODUCT_READ	151	none
SCOPE_DOMAIN_EDIT	160	none
SCOPE_DOMAIN_READ	161	none
SCOPE_EXTENSIONS_MANAGE	180	none
SCOPE_USAGE_GET	192	none
SCOPE_MCP_READ	200	none
SCOPE_MCP_WRITE	201	none
SCOPE_RECON_READ	210	none
SCOPE_RECON_EDIT	211	none
SCOPE_INGEST_RECON	212	none
SCOPE_RECON_PROMOTE	213	none
SCOPE_POLICIES_EDIT	220	none
SCOPE_POLICIES_READ	221	none
SCOPE_SAVED_VIEW_READ	230	none
SCOPE_SAVED_VIEW_EDIT	231	none
SCOPE_SAVED_VIEW_ADMIN	232	none

ListIssuesRequest.Field

(synq.issues.v2.ListIssuesRequest.Field)

Name	Number	Description
FIELD_UPDATED_AT	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
FIELD_STARTED_AT	1	none

ListIssuesRequest.Sort.Order

(synq.issues.v2.ListIssuesRequest.Sort.Order)

Name	Number	Description
ORDER_ASC	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
ORDER_DESC	1	none

Actor.Via

(synq.issues.actor.v1.Actor.Via)

Name	Number	Description
VIA_UNSPECIFIED	0	Unknown / not set
VIA_API	1	Public API
VIA_MCP	2	Official MCP server
VIA_SLACK	3	Slack bot integration
VIA_PAGERDUTY	4	PagerDuty webhook

LifecycleState

(synq.issues.issues.v1.LifecycleState) Issue LifecycleState represents the current state of the issue in its life-cycle. The state is exclusively determined as per the priority which is in the order of the fields below.

Name	Number	Description
LIFECYCLE_STATE_UNSPECIFIED	0	none
LIFECYCLE_STATE_UNTRIAGED	1	Issue has not been triaged yet. A triaged issue is one that has been acted upon (status update or incident declaration)
LIFECYCLE_STATE_CLOSED	2	Issue is closed. This is a terminal state.
LIFECYCLE_STATE_ONGOING_RESOLVED	3	Open issue that has been marked as resolved by the user.
LIFECYCLE_STATE_ONGOING_DECLARED	4	Open issue that has been declared as an incident.
LIFECYCLE_STATE_ONGOING_STATUS_SET	5	Open issue that has status set.
LIFECYCLE_STATE_AUTOTRIAGE_QUEUED	11	Open issue that has been queued for autotriage.
LIFECYCLE_STATE_AUTOTRIAGE_ACTION_SUGGESTED	12	Issue has been autotriaged and an action has been suggested.

Severity

(synq.issues.issues.v1.Severity)

Name	Number	Description
SEVERITY_UNSPECIFIED	0	none
SEVERITY_INFO	1	none
SEVERITY_WARN	2	none
SEVERITY_ERROR	3	none
SEVERITY_FATAL	4	none

State

(synq.issues.issues.v1.State) Whether the issue is open / close.

Name	Number	Description
STATE_UNSPECIFIED	0	none
STATE_OPEN	1	none
STATE_CLOSED	2	none

Status

(synq.issues.issues.v1.Status) Progress status of the issue.

Name	Number	Description
STATUS_UNSPECIFIED	0	none
STATUS_INVESTIGATING	1	none
STATUS_EXPECTED	2	none
STATUS_FIXED	3	none
STATUS_NO_ACTION_NEEDED	4	none

Config.Agent.LogLevel

(synq.agent.dwh.v1.Config.Agent.LogLevel)

Name	Number	Description
LOG_LEVEL_UNSPECIFIED	0	Defaults to info
LOG_LEVEL_TRACE	1	none
LOG_LEVEL_DEBUG	2	none
LOG_LEVEL_INFO	3	none
LOG_LEVEL_WARN	4	none
LOG_LEVEL_ERROR	5	none

LogLevel

(synq.agent.dwh.v1.LogLevel)

Name	Number	Description
LOG_LEVEL_UNSPECIFIED	0	none
LOG_LEVEL_INFO	1	none
LOG_LEVEL_WARN	2	none
LOG_LEVEL_ERROR	3	none

ConnectionResolutionReason

(synq.agent.recon.v1.ConnectionResolutionReason) Reason why a single connection could not be resolved.

Name	Number	Description
CONNECTION_RESOLUTION_REASON_UNSPECIFIED	0	none
CONNECTION_RESOLUTION_REASON_NOT_PROVIDED	1	No mapping was supplied and no workspace integration matches the connection name.
CONNECTION_RESOLUTION_REASON_INTEGRATION_NOT_FOUND	2	Mapping references an integration that does not exist or the caller cannot see it.
CONNECTION_RESOLUTION_REASON_CREDENTIAL_NOT_ALLOWED	3	Mapping uses a credential plane the caller is not allowed to use (e.g. user_integration_id without a user identity, or workspace integration_id without SCOPE_INTEGRATION_EDIT).
CONNECTION_RESOLUTION_REASON_CAPABILITY_DISABLED	4	Integration exists but the allow_reconciliation_adhoc / allow_reconciliation_deploy capability gate is disabled for it.

DeploymentAction

(synq.agent.recon.v1.DeploymentAction)

Name	Number	Description
DEPLOYMENT_ACTION_UNSPECIFIED	0	none
DEPLOYMENT_ACTION_PROMOTED	1	none
DEPLOYMENT_ACTION_REPROMOTED	2	none
DEPLOYMENT_ACTION_SCHEDULE_CHANGED	3	none
DEPLOYMENT_ACTION_MAPPINGS_CHANGED	4	none
DEPLOYMENT_ACTION_PAUSED	5	none
DEPLOYMENT_ACTION_RESUMED	6	none
DEPLOYMENT_ACTION_UNPROMOTED	7	none
DEPLOYMENT_ACTION_ANNOTATIONS_CHANGED	8	none
DEPLOYMENT_ACTION_CASE_IMPACTS_CHANGED	9	none

AggregateFunction

(synq.agent.recon.v1.AggregateFunction) AggregateFunction defines the supported SQL aggregate functions for measure comparisons in aggregate reconciliation mode.

Name	Number	Description
AGGREGATE_FUNCTION_UNSPECIFIED	0	none
AGGREGATE_FUNCTION_SUM	1	SQL SUM() — total of all values in the group.
AGGREGATE_FUNCTION_COUNT	2	SQL COUNT() — number of rows in the group.
AGGREGATE_FUNCTION_AVG	3	SQL AVG() — arithmetic mean of values in the group.
AGGREGATE_FUNCTION_MIN	4	SQL MIN() — smallest value in the group.
AGGREGATE_FUNCTION_MAX	5	SQL MAX() — largest value in the group.

PercentageMode

(synq.agent.recon.v1.PercentageMode) PercentageMode controls which percentage formula is used for threshold comparison. The choice affects how “big” a difference appears when source and target values differ in magnitude.

Name	Number	Description
PERCENTAGE_MODE_UNSPECIFIED	0	Default: source.
PERCENTAGE_MODE_SOURCE	1		diff	/	source	— “target is X% off from source.” Best when source is the authoritative baseline.
PERCENTAGE_MODE_TARGET	2		diff	/	target	— “source is X% off from target.” Best when target is the authoritative baseline.
PERCENTAGE_MODE_SYMMETRIC	3	2 *	diff	/ (	source	+	target	) — symmetric, neither side is privileged. Best when both sides are equally authoritative.

ReconciliationRunFailureCategory

(synq.agent.recon.v1.ReconciliationRunFailureCategory) ReconciliationRunFailureCategory classifies why a run ended in FAILED. Clients use this to render appropriate user-facing messages.

Name	Number	Description
RECONCILIATION_RUN_FAILURE_CATEGORY_UNSPECIFIED	0	none
RECONCILIATION_RUN_FAILURE_CATEGORY_CONNECTIVITY	1	Could not connect to source/target warehouse or other upstream.
RECONCILIATION_RUN_FAILURE_CATEGORY_CONFIG_INVALID	2	Suite config or environment was rejected at execution time.
RECONCILIATION_RUN_FAILURE_CATEGORY_EXECUTION_ERROR	3	Reconciliation execution itself returned an error.
RECONCILIATION_RUN_FAILURE_CATEGORY_INTERNAL	4	Unexpected internal error.
RECONCILIATION_RUN_FAILURE_CATEGORY_TIMEOUT	5	Run exceeded its configured wall-clock execution timeout and was cancelled before completing.

ReconciliationRunStatus

(synq.agent.recon.v1.ReconciliationRunStatus) ReconciliationRunStatus is the lifecycle state of a single reconciliation run.

Name	Number	Description
RECONCILIATION_RUN_STATUS_UNSPECIFIED	0	none
RECONCILIATION_RUN_STATUS_SCHEDULED	1	Run has been queued but not yet picked up by the worker.
RECONCILIATION_RUN_STATUS_IN_PROGRESS	2	Worker has started executing the run.
RECONCILIATION_RUN_STATUS_SUCCEEDED	3	Run completed successfully.
RECONCILIATION_RUN_STATUS_FAILED	4	Run completed with a failure.
RECONCILIATION_RUN_STATUS_CANCELLED	5	Run was skipped or cancelled before/during execution (e.g. suite deleted, deployment paused).

ReconciliationRunTrigger

(synq.agent.recon.v1.ReconciliationRunTrigger) ReconciliationRunTrigger describes why a run was created.

Name	Number	Description
RECONCILIATION_RUN_TRIGGER_UNSPECIFIED	0	none
RECONCILIATION_RUN_TRIGGER_ADHOC	1	User submitted an ad-hoc suite via SubmitAdhocSuite.
RECONCILIATION_RUN_TRIGGER_SCHEDULED	2	Scheduler enqueued the run from a deployment / managed-suite cron.
RECONCILIATION_RUN_TRIGGER_API	3	External API call triggered the run (e.g. CI hook, future TriggerDeployment RPC).

CaseFailureImpact

(synq.agent.recon.v1.CaseFailureImpact) CaseFailureImpact controls whether a reconciliation case’s referenced tables (resolved from the source/target SQL at deploy time) inherit the case’s failure status, or are only attached to the run for visibility. This is a deployment-time policy, not part of the suite YAML — it is set on PromoteSuite / UpdateDeploymentCaseImpacts and stored on the promoted deployment, not on the authored config. Letting operators flip impact without editing the suite keeps configuration declarative and lets the FE offer “apply to all” without round-tripping YAML.

Name	Number	Description
CASE_FAILURE_IMPACT_UNSPECIFIED	0	Defaults to RAISE_ISSUE_ON_TABLES.
CASE_FAILURE_IMPACT_RAISE_ISSUE_ON_TABLES	1	The referenced tables are treated as outcomes of the run: a failed case opens issues on each table, and the table’s overall health reflects the reconciliation result. Use this when the reconciliation authoritatively validates the tables it references.
CASE_FAILURE_IMPACT_SHOW_ON_TABLES	2	The referenced tables appear on the run for visibility only. The run is listed in each table’s run history but never raises an issue on them. Use this for advisory checks that should not impact the table’s published health.

HashAlgorithm

(synq.agent.recon.v1.HashAlgorithm) HashAlgorithm specifies the hash function used for row checksums in ROW_CHECKSUM mode. Different databases natively support different hash functions; choosing one supported by both sides avoids emulation overhead.

Name	Number	Description
HASH_ALGORITHM_UNSPECIFIED	0	Auto-negotiates the best common algorithm between source and target. Prefers the fastest algorithm supported natively by both databases.
HASH_ALGORITHM_MD5	1	MD5 — widely supported across all databases. Slowest but most compatible.
HASH_ALGORITHM_FARM_FINGERPRINT	2	FarmHash Fingerprint64 — native to BigQuery. Fast for BigQuery-to-BigQuery.
HASH_ALGORITHM_XXHASH64	3	xxHash64 — native to Databricks and Snowflake. Fast for those dialects.

ReconcilationMode

(synq.agent.recon.v1.ReconcilationMode) ReconcilationMode defines the comparison strategy for a reconciliation. Modes are ordered by depth of comparison: ROW_COUNT < ROW_CHECKSUM < AGGREGATE.

Name	Number	Description
RECONCILATION_MODE_UNSPECIFIED	0	none
RECONCILATION_MODE_ROW_COUNT	1	Compare row counts only — no data access, just verifies both sides have the same number of rows. Fastest mode, useful as a smoke test.
RECONCILATION_MODE_ROW_CHECKSUM	2	Row-level checksum comparison with hierarchical bisection drill-down to locate individual mismatched rows. The default and most thorough mode for exact row-by-row comparison.
RECONCILATION_MODE_AGGREGATE	3	Aggregate comparison — GROUP BY with configurable measures (SUM, AVG, etc.) and tolerance thresholds. Best for large datasets where exact row matching is impractical, or when business-level metrics matter more than individual rows.

ReportingLevel

(synq.agent.recon.v1.ReportingLevel) ReportingLevel controls how much detail is included in results for mismatched rows. Levels are ordered by increasing data exposure.

Name	Number	Description
REPORTING_LEVEL_UNSPECIFIED	0	Default: COUNT_ONLY.
REPORTING_LEVEL_COUNT_ONLY	1	Only report mismatch counts per segment. No row-level information is exposed. Privacy-safe.
REPORTING_LEVEL_WITH_KEYS	2	Include primary key values of mismatched rows. Reveals which rows differ, but not the actual data values.
REPORTING_LEVEL_DETAILED	3	Include full column values for mismatched rows. Requires consent_acknowledged = true. Warning: may expose sensitive data in the audit log.

SegmentationStrategy

(synq.agent.recon.v1.SegmentationStrategy) SegmentationStrategy defines how key ranges are split during bisection. The strategy affects both performance and privacy characteristics.

Name	Number	Description
SEGMENTATION_STRATEGY_UNSPECIFIED	0	Auto: defaults to quantile.
SEGMENTATION_STRATEGY_QUANTILE	1	NTILE-based key-range splitting. Uses the key column’s actual values to create equal-count segments. Note: exposes key values in segment boundaries in the audit log.
SEGMENTATION_STRATEGY_HASH	2	Hash-based bucketing followed by range drill-down. Uses a hash of the key column for segmentation. Privacy-safe: does not expose raw key values in the audit log.
SEGMENTATION_STRATEGY_TIME	3	Time-based partitioning followed by range drill-down. Splits by time buckets using the configured time_column and time_granularity. Requires time_column to be set. Best for time-series data with a natural temporal ordering (e.g., event logs, daily snapshots).

TimeGranularity

(synq.agent.recon.v1.TimeGranularity) TimeGranularity defines the granularity for time-based segmentation.

Name	Number	Description
TIME_GRANULARITY_UNSPECIFIED	0	Default: DAY.
TIME_GRANULARITY_HOUR	1	none
TIME_GRANULARITY_DAY	2	none
TIME_GRANULARITY_WEEK	3	none
TIME_GRANULARITY_MONTH	4	none
TIME_GRANULARITY_QUARTER	5	none
TIME_GRANULARITY_YEAR	6	none

WindowStrategy

(synq.agent.recon.v1.WindowStrategy) WindowStrategy defines how the time window boundaries are computed.

Name	Number	Description
WINDOW_STRATEGY_UNSPECIFIED	0	Default: SLIDING.
WINDOW_STRATEGY_SLIDING	1	Sliding window: window_start = now - lookback. Each run covers a different absolute time range.
WINDOW_STRATEGY_FIXED	2	Fixed window: boundaries are aligned to calendar periods. Each run within the same period covers the same absolute time range.

CutoffAggregate

(synq.agent.recon.v1.CutoffAggregate) CutoffAggregate defines the aggregate function for watermark derivation.

Name	Number	Description
CUTOFF_AGGREGATE_UNSPECIFIED	0	Default: MAX.
CUTOFF_AGGREGATE_MAX	1	none
CUTOFF_AGGREGATE_MIN	2	none

CutoffCombine

(synq.agent.recon.v1.CutoffCombine) CutoffCombine defines how to combine watermarks from source and target.

Name	Number	Description
CUTOFF_COMBINE_UNSPECIFIED	0	Default: MIN.
CUTOFF_COMBINE_MIN	1	Use the smaller of source and target watermarks (safe default).
CUTOFF_COMBINE_MAX	2	Use the larger of source and target watermarks.
CUTOFF_COMBINE_SOURCE	3	Use only the source watermark (target must not be configured).
CUTOFF_COMBINE_TARGET	4	Use only the target watermark (source must not be configured).

CutoffTruncate

(synq.agent.recon.v1.CutoffTruncate) CutoffTruncate defines time truncation for the cutoff value.

Name	Number	Description
CUTOFF_TRUNCATE_UNSPECIFIED	0	No truncation (default).
CUTOFF_TRUNCATE_HOUR	1	none
CUTOFF_TRUNCATE_DAY	2	none
CUTOFF_TRUNCATE_WEEK	3	none
CUTOFF_TRUNCATE_MONTH	4	none
CUTOFF_TRUNCATE_QUARTER	5	none
CUTOFF_TRUNCATE_YEAR	6	none

AggregateDivergenceType

(synq.agent.recon.v1.AggregateDivergenceType) AggregateDivergenceType categorizes how an aggregate group diverges.

Name	Number	Description
AGGREGATE_DIVERGENCE_TYPE_UNSPECIFIED	0	none
AGGREGATE_DIVERGENCE_TYPE_MISMATCH	1	Values differ between source and target.
AGGREGATE_DIVERGENCE_TYPE_MISSING_SOURCE	2	Group exists in target but not in source.
AGGREGATE_DIVERGENCE_TYPE_MISSING_TARGET	3	Group exists in source but not in target.
AGGREGATE_DIVERGENCE_TYPE_VALUE_MISMATCH	4	Values differ (synonym for mismatch, used in specific contexts).

AuditStatus

(synq.agent.recon.v1.AuditStatus) AuditStatus describes the overall outcome of a reconciliation run. Values are ordered by severity: passed < within_threshold < mismatched < failed.

Name	Number	Description
AUDIT_STATUS_UNSPECIFIED	0	none
AUDIT_STATUS_PASSED	1	All reconciliations completed and matched exactly.
AUDIT_STATUS_MISMATCHED_WITHIN_THRESHOLD	2	Differences were found but all were within configured thresholds. No reconciliation had hard mismatches or infrastructure errors. This is a warning-level outcome.
AUDIT_STATUS_MISMATCHED	3	At least one reconciliation found data differences exceeding configured thresholds (or no thresholds were configured).
AUDIT_STATUS_FAILED	4	At least one reconciliation encountered an infrastructure error (connection failure, query error, setup failure, etc.).

MeasureVerdictReason

(synq.agent.recon.v1.MeasureVerdictReason) MeasureVerdictReason explains the threshold evaluation outcome.

Name	Number	Description
MEASURE_VERDICT_REASON_UNSPECIFIED	0	none
MEASURE_VERDICT_REASON_EXACT_MATCH	1	none
MEASURE_VERDICT_REASON_WITHIN_ABSOLUTE_THRESHOLD	2	none
MEASURE_VERDICT_REASON_WITHIN_PERCENTAGE_THRESHOLD	3	none
MEASURE_VERDICT_REASON_EXCEEDED_ALL_THRESHOLDS	4	none
MEASURE_VERDICT_REASON_NO_THRESHOLDS_CONFIGURED	5	none

MismatchType

(synq.agent.recon.v1.MismatchType) MismatchType categorizes how rows differ between source and target.

Name	Number	Description
MISMATCH_TYPE_UNSPECIFIED	0	none
MISMATCH_TYPE_MISSING_IN_SOURCE	1	none
MISMATCH_TYPE_MISSING_IN_TARGET	2	none
MISMATCH_TYPE_COUNT_MISMATCH	3	none
MISMATCH_TYPE_DATA_MISMATCH	4	none
MISMATCH_TYPE_UNKNOWN	5	none

QueryRole

(synq.agent.recon.v1.QueryRole) QueryRole identifies whether a query targets the source or target database.

Name	Number	Description
QUERY_ROLE_UNSPECIFIED	0	none
QUERY_ROLE_SOURCE	1	none
QUERY_ROLE_TARGET	2	none

ReconciliationStatus

(synq.agent.recon.v1.ReconciliationStatus) ReconciliationStatus describes the outcome of a single reconciliation. Distinguishes infrastructure errors from data comparison results. Values are ordered by severity: passed < within_threshold < mismatched < failed.

Name	Number	Description
RECONCILIATION_STATUS_UNSPECIFIED	0	none
RECONCILIATION_STATUS_PASSED	1	Reconciliation completed and data matched exactly — no differences found.
RECONCILIATION_STATUS_MISMATCHED_WITHIN_THRESHOLD	2	Reconciliation found data differences but all differences were within configured thresholds. This is a warning-level outcome — data differs but within acceptable tolerance.
RECONCILIATION_STATUS_MISMATCHED	3	Reconciliation completed but found data differences that exceed configured thresholds (or no thresholds were configured).
RECONCILIATION_STATUS_FAILED	4	Reconciliation encountered an infrastructure error (connection failure, query error, setup failure, etc.) and could not complete the comparison.

RowMismatchType

(synq.agent.recon.v1.RowMismatchType) RowMismatchType categorizes a single row-level mismatch.

Name	Number	Description
ROW_MISMATCH_TYPE_UNSPECIFIED	0	none
ROW_MISMATCH_TYPE_MISSING_IN_TARGET	1	none
ROW_MISMATCH_TYPE_MISSING_IN_SOURCE	2	none
ROW_MISMATCH_TYPE_MODIFIED	3	none

StageType

(synq.agent.recon.v1.StageType) StageType identifies the type of reconciliation stage.

Name	Number	Description
STAGE_TYPE_UNSPECIFIED	0	none
STAGE_TYPE_QUICK_CHECK	1	Single-query count + checksum comparison.
STAGE_TYPE_BISECTION_DRILL	2	Recursive bisection drill-down to locate mismatches.
STAGE_TYPE_AGGREGATE_CHECK	3	Aggregate GROUP BY comparison with measures and thresholds.

TerminationReason

(synq.agent.recon.v1.TerminationReason) TerminationReason explains why bisection stopped at a particular node.

Name	Number	Description
TERMINATION_REASON_UNSPECIFIED	0	none
TERMINATION_REASON_THRESHOLD_REACHED	1	none
TERMINATION_REASON_MAX_DEPTH_REACHED	2	none
TERMINATION_REASON_EMPTY_SEGMENT	3	none
TERMINATION_REASON_CANNOT_SPLIT	4	none
TERMINATION_REASON_MATCHED	5	none
TERMINATION_REASON_ERROR	6	none

PromptField

(synq.agent.sre.v1.PromptField) PromptField identifies which SRE agent system-prompt a suggestion targets. Mirrors the four *_system_prompt fields returned by GetConfig.

Name	Number	Description
PROMPT_FIELD_UNSPECIFIED	0	none
PROMPT_FIELD_TRIAGE	1	none
PROMPT_FIELD_TESTER	2	none
PROMPT_FIELD_WORKSPACE	3	none
PROMPT_FIELD_ISSUE_GROUPING	4	none

PromptSuggestionStatus

(synq.agent.sre.v1.PromptSuggestionStatus) PromptSuggestionStatus is the review lifecycle of a single prompt suggestion. SUPERSEDED indicates a newer pending suggestion for the same field replaced this one before it was reviewed.

Name	Number	Description
PROMPT_SUGGESTION_STATUS_UNSPECIFIED	0	none
PROMPT_SUGGESTION_STATUS_PENDING	1	none
PROMPT_SUGGESTION_STATUS_ACCEPTED	2	none
PROMPT_SUGGESTION_STATUS_DISMISSED	3	none
PROMPT_SUGGESTION_STATUS_SUPERSEDED	4	none

MessageRole

(synq.agent.sre.v1.MessageRole) Role of the message in the conversation.

Name	Number	Description
MESSAGE_ROLE_UNSPECIFIED	0	none
MESSAGE_ROLE_USER	1	Message from the user/human.
MESSAGE_ROLE_ASSISTANT	2	Message from the assistant/LLM.

ModelType

(synq.agent.sre.v1.ModelType) Type of model to use for the evaluation.

Name	Number	Description
MODEL_TYPE_UNSPECIFIED	0	none
MODEL_TYPE_SUMMARY	1	Summary model - faster and cheaper, suitable for simple tasks. This is the default when not specified.
MODEL_TYPE_THINKING	2	Thinking model - more capable, suitable for complex reasoning tasks.

TestSuggestionStatus

(synq.agent.sre.v1.TestSuggestionStatus)

Name	Number	Description
TEST_SUGGESTION_STATUS_UNSPECIFIED	0	none
TEST_SUGGESTION_STATUS_SCHEDULED	1	none
TEST_SUGGESTION_STATUS_RUNNING	2	none
TEST_SUGGESTION_STATUS_COMPLETED	3	none
TEST_SUGGESTION_STATUS_FAILED	4	none
TEST_SUGGESTION_STATUS_CANCELLED	5	none

IssueTriageStatus

(synq.agent.sre.v1.IssueTriageStatus) IssueTriageStatus represents the current stage of an issue in the SRE agent’s investigation workflow. The status progresses as the agent collects evidence and reaches conclusions about the issue.

Name	Number	Description
ISSUE_TRIAGE_STATUS_UNSPECIFIED	0	Default value, should not be used
ISSUE_TRIAGE_STATUS_SCHEDULED	1	Issue has been queued for investigation but the SRE agent has not started processing it yet
ISSUE_TRIAGE_STATUS_IN_PROGRESS	2	SRE agent is actively investigating the issue, collecting evidence and analyzing the situation
ISSUE_TRIAGE_STATUS_CANCELLED	7	Issue has been scheduled but later cancelled
ISSUE_TRIAGE_STATUS_FAILED	8	Issue wasn’t triaged as such process failed. Scheduling again is possible.
ISSUE_TRIAGE_STATUS_TRIAGED	3	SRE agent has generated conclusion for the issue
ISSUE_TRIAGE_STATUS_ACCEPTED	4	User accepted the issue conclusion SRE agent has determined
ISSUE_TRIAGE_STATUS_IGNORED	5	User Discarded the issue conclusion SRE agent has determined
ISSUE_TRIAGE_STATUS_CLOSED	6	Issue was closed by the system

TriageFailureCategory

(synq.agent.sre.v1.TriageFailureCategory) TriageFailureCategory classifies why a triage attempt failed. The frontend can use this to render appropriate user-facing messages and actions.

Name	Number	Description
TRIAGE_FAILURE_CATEGORY_UNSPECIFIED	0	Default value, should not be used
TRIAGE_FAILURE_CATEGORY_BUDGET_EXCEEDED	1	Daily AI budget limit reached, triage will resume automatically the next day
TRIAGE_FAILURE_CATEGORY_CONTEXT_TOO_LARGE	2	Issue context is too large for the AI agent to process
TRIAGE_FAILURE_CATEGORY_MAX_ITERATIONS	3	AI agent couldn’t reach a conclusion within the allowed number of steps
TRIAGE_FAILURE_CATEGORY_INVALID_AGENT_OUTPUT	4	AI agent produced an invalid or unparseable response
TRIAGE_FAILURE_CATEGORY_CONNECTIVITY	5	Temporary connectivity issue to upstream services
TRIAGE_FAILURE_CATEGORY_RESOURCE_NOT_FOUND	6	Referenced resource (e.g. monitor) no longer exists
TRIAGE_FAILURE_CATEGORY_INTERNAL	7	An unexpected internal error occurred

DatacheckStatus

(synq.datachecks.v1.DatacheckStatus) Result of a datacheck execution

Name	Number	Description
DATACHECK_STATUS_UNSPECIFIED	0	none
DATACHECK_STATUS_PASSED	1	Check passed successfully.
DATACHECK_STATUS_FAILED	2	Check failed due to violations.
DATACHECK_STATUS_ERROR	3	Check failed due to error in check itself.
DATACHECK_STATUS_SKIPPED	4	Check was skipped (e.g. not applicable)

Severity

(synq.datachecks.sqltests.v1.Severity)

Name	Number	Description
SEVERITY_UNSPECIFIED	0	none
SEVERITY_WARNING	1	none
SEVERITY_ERROR	2	none
SEVERITY_INFO	3	none

DeploymentRuleType

(synq.monitors.automated_monitors.v1.DeploymentRuleType) DeploymentRuleType identifies which kind of selection a deployment rule uses. The value corresponds to the populated config oneof arm on MonitorsDeploymentRule / MonitorsDeploymentRuleView. Use it with ListDeploymentRulesRequest.rule_types to return only rules of selected kinds.

Name	Number	Description
DEPLOYMENT_RULE_TYPE_UNSPECIFIED	0	No filter — when used in a request, rules of any type are returned.
DEPLOYMENT_RULE_TYPE_QUERY	1	Rule with `query_config`: selects entities by a ResolverQL query and deploys monitors on the matches.
DEPLOYMENT_RULE_TYPE_EXCLUSIVE_QUERY	2	Rule with `exclusive_query_config`: a ResolverQL query whose matches are exclusively owned (monitors outside the match set are removed).
DEPLOYMENT_RULE_TYPE_STATIC_PATH	3	Rule with `static_config`: targets a single fixed entity path.
DEPLOYMENT_RULE_TYPE_EXCLUSIVE_STATIC_PATH	4	Rule with `exclusive_static_config`: a single fixed path, exclusively owned.
DEPLOYMENT_RULE_TYPE_PRODUCT	5	Rule with `product_config`: deploys monitors across a data product’s entities per its upstream/self selection strategy.

MetricId

(synq.monitors.automated_monitors.v1.MetricId)

Name	Number	Description
METRIC_ID_UNSPECIFIED	0	none
METRIC_ID_ROW_COUNT	1	none
METRIC_ID_DELAY	2	none
METRIC_ID_VOLUME_CHANGE_DELAY	3	none

Sensitivity

(synq.monitors.automated_monitors.v1.Sensitivity)

Name	Number	Description
SENSITIVITY_UNSPECIFIED	0	none
SENSITIVITY_PRECISE	1	none
SENSITIVITY_BALANCED	2	none
SENSITIVITY_RELAXED	3	none

Severity

(synq.monitors.automated_monitors.v1.Severity)

Name	Number	Description
SEVERITY_UNSPECIFIED	0	none
SEVERITY_WARNING	1	none
SEVERITY_ERROR	2	none
SEVERITY_INFO	3	none

MonitorDefinition.Source

(synq.monitors.custom_monitors.v1.MonitorDefinition.Source)

Name	Number	Description
SOURCE_APP	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_API	1	none

Sensitivity

(synq.monitors.custom_monitors.v1.Sensitivity)

Name	Number	Description
SENSITIVITY_UNSPECIFIED	0	none
SENSITIVITY_PRECISE	1	none
SENSITIVITY_BALANCED	2	none
SENSITIVITY_RELAXED	3	none

Severity

(synq.monitors.custom_monitors.v1.Severity)

Name	Number	Description
SEVERITY_UNSPECIFIED	0	none
SEVERITY_WARNING	1	none
SEVERITY_ERROR	2	none
SEVERITY_INFO	3	none

LineageDirection

(synq.entities.lineage.v1.LineageDirection) Direction of the lineage to query.

Name	Number	Description
LINEAGE_DIRECTION_UNSPECIFIED	0	none
LINEAGE_DIRECTION_UPSTREAM	1	none
LINEAGE_DIRECTION_DOWNSTREAM	2	none
LINEAGE_DIRECTION_UPSTREAM_DOWNSTREAM	3	none

CllState

(synq.entities.lineage.v1.CllState)

Name	Number	Description
CLL_STATE_UNSPECIFIED	0	Unspecified state.
CLL_STATE_PARSE_FAILED	1	Parsing of the asset SQL failed. No upstream dependencies can be found.
CLL_STATE_EXTRACTION_FAILED	2	Extraction of the asset SQL failed. Some unsupported SQL features may be used. Some details might be missing.
CLL_STATE_RESOLUTION_FAILED	3	Not all columns or tables were found upstream, lineage is not complete.
CLL_STATE_OK	10	No known issues present.

NodePosition

(synq.entities.lineage.v1.NodePosition)

Name	Number	Description
NODE_POSITION_UNSPECIFIED	0	none
NODE_POSITION_START_NODE	1	Node is one of the requested start point.
NODE_POSITION_UPSTREAM	2	Node is upstream of the requested start point.
NODE_POSITION_DOWNSTREAM	3	Node is downstream of the requested start point.

IssueStatus

(synq.entities.status.v1.IssueStatus)

Name	Number	Description
ISSUE_STATUS_UNSPECIFIED	0	none
ISSUE_STATUS_OK	10	none
ISSUE_STATUS_WARN	20	none
ISSUE_STATUS_ERROR	30	none
ISSUE_STATUS_CRITICAL	40	none

CodeType

(synq.entities.v1.CodeType) CodeType enum represents different types of code that can be processed in the Coalesce Quality platform

Name	Number	Description
CODE_TYPE_UNSPECIFIED	0	none
CODE_TYPE_SQL	1	SQL code (e.g., SELECT, INSERT, UPDATE statements)
CODE_TYPE_PYTHON	2	Python code (e.g., scripts, functions, classes)
CODE_TYPE_JSON	3	JSON data or configuration files
CODE_TYPE_YAML	4	YAML configuration or data files
CODE_TYPE_DBT	5	dbt (data build tool) models and configurations
CODE_TYPE_SQLMESH	6	SQLMesh models and configurations. In most cases this will be similar to SQL code.
CODE_TYPE_LOOKML	7	LookML (Looker Modeling Language) files

SqlDialect

(synq.entities.v1.SqlDialect)

Name	Number	Description
SQL_DIALECT_UNSPECIFIED	0	none
SQL_DIALECT_BIGQUERY	1	none
SQL_DIALECT_CLICKHOUSE	2	none
SQL_DIALECT_DATABRICKS	3	none
SQL_DIALECT_MYSQL	4	none
SQL_DIALECT_POSTGRESQL	5	none
SQL_DIALECT_REDSHIFT	6	none
SQL_DIALECT_SNOWFLAKE	7	none
SQL_DIALECT_DUCKDB	8	none
SQL_DIALECT_TRINO	9	none
SQL_DIALECT_MSSQL	10	none
SQL_DIALECT_ORACLE	11	none
SQL_DIALECT_ATHENA	12	none
SQL_DIALECT_FABRIC	13	none

EntityType

(synq.entities.v1.EntityType)

Name	Number	Description
ENTITY_TYPE_UNSPECIFIED	0	none
ENTITY_TYPE_BQ_TABLE	103	none
ENTITY_TYPE_BQ_VIEW	105	none
ENTITY_TYPE_LOOKER_LOOK	201	none
ENTITY_TYPE_LOOKER_EXPLORE	203	none
ENTITY_TYPE_LOOKER_VIEW	207	none
ENTITY_TYPE_LOOKER_DASHBOARD	208	none
ENTITY_TYPE_DBT_MODEL	301	none
ENTITY_TYPE_DBT_TEST	302	none
ENTITY_TYPE_DBT_SOURCE	303	none
ENTITY_TYPE_DBT_PROJECT	306	none
ENTITY_TYPE_DBT_METRIC	307	none
ENTITY_TYPE_DBT_SNAPSHOT	310	none
ENTITY_TYPE_DBT_SEED	311	none
ENTITY_TYPE_DBT_ANALYSIS	312	none
ENTITY_TYPE_DBT_EXPOSURE	313	none
ENTITY_TYPE_DBT_GROUP	314	none
ENTITY_TYPE_DBT_SEMANTIC_MODEL	315	none
ENTITY_TYPE_DBT_CLOUD_PROJECT	352	none
ENTITY_TYPE_DBT_CLOUD_JOB	353	none
ENTITY_TYPE_SNOWFLAKE_TABLE	503	none
ENTITY_TYPE_SNOWFLAKE_VIEW	508	none
ENTITY_TYPE_SNOWFLAKE_STREAM	509	none
ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE	510	none
ENTITY_TYPE_SNOWFLAKE_TASK	511	none
ENTITY_TYPE_SNOWFLAKE_EXTERNAL_TABLE	512	none
ENTITY_TYPE_SNOWFLAKE_MATERIALIZED_VIEW	513	none
ENTITY_TYPE_SNOWFLAKE_PROCEDURE	514	none
ENTITY_TYPE_SNOWFLAKE_FUNCTION	515	none
ENTITY_TYPE_SNOWFLAKE_SEMANTIC_VIEW	516	none
ENTITY_TYPE_REDSHIFT_TABLE	803	none
ENTITY_TYPE_REDSHIFT_VIEW	805	none
ENTITY_TYPE_REDSHIFT_PROCEDURE	806	none
ENTITY_TYPE_REDSHIFT_FUNCTION	807	none
ENTITY_TYPE_TABLEAU_EMBEDDED	1101	none
ENTITY_TYPE_TABLEAU_PUBLISHED	1102	none
ENTITY_TYPE_TABLEAU_CUSTOM_SQL	1103	none
ENTITY_TYPE_TABLEAU_TABLE	1104	none
ENTITY_TYPE_TABLEAU_SHEET	1105	none
ENTITY_TYPE_TABLEAU_DASHBOARD	1106	none
ENTITY_TYPE_AIRFLOW_DAG	1201	none
ENTITY_TYPE_AIRFLOW_TASK	1202	none
ENTITY_TYPE_CLICKHOUSE_TABLE	1303	none
ENTITY_TYPE_CLICKHOUSE_VIEW	1305	none
ENTITY_TYPE_ANOMALY_MONITOR	1403	none
ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT	1404	none
ENTITY_TYPE_SQLTEST_TEST	1421	none
ENTITY_TYPE_RECON_SUITE	1431	none
ENTITY_TYPE_RECON_CASE	1432	none
ENTITY_TYPE_POSTGRES_TABLE	1603	none
ENTITY_TYPE_POSTGRES_VIEW	1605	none
ENTITY_TYPE_MYSQL_TABLE	1703	none
ENTITY_TYPE_MYSQL_VIEW	1705	none
ENTITY_TYPE_DATABRICKS_WAREHOUSE	1801	none
ENTITY_TYPE_DATABRICKS_TABLE	1804	none
ENTITY_TYPE_DATABRICKS_VIEW	1805	none
ENTITY_TYPE_DATABRICKS_JOB	1807	none
ENTITY_TYPE_DATABRICKS_JOB_TASK	1808	none
ENTITY_TYPE_DATABRICKS_NOTEBOOK	1809	none
ENTITY_TYPE_DATABRICKS_QUERY	1810	none
ENTITY_TYPE_DATABRICKS_DASHBOARD	1811	none
ENTITY_TYPE_SQLMESH_PROJECT	1901	none
ENTITY_TYPE_SQLMESH_SQL_MODEL	1902	none
ENTITY_TYPE_SQLMESH_PYTHON_MODEL	1903	none
ENTITY_TYPE_SQLMESH_EXTERNAL	1904	none
ENTITY_TYPE_SQLMESH_SEED	1905	none
ENTITY_TYPE_SQLMESH_AUDIT	1906	none
ENTITY_TYPE_SQLMESH_UNIT_TEST	1907	none
ENTITY_TYPE_SQLMESH_ENVIRONMENT	1908	none
ENTITY_TYPE_SQLMESH_SNAPSHOT	1909	none
ENTITY_TYPE_DUCKDB_TABLE	2003	none
ENTITY_TYPE_DUCKDB_VIEW	2005	none
ENTITY_TYPE_TRINO_TABLE	2104	none
ENTITY_TYPE_TRINO_VIEW	2105	none
ENTITY_TYPE_ATLAN_ASSET	2201	none
ENTITY_TYPE_ATLAN_INTEGRATION	2202	none
ENTITY_TYPE_COALESCE_PROJECT	2301	none
ENTITY_TYPE_COALESCE_ENVIRONMENT	2302	none
ENTITY_TYPE_COALESCE_NODE	2303	none
ENTITY_TYPE_COALESCE_NODE_TEST	2304	none
ENTITY_TYPE_COALESCE_JOB	2305	none
ENTITY_TYPE_CASTORDOC_TABLE	2404	none
ENTITY_TYPE_CASTORDOC_DASHBOARD	2405	none
ENTITY_TYPE_CASTORDOC_VIEW	2406	none
ENTITY_TYPE_CASTORDOC_TILE	2407	none
ENTITY_TYPE_CASTORDOC_VIZ_MODEL	2408	none
ENTITY_TYPE_POWERBI_REPORT	3001	none
ENTITY_TYPE_POWERBI_TILE	3002	none
ENTITY_TYPE_POWERBI_DATASET	3003	none
ENTITY_TYPE_POWERBI_DASHBOARD	3004	none
ENTITY_TYPE_POWERBI_TENANT	3005	none
ENTITY_TYPE_THOUGHTSPOT_LIVEBOARD	3101	none
ENTITY_TYPE_THOUGHTSPOT_WORKSHEET	3102	none
ENTITY_TYPE_SIGMA_WORKBOOK	3201	none
ENTITY_TYPE_SIGMA_DATA_MODEL	3202	none
ENTITY_TYPE_DOMO_PAGE	3301	none
ENTITY_TYPE_DOMO_DATASET	3302	none
ENTITY_TYPE_MSSQL_TABLE	3403	none
ENTITY_TYPE_MSSQL_VIEW	3405	none
ENTITY_TYPE_ORACLE_TABLE	3503	none
ENTITY_TYPE_ORACLE_VIEW	3505	none
ENTITY_TYPE_ATHENA_TABLE	3604	none
ENTITY_TYPE_ATHENA_VIEW	3605	none
ENTITY_TYPE_FABRIC_TABLE	3704	none
ENTITY_TYPE_FABRIC_VIEW	3705	none
ENTITY_TYPE_CUSTOM_ENTITY_GENERIC	50000	none
ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN	50001	none
ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX	59999	none

EntityChangeType

(synq.entities.v1.EntityChangeType)

Name	Number	Description
ENTITY_CHANGE_TYPE_UNSPECIFIED	0	none
ENTITY_CHANGE_TYPE_GIT_COMMIT	1	none
ENTITY_CHANGE_TYPE_SQL_DEFINITION_CHANGE	2	none
ENTITY_CHANGE_TYPE_SCHEMA_CHANGE	3	none

TableConstraintType

(synq.entities.v1.TableConstraintType) TableConstraintType represents the type of a database table constraint or index.

Name	Number	Description
TABLE_CONSTRAINT_TYPE_UNSPECIFIED	0	none
TABLE_CONSTRAINT_TYPE_PRIMARY_KEY	1	none
TABLE_CONSTRAINT_TYPE_FOREIGN_KEY	2	none
TABLE_CONSTRAINT_TYPE_UNIQUE	3	none
TABLE_CONSTRAINT_TYPE_CHECK	4	none
TABLE_CONSTRAINT_TYPE_INDEX	5	none
TABLE_CONSTRAINT_TYPE_SORTING_KEY	6	DWH-specific constraint/ordering types
TABLE_CONSTRAINT_TYPE_PARTITION_BY	7	none
TABLE_CONSTRAINT_TYPE_CLUSTER_BY	8	none
TABLE_CONSTRAINT_TYPE_DISTRIBUTION_KEY	9	none
TABLE_CONSTRAINT_TYPE_PROJECTION	10	none

SqlConstruct

(synq.entities.v1.SqlConstruct) SqlConstruct enumerates the SQL features detected in an entity’s query. Multiple values can be set on a single statement (e.g. a query with both a CTE and an INNER JOIN carries HAS_CTE, HAS_ANY_JOIN and INNER_JOIN).

Name	Number	Description
SQL_CONSTRUCT_UNSPECIFIED	0	none
SQL_CONSTRUCT_HAS_ANY_JOIN	1	Aggregate flag: the query contains at least one join of any kind. Always emitted alongside the specific JOIN variant for that join.
SQL_CONSTRUCT_HAS_ANY_SET_OPERATION	2	Aggregate flag: the query contains at least one UNION / INTERSECT / EXCEPT at any nesting level. Always emitted alongside the specific SET variant.
SQL_CONSTRUCT_HAS_GROUP_BY	3	The query has a GROUP BY (including GROUP BY ALL).
SQL_CONSTRUCT_HAS_CTE	4	The query has a WITH clause (CTEs, recursive or not).
SQL_CONSTRUCT_SET_UNION	10	UNION / UNION ALL set operation. Emitted alongside HAS_ANY_SET_OPERATION.
SQL_CONSTRUCT_SET_INTERSECT	11	INTERSECT set operation. Emitted alongside HAS_ANY_SET_OPERATION.
SQL_CONSTRUCT_SET_EXCEPT	12	EXCEPT / MINUS set operation. Emitted alongside HAS_ANY_SET_OPERATION.
SQL_CONSTRUCT_INNER_JOIN	20	INNER JOIN. Also emitted for an unqualified `JOIN`, which defaults to INNER. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_CROSS_APPLY_JOIN	21	T-SQL `CROSS APPLY`. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_OUTER_APPLY_JOIN	22	T-SQL `OUTER APPLY`. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_ARRAY_JOIN	23	ClickHouse `ARRAY JOIN` / `LEFT ARRAY JOIN`. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_CROSS_JOIN	24	Explicit CROSS JOIN (cartesian product). Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_LEFT_SEMI_JOIN	25	LEFT SEMI JOIN. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_RIGHT_SEMI_JOIN	26	RIGHT SEMI JOIN. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_LEFT_ANTI_JOIN	27	LEFT ANTI JOIN. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_RIGHT_ANTI_JOIN	28	RIGHT ANTI JOIN. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_LEFT_OUTER_JOIN	29	LEFT [OUTER] JOIN. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_RIGHT_OUTER_JOIN	30	RIGHT [OUTER] JOIN. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_FULL_OUTER_JOIN	31	FULL [OUTER] JOIN. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_ASOF_JOIN	32	Snowflake / Databricks `ASOF JOIN`. Emitted alongside HAS_ANY_JOIN.
SQL_CONSTRUCT_READS_SEMANTIC_VIEW	33	Query reads a Snowflake semantic view via the `SEMANTIC_VIEW(...)` table-valued function. One occurrence is recorded per semantic-view reference. The companion CREATE SEMANTIC VIEW DDL is classified separately, not via this construct.
SQL_CONSTRUCT_HAS_AGGREGATE_FUNCTION	34	The query invokes at least one aggregate function (SUM, COUNT, AVG, …) used as a grouping aggregate. A windowed aggregate (`SUM(x) OVER (...)`) does NOT set this flag — it sets HAS_WINDOW_FUNCTION instead, because it produces one row per input row rather than collapsing groups. Aggregate names are recognised per-dialect, including user-defined aggregates.
SQL_CONSTRUCT_HAS_WINDOW_FUNCTION	35	The query invokes at least one window function — any function call carrying an `OVER (...)` clause, whether the base is an aggregate (`SUM(x) OVER (...)`) or a dedicated window function (`ROW_NUMBER() OVER (...)`). The window-ness is the `OVER` clause, not the base name.
SQL_CONSTRUCT_UNSUPPORTED_SQL_SYNTAX	100	Set when the SQL could not be parsed. Lets unparseable entities be filtered without inspecting the underlying parse error.

ExecutionType

(synq.entities.v1.ExecutionType)

Name	Number	Description
EXECUTION_TYPE_UNSPECIFIED	0	none
EXECUTION_TYPE_DELETION	1	none
EXECUTION_TYPE_SCHEMA_CHANGE	2	none
EXECUTION_TYPE_SQL_DEFINITION_CHANGE	3	none
EXECUTION_TYPE_BQ_QUERY_JOB	101	none
EXECUTION_TYPE_BQ_LOAD_JOB	102	none
EXECUTION_TYPE_BQ_COPY_JOB	103	none
EXECUTION_TYPE_BQ_EXTRACT_JOB	104	none
EXECUTION_TYPE_BQ_QUERY_LOG	105	none
EXECUTION_TYPE_LOOKER_USAGE_REPORT	201	none
EXECUTION_TYPE_DBT_INVOCATION	301	none
EXECUTION_TYPE_DBT_NODE_INVOCATION	302	none
EXECUTION_TYPE_DBT_NODE_FRESHNESS	303	none
EXECUTION_TYPE_DBT_CATALOG_REFRESH	304	none
EXECUTION_TYPE_DBT_CLOUD_JOB_RUN	351	none
EXECUTION_TYPE_DBT_CLOUD_JOB_RUN_STEP	352	none
EXECUTION_TYPE_DATABOX_FRESHNESS	401	none
EXECUTION_TYPE_GIT_COMMIT	501	none
EXECUTION_TYPE_CLICKHOUSE_QUERY_LOG	601	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG	701	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_SELECT	702	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_DROP	703	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_CREATE	704	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_CREATE_TABLE	705	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_INSERT	706	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_MERGE	707	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_UPDATE	708	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_CREATE_TABLE_AS_SELECT	709	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_DELETE	710	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_SHOW	711	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_CREATE_VIEW	712	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_MULTI_STATEMENT	713	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_ROLLBACK	714	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_TRUNCATE_TABLE	715	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_COMMIT	716	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_BEGIN_TRANSACTION	717	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_UNKNOWN	718	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_SET	719	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_RENAME_TABLE	720	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_GRANT	721	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_ALTER_TABLE_ADD_COLUMN	722	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_USE	723	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_COPY	724	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_CALL	725	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_ALTER_TABLE_DROP_COLUMN	726	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_ALTER_TABLE_MODIFY_COLUMN	727	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_RENAME_COLUMN	728	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_DROP_ROLE	729	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_DESCRIBE_QUERY	730	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_CREATE_CONSTRAINT	731	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_EXPLAIN	732	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_CREATE_ROLE	733	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_ALTER	734	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_DESCRIBE	735	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_PUT_FILES	736	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_GET_FILES	737	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_ALTER_SESSION	738	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_LIST_FILES	739	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_EXTERNAL_TABLE_REFRESH	740	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_REFRESH_DYNAMIC_TABLE_AT_REFRESH_VERSION	741	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_REMOVE_FILES	742	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_EXECUTE_TASK	743	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_ALTER_TABLE	744	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_EXECUTE_STREAMLIT	745	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_CREATE_TASK	746	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_UNLOAD	747	none
EXECUTION_TYPE_SNOWFLAKE_QUERY_LOG_DROP_TASK	748	none
EXECUTION_TYPE_SNOWFLAKE_TASK_EXECUTION	790	none
EXECUTION_TYPE_SNOWFLAKE_TASK_GROUP_EXECUTION	791	none
EXECUTION_TYPE_REDSHIFT_QUERY_LOG	801	none
EXECUTION_TYPE_DATAHUB_DATA_PROCESS_INSTANCE	901	none
EXECUTION_TYPE_DATAHUB_USAGE_REPORT	902	none
EXECUTION_TYPE_SYNQ_CUSTOM_ENTITY_EXECUTION	1001	none
EXECUTION_TYPE_SYNQ_CUSTOM_ENTITY_LOG	1002	none
EXECUTION_TYPE_SYNQ_CUSTOM_ENTITY_MEASUREMENT	1003	none
EXECUTION_TYPE_TABLEAU_USAGE_REPORT	1101	none
EXECUTION_TYPE_TABLEAU_EXTRACT	1102	none
EXECUTION_TYPE_AIRFLOW_DAG	1201	none
EXECUTION_TYPE_AIRFLOW_TASK	1202	none
EXECUTION_TYPE_ANOMALY_INTEGRATION_RUN	1402	none
EXECUTION_TYPE_ANOMALY_MONITOR_RUN	1403	none
EXECUTION_TYPE_ANOMALY_MONITOR_CORRECTION	1404	none
EXECUTION_TYPE_ANOMALY_MONITOR_SEGMENT_RUN	1405	none
EXECUTION_TYPE_ANOMALY_MONITOR_SEGMENT_CORRECTION	1406	none
EXECUTION_TYPE_ANOMALY_MONITOR_FETCH_RUN	1407	none
EXECUTION_TYPE_SQL_TEST_RUN	1421	none
EXECUTION_TYPE_DATABRICKS_QUERY_LOG	1501	none
EXECUTION_TYPE_DATABRICKS_JOB_RUN	1502	none
EXECUTION_TYPE_DATABRICKS_JOB_TASK_RUN	1503	none
EXECUTION_TYPE_SQLMESH_PROJECT_EXECUTION	1601	none
EXECUTION_TYPE_SQLMESH_MODEL_EVALUATION	1602	none
EXECUTION_TYPE_SQLMESH_AUDIT_CHECK	1603	none
EXECUTION_TYPE_TRINO_QUERY_LOG	2101	none
EXECUTION_TYPE_COALESCE_ENVIRONMENT_RUN	2301	none
EXECUTION_TYPE_COALESCE_DEPLOY_RUN	2302	none
EXECUTION_TYPE_COALESCE_REFRESH_RUN	2303	none
EXECUTION_TYPE_COALESCE_NODE_RUN	2304	none
EXECUTION_TYPE_COALESCE_SQL_TEST_RUN	2305	none
EXECUTION_TYPE_MSSQL_QUERY_LOG	2401	none
EXECUTION_TYPE_ORACLE_QUERY_LOG	2501	none
EXECUTION_TYPE_RECON_SUITE_RUN	2601	none
EXECUTION_TYPE_RECON_CASE_RUN	2602	none
EXECUTION_TYPE_RECON_DEPLOYMENT	2603	none
EXECUTION_TYPE_FABRIC_QUERY_LOG	2701	none

PropagationFilter

(synq.entities.checks.v1.PropagationFilter) PropagationFilter controls which types of checks are included in the coverage response.

Name	Number	Description
PROPAGATION_FILTER_UNSPECIFIED	0	PROPAGATION_FILTER_UNSPECIFIED - Default behavior: returns both direct and propagated checks
PROPAGATION_FILTER_DIRECT_ONLY	1	PROPAGATION_FILTER_DIRECT_ONLY - Returns only direct checks, skips lineage resolution and propagation
PROPAGATION_FILTER_PROPAGATED_ONLY	2	PROPAGATION_FILTER_PROPAGATED_ONLY - Returns only propagated checks from upstream entities, direct checks arrays will be empty but still present

ExecutionStatus

(synq.entities.custom.v1.ExecutionStatus)

Name	Number	Description
EXECUTION_STATUS_UNSPECIFIED	0	none
EXECUTION_STATUS_OK	1	none
EXECUTION_STATUS_WARN	2	none
EXECUTION_STATUS_ERROR	3	none
EXECUTION_STATUS_CRITICAL	4	none

ExecutionStatus

(synq.entities.executions.v2.ExecutionStatus) ExecutionStatus represents the outcome of an execution.

Name	Number	Description
EXECUTION_STATUS_UNSPECIFIED	0	none
EXECUTION_STATUS_OK	1	none
EXECUTION_STATUS_WARN	2	none
EXECUTION_STATUS_ERROR	3	none
EXECUTION_STATUS_CRITICAL	4	none

ExecutionStatus

(synq.entities.executions.v1.ExecutionStatus)

Name	Number	Description
EXECUTION_STATUS_UNSPECIFIED	0	none
EXECUTION_STATUS_OK	1	none
EXECUTION_STATUS_WARN	2	none
EXECUTION_STATUS_ERROR	3	none
EXECUTION_STATUS_CRITICAL	4	none

LineageObjectDomain

(synq.ingest.dwh.v1.LineageObjectDomain) LineageObjectDomain classifies what KIND of warehouse object sits at one end of a lineage edge. It lets the platform tell real table-to-table lineage apart from edges that touch warehouse-internal or non-tabular objects (load stages, streams, semantic views, …), which are rendered differently (or hidden) in the lineage graph. The values mirror the object domains a warehouse’s native lineage feature reports (for example the domains returned by Snowflake’s GET_LINEAGE) plus the common equivalents on other warehouses. Set UNSPECIFIED when the producer cannot determine the domain — the edge is still stored, just without the table-vs-builtin distinction.

Name	Number	Description
LINEAGE_OBJECT_DOMAIN_UNSPECIFIED	0	none
LINEAGE_OBJECT_DOMAIN_TABLE	1	An ordinary table.
LINEAGE_OBJECT_DOMAIN_VIEW	2	A non-materialized view.
LINEAGE_OBJECT_DOMAIN_MATERIALIZED_VIEW	3	A materialized view.
LINEAGE_OBJECT_DOMAIN_EXTERNAL_TABLE	4	A table backed by external storage (external/iceberg table, etc.).
LINEAGE_OBJECT_DOMAIN_DYNAMIC_TABLE	5	A table refreshed by the warehouse from a query (Snowflake dynamic table, BigQuery materialized view with auto-refresh, …).
LINEAGE_OBJECT_DOMAIN_STREAM	6	A change-data-capture object over a table (Snowflake stream, …).
LINEAGE_OBJECT_DOMAIN_STAGE	7	A load/unload staging area — warehouse-internal, not a customer table.
LINEAGE_OBJECT_DOMAIN_SEMANTIC_VIEW	8	A semantic/metrics layer object (Snowflake semantic view, …).
LINEAGE_OBJECT_DOMAIN_DATASET	9	A dataset/grouping object exposed by the warehouse’s lineage feature.
LINEAGE_OBJECT_DOMAIN_MODULE	10	A module/package object exposed by the warehouse’s lineage feature.
LINEAGE_OBJECT_DOMAIN_OTHER	99	A recognised object that does not fit any category above.

LineageSource

(synq.ingest.dwh.v1.LineageSource) LineageSource records HOW the lineage was derived. The platform uses it both to set the precedence of the resulting edges and to keep lineage of different origins from silently overwriting one another: declared lineage is additive to observed lineage, it never replaces it. Pick the single value that best describes the whole batch.

Name	Number	Description
LINEAGE_SOURCE_UNSPECIFIED	0	none
LINEAGE_SOURCE_DWH_NATIVE	1	Read from the warehouse’s own lineage feature (for example Snowflake SNOWFLAKE.CORE.GET_LINEAGE). Authoritative, highest fidelity.
LINEAGE_SOURCE_QUERY_HISTORY	2	Derived by parsing query history / access history.
LINEAGE_SOURCE_DECLARED	3	Declared by the customer or a modelling tool (dbt refs, hand-authored edges, BI relationships) rather than observed in the warehouse.
LINEAGE_SOURCE_VIEW_DEFINITION	4	Derived from a view or materialization definition.

SqlObfuscationMode

(synq.ingest.dwh.v1.SqlObfuscationMode) SqlObfuscationMode represents the level of SQL obfuscation applied to query logs. This is critical for on-premise deployments where customers want to prevent sensitive data in SQL queries from being sent to Coalesce Quality backend.

Name	Number	Description
SQL_OBFUSCATION_MODE_NONE	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX No obfuscation was applied
SQL_OBFUSCATION_MODE_REDACT_LITERALS	1	String and numeric literals were replaced with placeholders while preserving query structure for SQL parsing

LineageReplaceMode

(synq.ingest.dwh.v1.LineageReplaceMode) LineageReplaceMode controls how an ingested batch interacts with lineage that was ingested earlier, and therefore when previously-ingested edges become outdated and stop contributing to dependencies.

Name	Number	Description
LINEAGE_REPLACE_MODE_UNSPECIFIED	0	Treated as MERGE so a producer that forgets to set the mode can only add or refresh edges, never silently expire them.
LINEAGE_REPLACE_MODE_MERGE	1	MERGE: upsert the lineage of every downstream object present in this batch and leave every other object untouched. Use for incremental refreshes — a single query’s lineage, one schema the customer just rebuilt, etc. Nothing is expired; an edge disappears only when the same downstream object is re-ingested without it.
LINEAGE_REPLACE_MODE_REPLACE_SCOPE	2	REPLACE_SCOPE: treat this batch as the authoritative, complete snapshot of all lineage whose downstream object falls inside `scope`. Any previously- ingested edge whose downstream object is inside the scope but absent from this batch becomes outdated and is excluded from dependencies. Use for full periodic refreshes. `scope` MUST be set.

Domain.Source

(synq.domains.v1.Domain.Source)

Name	Number	Description
SOURCE_SYNQ	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_ATLAN	1	none

GrantRole

(synq.savedviews.v1.GrantRole) The access level a grant confers on its grantee.

Name	Number	Description
GRANT_ROLE_UNSPECIFIED	0	Unspecified is treated as VIEW.
GRANT_ROLE_VIEW	1	The grantee can see the view.
GRANT_ROLE_MANAGE	2	The grantee can also edit the view and change its sharing/grants.

SavedViewConfig.Layout

(synq.savedviews.v1.SavedViewConfig.Layout) Layout used to render the view’s results.

Name	Number	Description
LAYOUT_UNSPECIFIED	0	none
LAYOUT_LIST	1	none
LAYOUT_CARDS	2	none
LAYOUT_TABLE	3	none

SavedViewContext

(synq.savedviews.v1.SavedViewContext) The surface a saved view applies to. A view saved on the catalog/assets screen is not shown on the checks or issues screens, so listing is normally filtered by the context the caller is rendering.

Name	Number	Description
SAVED_VIEW_CONTEXT_UNSPECIFIED	0	Catalog / assets — the default surface.
SAVED_VIEW_CONTEXT_CHECKS	1	Checks / monitors screen.
SAVED_VIEW_CONTEXT_ISSUES	2	Issues / incidents screen.

SavedViewRelationship

(synq.savedviews.v1.SavedViewRelationship) How a returned saved view relates to the calling user. Output-only: computed per request from the view’s owner, visibility and grants against the caller’s identity. Clients group their “views” UI by this value.

Name	Number	Description
SAVED_VIEW_RELATIONSHIP_UNSPECIFIED	0	none
SAVED_VIEW_RELATIONSHIP_MINE	1	The caller owns the view.
SAVED_VIEW_RELATIONSHIP_WORKSPACE	2	Owned by the workspace itself (e.g. created by a workspace-level token), visible to everyone.
SAVED_VIEW_RELATIONSHIP_SHARED_TO_WORKSPACE	3	Another user’s view that they shared with the whole workspace.
SAVED_VIEW_RELATIONSHIP_SHARED_TO_ME	4	Another user’s view that was explicitly granted to the caller.

SavedViewVisibility

(synq.savedviews.v1.SavedViewVisibility) Who can see a saved view. This is the absolute sharing state stored on the view; how it relates to the calling user is reported separately as a SavedViewRelationship on each returned view.

Name	Number	Description
SAVED_VIEW_VISIBILITY_UNSPECIFIED	0	Private — only the owner can see it.
SAVED_VIEW_VISIBILITY_SHARED	1	Shared with the whole workspace — everyone in the workspace can see it.
SAVED_VIEW_VISIBILITY_GRANTED	2	Granted — the owner plus the users explicitly listed in the view’s grants.

Dataproduct.Priority

(synq.dataproducts.v2.Dataproduct.Priority) Priority. P1 is the highest.

Name	Number	Description
PRIORITY_UNSPECIFIED	0	none
PRIORITY_P3	3	none
PRIORITY_P2	4	none
PRIORITY_P1	5	none

Dataproduct.Source

(synq.dataproducts.v2.Dataproduct.Source) Where this data product is managed. Products from an external source (e.g. Atlan) are read-only in the app.

Name	Number	Description
SOURCE_SYNQ	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_ATLAN	1	none

Dataproduct.Priority

(synq.dataproducts.v1.Dataproduct.Priority)

Name	Number	Description
PRIORITY_UNSPECIFIED	0	none
PRIORITY_P3	3	none
PRIORITY_P2	4	none
PRIORITY_P1	5	none

Dataproduct.Source

(synq.dataproducts.v1.Dataproduct.Source)

Name	Number	Description
SOURCE_SYNQ	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_ATLAN	1	none

ListIncidentsRequest.Field

(synq.incidents.v1.ListIncidentsRequest.Field)

Name	Number	Description
FIELD_UNSPECIFIED	0	none
FIELD_CREATED_AT	1	none
FIELD_UPDATED_AT	2	none

ListIncidentsRequest.Sort.Order

(synq.incidents.v1.ListIncidentsRequest.Sort.Order)

Name	Number	Description
ORDER_UNSPECIFIED	0	none
ORDER_ASC	1	none
ORDER_DESC	2	none

Incident.State

(synq.incidents.v1.Incident.State)

Name	Number	Description
STATE_UNSPECIFIED	0	none
STATE_OPEN	1	none
STATE_CLOSED	2	none
STATE_CANCELLED	3	none

RecordEvidence Examples

​Services

​ScheduleService

​PreviewSchedules

​PlatformsService

​SetPlatformAuthentication

​CommitsService

​GetDiffByChangeId

​GetDiffByCommit

​OwnersService

​UpsertOwner

​BatchGetOwners

​ListOwners

​DeleteOwner

​UpsertOwnership

​ListOwnerships

​BatchGetOwnerships

​DeleteOwnership

​NLQueryService

​GenerateQuery

​IntegrationsService

​CreateIntegration

​GetIntegration

​ListIntegrations

​BatchGetIntegrations

​UpdateIntegration

​DeleteIntegration

​EnableIntegration

​DisableIntegration

​RefreshIntegration

​GetIntegrationHealth

​IamService

​Iam

​AtlanProviderService

​GetAtlanConnections

​GetAtlanDataProducts

​GetAtlanDomains

​AtlanWorkflowService

​SetConnectionMappings

​RemoveConnectionMappings

​GetConnectionMappings

​GetProductMappings

​GetDomainMappings

​Synchronize

​FetchRuns

​SetMappingToggles

​GetMappingToggles

​AtlanIntegrationService

​Upsert

​Ping

​Get

​Remove

​Activate

​IssuesService

​BatchGetIssues

​ListIssues

​MarkInvestigating

​MarkFixed

​MarkExpected

​MarkNoActionNeeded

​ClearStatus

​PostComment

​IssuesService

​BatchGetIssues

​ListIssues

​MarkInvestigating

​MarkFixed

​MarkExpected

​MarkNoActionNeeded

​PostComment

​AlertsService

​Create

​List

​BatchGet

​Update

​Delete

​ToggleEnabled

​ConnectionsService

​ListConnections

​GenerateConnectionsYaml

​DwhAgentService

Services

ScheduleService

PreviewSchedules

PlatformsService

SetPlatformAuthentication

CommitsService

GetDiffByChangeId

GetDiffByCommit

OwnersService

UpsertOwner

BatchGetOwners

ListOwners

DeleteOwner

UpsertOwnership

ListOwnerships

BatchGetOwnerships

DeleteOwnership

NLQueryService

GenerateQuery

IntegrationsService

CreateIntegration

GetIntegration

ListIntegrations

BatchGetIntegrations

UpdateIntegration

DeleteIntegration

EnableIntegration

DisableIntegration

RefreshIntegration

GetIntegrationHealth

IamService

Iam

AtlanProviderService

GetAtlanConnections

GetAtlanDataProducts

GetAtlanDomains

AtlanWorkflowService

SetConnectionMappings

RemoveConnectionMappings

GetConnectionMappings

GetProductMappings

GetDomainMappings

Synchronize

FetchRuns

SetMappingToggles

GetMappingToggles

AtlanIntegrationService

Upsert

Ping

Get

Remove

Activate

IssuesService

BatchGetIssues

ListIssues

MarkInvestigating

MarkFixed

MarkExpected

MarkNoActionNeeded

ClearStatus

PostComment

IssuesService

BatchGetIssues

ListIssues

MarkInvestigating

MarkFixed

MarkExpected

MarkNoActionNeeded

PostComment

AlertsService

Create

List

BatchGet

Update

Delete

ToggleEnabled

ConnectionsService

ListConnections

GenerateConnectionsYaml

DwhAgentService