Services

DeliveriesService

(synq.deliveries.v1.DeliveriesService) DeliveriesService reports what was sent to your notification integrations — webhooks, PagerDuty, Opsgenie — and what came back. It answers the three questions an integration owner has. “Did this event reach my endpoint”: list the deliveries for an event id and read the outcome of each. “Why did my endpoint reject it”: read the attempts, which carry the request as it was sent and the response as it came back. “Why did I get nothing at all”: every delivery that sent nothing records a reason, so a silent integration can be explained rather than guessed at. Deliveries are kept for 90 days. Credential-bearing header values are never returned, on either side of an attempt — see Header.

ListDeliveries

ListDeliveries (ListDeliveriesRequest) ListDeliveriesResponse List deliveries, newest event first. With no integration_id this is the whole workspace’s feed; with one it is that integration’s.

BatchGetDeliveries

BatchGetDeliveries (BatchGetDeliveriesRequest) BatchGetDeliveriesResponse Fetch deliveries by id. Ids that do not exist, or have passed out of the retention window, are omitted from the response rather than causing an error. Unlike ListDeliveries, this always returns the routing provenance.

GetDelivery

GetDelivery (GetDeliveryRequest) GetDeliveryResponse Fetch a single delivery by id. BatchGetDeliveries does the same for many at once and is the variant exposed over REST.

ListAttempts

ListAttempts (ListAttemptsRequest) ListAttemptsResponse List every attempt made for one delivery, oldest first. A delivery is attempted at most ten times, so the result is small and is not paginated.

SummariseDeliveries

SummariseDeliveries (SummariseDeliveriesRequest) SummariseDeliveriesResponse Count deliveries over a window, bucketed by outcome, by skip reason and by HTTP status class. Use it to watch your own delivery failure rate without paging through the feed.

Redeliver

Redeliver (RedeliverRequest) RedeliverResponse Send an earlier delivery again, to the same integration, with the same event. The replay is a new delivery with its own id, linked to the original through redelivery_of, and appears in ListDeliveries like any other. It is signed with the integration’s current secret rather than the one the original used, which makes it the way to confirm that a rotated secret is accepted by the receiver. Retrying this call sends the delivery again. Rate-limited per integration; over the limit it fails with RESOURCE_EXHAUSTED rather than queueing.

SendTestDelivery

SendTestDelivery (SendTestDeliveryRequest) SendTestDeliveryResponse Send a test delivery to an integration, to confirm the endpoint is reachable and that it accepts what is sent. It is always sent, whatever event types the integration subscribes to — a test that silently matches nothing would report the same as a broken endpoint. Returns the id of the delivery it created. The send is asynchronous: poll BatchGetDeliveries with that id until the outcome leaves OUTCOME_PENDING. Retrying this call sends another test. Rate-limited per integration; over the limit it fails with RESOURCE_EXHAUSTED rather than queueing.

SqlMeshService

(synq.ingest.sqlmesh.v1.SqlMeshService)

IngestMetadata

IngestMetadata (IngestMetadataRequest) IngestMetadataResponse

IngestExecution

IngestExecution (IngestExecutionRequest) IngestExecutionResponse

CloudwatchService

(synq.ingest.cloudwatch.v1.CloudwatchService)

IngestCloudwatchLogsData

IngestCloudwatchLogsData (IngestCloudwatchLogsDataRequest) IngestCloudwatchLogsDataResponse

DwhService

(synq.ingest.dwh.v1.DwhService)

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

DbtService

(synq.ingest.dbt.v1.DbtService)

IngestInvocation

IngestInvocation (IngestInvocationRequest) IngestInvocationResponse

AirflowLogsService

(synq.ingest.airflow.v1.AirflowLogsService)

IngestLog

IngestLog (IngestLogRequest) IngestLogResponse

IngestDatahubAspects

IngestDatahubAspects (IngestDatahubAspectsRequest) IngestDatahubAspectsResponse

AlertsService

(synq.alerts.services.v1.AlertsService) AlertsService provides operations for managing alert configurations. Deprecated: use synq.alerts.services.v2.AlertsService. The v2 service selects entities with the canonical synq.queries.v1.Query + resolver_ql trigger; this v1 service, which uses the bespoke EntityGroupQuery selection, is scheduled for removal. Migrate existing integrations to v2.

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.

AlertsService

(synq.alerts.services.v2.AlertsService) AlertsService provides operations for managing alert configurations. It supersedes synq.alerts.services.v1.AlertsService: entities are selected with the canonical synq.queries.v1.Query + resolver_ql trigger rather than the bespoke EntityGroupQuery.

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.

Rename

Rename (RenameRequest) RenameResponse Rename an existing alert configuration. The config can be identified by either ID or FQN.

UpdateTargets

UpdateTargets (UpdateTargetsRequest) UpdateTargetsResponse Replace the delivery targets of an existing alert configuration. The config can be identified by either ID or FQN.

UpdateSettings

UpdateSettings (UpdateSettingsRequest) UpdateSettingsResponse Update the trigger and/or the kind-specific settings of an alert. The config can be identified by either ID or FQN.

UpdateTemplate

UpdateTemplate (UpdateTemplateRequest) UpdateTemplateResponse Set or clear the message template of 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.

ToggleIncidentOwnerAlert

ToggleIncidentOwnerAlert (ToggleIncidentOwnerAlertRequest) ToggleIncidentOwnerAlertResponse Turns the workspace’s incident-owner alert on or off. This alert notifies each incident’s owner on its configured channels and has no other configuration, so it is managed here rather than through Create / Delete and does not appear in List or BatchGet.

SendTestAlert

SendTestAlert (SendTestAlertRequest) SendTestAlertResponse Delivers a static test message to the given targets so you can confirm that delivery reaches each channel before relying on a real alert. Nothing is stored and the targets need not belong to a saved alert, so this can be called while an alert is still being authored.

FoldersService

(synq.entities.folders.v1.FoldersService) FoldersService discovers and browses the folder / containment hierarchy of the catalog: the roots data hangs from, the sub-folders under any folder, the folders a given entity lives in, and the entities contained in a folder. It is a read / navigation surface, not folder management — there are no create, move, or delete operations. Addressing: every folder has an opaque folder_entity_id (round-trip it verbatim) and a structured FolderRef{root_entity_id, folders[]} (the human-friendly form). Entities — both folder members and the ids you pass to GetFolderOf — are named by their opaque entity id, the same id used across the rest of the entities API. Depth footgun: membership is SHALLOW by default. Browse returns only the direct children of a folder, and ListMembers returns only the entities placed directly in the folder. Set deep = true (or raise Browse.depth) to recurse into sub-folders.

Browse

Browse (BrowseRequest) BrowseResponse Browse the hierarchy one level at a time. With no parent, returns the roots (top-level integrations / containers). With a parent folder, returns that folder’s direct sub-folders and the entity ids of its direct, non-folder members. One level per call — sub-folders are returned as Folders (each with a child_folder_count), which you Browse into in turn; there is no nested tree in the response. filter narrows the returned members to entities matching a query.

GetFolderOf

GetFolderOf (GetFolderOfRequest) GetFolderOfResponse Given entity ids, return the folder breadcrumb(s) each entity lives in — ordered root first, leaf (immediate parent) last. An entity may appear in more than one hierarchy; the response carries every folder along its containing chain. Compose with ListMembers on an entity’s immediate parent to list its siblings.

ListMembers

ListMembers (ListMembersRequest) ListMembersResponse List the entity ids contained in a folder, paginated. Direct members only by default; set deep = true to include members of all nested sub-folders. Narrow with types and/or filter. Pagination is a stable client-side window over the folder’s fully-resolved member set: each page recomputes and re-orders that set, then returns the requested slice. Results are consistent, but paging deep through a very large folder repeats work — prefer a larger page_size over many small pages.

TypeDefsService

(synq.entities.typedefs.v1.TypeDefsService) TypeDefsService tells you what the type values in every other endpoint mean. Responses across the API describe things by enum — an entity is an ENTITY_TYPE_BQ_TABLE, it belongs to DATA_PLATFORM_TYPE_BIGQUERY, a run is an EXECUTION_TYPE_DBT_INVOCATION. This service turns each of those into a name you can display and a set of facts you can act on: is this a transformation model, does it live in a warehouse, can it be monitored. Read it instead of keeping your own copy of the list. New entity types and new platforms are added as Coalesce Quality supports more tools, and a hard-coded table in your code will label them with whatever its fallback produces and miss that an existing type gained a capability. Everything here comes from the server, so you pick both up without changing your code. A typical integration calls them once at startup, keeps them in a map, and looks types up as responses arrive. It also tells you what a selection query can ask for: ListEntityTraitDefs is the vocabulary behind traits, which selects entities by what they are rather than by naming every type. Scoping and freshness:

ListEntityTypeDefs is per workspace, because the types you defined yourself are part of your workspace’s vocabulary. It returns the built-in types and your own custom types together.
ListPlatformDefs, ListExecutionTypeDefs and ListEntityTraitDefs are the same for everyone.
The built-in half changes only when Coalesce Quality is upgraded, so caching it for the life of your process is fine. You can add or edit your own custom types at any time, so if a newly created type needs to appear promptly, cache the entity types for minutes rather than hours, or re-read after you change one.

The workspace comes from your credentials; there is nothing to pass. Each list is small — hundreds of entries — so every call returns the whole set and none of them page.

ListEntityTypeDefs

ListEntityTypeDefs (ListEntityTypeDefsRequest) ListEntityTypeDefsResponse List every kind of entity in your workspace, the built-in types and your own. The built-in half covers every value of synq.entities.v1.EntityType this server serves, so this is also how you discover a type that your generated code is too old to name. Your own types have no enum value of their own — each one is identified by its type_id.

ListPlatformDefs

ListPlatformDefs (ListPlatformDefsRequest) ListPlatformDefsResponse List every platform Coalesce Quality connects to, with its display name. Use it to name the platform on an entity — “BigQuery”, “Microsoft SQL Server” — rather than deriving a name from the enum value.

ListEntityTraitDefs

ListEntityTraitDefs (ListEntityTraitDefsRequest) ListEntityTraitDefsResponse List every trait a selection query can filter entities by. Read it before writing a selection that uses traits, and to show a person what one covers. A trait name this list does not contain selects nothing, so reading the list is how you tell a trait that does not exist from one your client is too old to know about.

ListExecutionTypeDefs

ListExecutionTypeDefs (ListExecutionTypeDefsRequest) ListExecutionTypeDefsResponse List every kind of run Coalesce Quality records against an entity. A dbt invocation, a warehouse query job, a detected schema change. Use it to name the execution_type that execution and run endpoints return.

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.

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

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.

ChecksCategorisationRulesService

(synq.entities.checks.v2.ChecksCategorisationRulesService) ChecksCategorisationRulesService manages the rules that categorise a workspace’s checks automatically. A rule says “checks matching this predicate get this category on this dimension”. Rules are the scalable way to categorise: they apply to checks that already exist and to every check ingested afterwards, so a new dbt package or a new warehouse does not mean a fresh round of manual tagging. A rule-computed category is the lowest-precedence source — a category set explicitly on a check through ChecksCategoriesService, and one the producing tool declared, both win over it. A typical loop is: ListCategorisationFilters to see what the workspace’s checks look like, PreviewRule to check the reach of a candidate, UpsertRule to save it, then GetRecategorisationStatus to confirm the existing checks have caught up. Every workspace starts with a set of platform-provided rules covering the common cases. They are visible here, they can be superseded by a workspace rule of any priority, and they cannot be edited from a workspace.

UpsertRule

UpsertRule (UpsertRuleRequest) UpsertRuleResponse Create or update a categorisation rule. The rule id is supplied by the caller (a UUID), which makes this operation idempotent — repeating the same request converges to the same rule rather than creating a duplicate. On create, dimension, title, category and matcher are required. On update, a field that is set is written and a field that is omitted is left unchanged. To guard against overwriting a concurrent edit, pass the etag you last read. Saving a rule schedules a sweep that recategorises the workspace’s existing checks. It normally completes in seconds; GetRecategorisationStatus confirms it.

DeleteRule

DeleteRule (DeleteRuleRequest) DeleteRuleResponse Delete a categorisation rule. Checks the rule categorised fall back to the next rule that matches them, or become uncategorised. Idempotent — deleting an already-deleted or unknown rule succeeds. Pass etag to guard against deleting a concurrently-edited rule.

ListRules

ListRules (ListRulesRequest) ListRulesResponse List the rules that apply to the caller’s workspace — its own rules plus the platform-provided ones — in the order they are tried. Narrow with dimension and scope.

BatchGetRules

BatchGetRules (BatchGetRulesRequest) BatchGetRulesResponse Read specific rules by id — typically to resolve the rule_id a ResolvedCategory carries into the rule that produced it. Ids the caller cannot see, or that do not exist, are omitted from the response rather than causing an error.

PreviewRule

PreviewRule (PreviewRuleRequest) PreviewRuleResponse Report what a candidate rule would change, without saving it. The candidate is slotted into the workspace’s live rule set — replacing an existing rule when id names one — and the whole resolution is run over every check, so scope, priority, explicit categories and producer-declared categories are all honoured. The response separates the candidate’s raw reach from its real effect, which are rarely the same number. Preview a rule before saving it: one that matches broadly can recategorise a large part of a workspace in a single sweep.

ListRuleMatches

ListRuleMatches (ListRuleMatchesRequest) ListRuleMatchesResponse Report how many checks each rule currently categorises, with a sample of them — the state already applied, not a projection. Use it to show “categorises N checks” next to each rule, and to spot a rule that has stopped matching anything. For the full, paginated list of one rule’s checks, call ChecksCategoriesService.ListCheckCategories with the rule id.

GetRecategorisationStatus

GetRecategorisationStatus (GetRecategorisationStatusRequest) GetRecategorisationStatusResponse Progress of the re-categorisation sweep a rule change schedules. The sweep normally completes in seconds, so this is how to confirm that the workspace’s existing checks have caught up with the new rules — not something a client has to wait on.

ChecksCategoriesService

(synq.entities.checks.v2.ChecksCategoriesService) ChecksCategoriesService reads and edits the categories of the checks in a workspace. Categorising checks is what turns a long list of tests into a picture of data quality: it lets you ask how much of a data product is covered for completeness, or which freshness checks exist across three warehouses that each name the same idea differently. Every check resolves to at most one category per dimension:

technical — what kind of check this is, mechanically (“nullness”, “uniqueness”, “freshness”);
governance — what the check is for, in data-quality terms (“Completeness”, “Accuracy”, “Timeliness”).

The two are independent, and each resolves from three sources, in descending precedence: a category set explicitly on the check through this service, a category the producing tool declared, and a category one of the workspace’s categorisation rules computed. Rules are managed by ChecksCategorisationRulesService and are the right tool for anything that generalises; set a category explicitly only for the checks that are genuine exceptions. The workspace and the acting identity always come from the request credentials, never from the payload.

UpsertCheckCategories

UpsertCheckCategories (UpsertCheckCategoriesRequest) UpsertCheckCategoriesResponse Set the category of one or more checks explicitly. An explicit category is authoritative for its check: it overrides both the producer-declared category and anything the categorisation rules compute, and it survives every later rule change. Each dimension updates independently. A field that is omitted leaves that dimension as it is; a field set to the empty string clears the explicit category on that dimension, so the check falls back to its producer-declared or rule-computed value. Repeating the same request converges to the same state rather than accumulating changes.

DeleteCheckCategories

DeleteCheckCategories (DeleteCheckCategoriesRequest) DeleteCheckCategoriesResponse Clear the explicit categories of one or more checks, on both dimensions. Each check falls back to its producer-declared or rule-computed category. Idempotent — clearing a check that has no explicit category succeeds.

ListCheckCategories

ListCheckCategories (ListCheckCategoriesRequest) ListCheckCategoriesResponse List the workspace’s checks with their resolved categories. Returns every check by default; the filters combine, so one call answers questions like “which dbt tests still have no governance category” or “which checks did this rule categorise”.

BatchGetCheckCategories

BatchGetCheckCategories (BatchGetCheckCategoriesRequest) BatchGetCheckCategoriesResponse Read the categories of specific checks. Ids that do not exist are omitted from the response rather than causing an error, so a partially-stale list of ids still returns what it can. ListCategories (ListCategoriesRequest) ListCategoriesResponse List the workspace’s category vocabulary: the category names in use on each dimension, whether a workspace or platform rule produces each one, and how many checks carry it. Use it to populate a category picker so a workspace converges on one spelling per concept, and to see how much of the workspace is still uncategorised.

ListCategorisationFilters

ListCategorisationFilters (ListCategorisationFiltersRequest) ListCategorisationFiltersResponse List the attribute values the workspace’s checks actually have — the platforms, entity types, packages and kinds available to build a categorisation rule or a listing filter from. Pass selected to narrow each list to values that co-occur with the current selection, so a rule editor never offers a combination that matches nothing. A list never constrains itself: choosing one platform still leaves every other platform selectable.

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.

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.

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.

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 by how many entities” 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. Every count is a number of entities, not a number of occurrences: an entity whose SQL contains five GROUP BY clauses adds one to the HAS_GROUP_BY count, not five. The result is workspace-scoped (derived from the 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. Every requested path appears in the response, including a path with no SQL details and a path matching no entity; both are returned with an empty set of constructs.

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).

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.

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.

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.

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.

BatchGetEntityAnnotations

BatchGetEntityAnnotations (BatchGetEntityAnnotationsRequest) BatchGetEntityAnnotationsResponse Read the annotations carried by specific entities. ListAnnotations answers what the workspace annotates by and how often; this answers what one entity carries. They are separate reads because an entity’s annotations are not part of the entity: synq.entities.v1.Entity is the shape synq.entities.custom.v1.UpsertEntity accepts, so the annotations field on it is what a producer ASSERTS about an entity, and answering a read with it would make a read-edit-write round trip write one entity’s annotations onto another.

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

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

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.

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.

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.

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. The response reports what each requested relationship did to the stored graph, and under which pair of entities it was stored. Read it: a relationship whose endpoints resolve to a pair another relationship in the same batch also resolves to is one edge, and only the last write to it survives.

DeleteRelationships

DeleteRelationships (DeleteRelationshipsRequest) DeleteRelationshipsResponse Delete relationships between entities. If the relationship does not exist, it will be ignored. The response says which of them actually removed something, so a caller reconciling a set of edges can tell a withdrawal from a no-op.

ListRelationships

ListRelationships (ListRelationshipsRequest) ListRelationshipsResponse List relationships touching the given entities, or every relationship in the workspace when ids is left empty.

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. The response reports what each requested relationship did, and under which (check, checked) pair of entities it was stored.

DeleteCheckRelationships

DeleteCheckRelationships (DeleteCheckRelationshipsRequest) DeleteCheckRelationshipsResponse Delete relationships between checks and the entities they validate. Relationships that do not exist are ignored. The response says which of them actually removed something.

ListCheckRelationships

ListCheckRelationships (ListCheckRelationshipsRequest) ListCheckRelationshipsResponse List every relationship that attaches a check to the entities it validates, across the whole workspace.

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 the features of one entity, or of every custom entity in the workspace when entity_id is left unset.

ImpactService

(synq.entities.impact.v1.ImpactService)

GetImpact

GetImpact (GetImpactRequest) GetImpactResponse

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

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.

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.

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.

OverlaysService

(synq.overlays.v1.OverlaysService) OverlaysService answers which organizational overlays claim an entity. An overlay is a grouping you lay over your catalog rather than something the warehouse itself knows about. Two kinds exist today: a data product, which groups the assets that make up something your organization delivers, and an owner, which names the person or team responsible for a set of assets and where alerts about them go. Each is defined by a membership rule, not by an explicit list, so what belongs to one changes as your warehouse does. “Owner” here means stewardship — who is accountable for an asset and who hears about it when something breaks. It is not the structural containment sense the word carries elsewhere in the API, where an asset can be said to own the checks and monitors declared on it. Nothing this service returns describes that relationship. This service reads that membership backwards. The defining services answer “what is in this data product”; this one answers “which data products and owners claim this table” — the question you have when you are looking at one asset and want to know who cares about it and what it feeds. Membership follows identity. Where the same table is represented more than once in your catalog — a transformation model and the warehouse table it builds — an overlay whose rule matches one of them claims the others too. So an alert routed by ownership reaches the responsible party whichever representation raised it, and you do not have to know which one a rule was written against. Two consequences worth planning around. You can ask about whichever representation you happen to hold and get the same answer, so there is no need to resolve an identity group first. And if you do ask about several members of one group in a single call, each comes back with its own entry carrying the same overlays — correct, but redundant, so ask about one member per group when you are near the request limit. Related services:

synq.dataproducts.v2.DataproductsService and synq.owners.v1.OwnersService define the overlays read here, and turn an id from a response into a name, a description and its contact channels.
synq.entities.resolve.v1.IdentifierResolveService turns an identifier you already hold — a warehouse table name, a dbt model — into the entity_id these calls take.

BatchGetEntityOverlays

BatchGetEntityOverlays (BatchGetEntityOverlaysRequest) BatchGetEntityOverlaysResponse For each entity, list every overlay that claims it. The response has one entry per requested id, in the order you asked, so you can match results positionally and never have to tell “absent” from “empty”. An entity that belongs to no overlay comes back with empty lists. Freshness. Which overlays exist and what they are attached to is up to date the moment you change it — create an overlay, delete one, point an ownership at a different data product, and the next call reflects it. What each overlay contains is recomputed periodically, so an asset that newly satisfies an existing rule — a table appearing in a folder a rule watches — shows up shortly afterwards rather than instantly. Returns PERMISSION_DENIED if your credential can read neither data products nor owners. If it can read one but not the other, the call succeeds and the list you may not read comes back empty rather than failing.

BatchGetOverlayMemberCounts

BatchGetOverlayMemberCounts (BatchGetOverlayMemberCountsRequest) BatchGetOverlayMemberCountsResponse Count the members of each named overlay. The cheap way to answer “how big is this” — use it for a summary line or a badge. When you need the assets themselves, list them through the service that defines the overlay. Counts distinct members, so an owner responsible for two data products that overlap is not charged twice for the assets they share. Same freshness as BatchGetEntityOverlays: counts follow the periodic recomputation of what each overlay contains. Returns PERMISSION_DENIED if your credential can read neither data products nor owners.

ListEntityCoverage

ListEntityCoverage (ListEntityCoverageRequest) ListEntityCoverageResponse List the candidate assets together with the overlays claiming each, and narrow them to what is or is not covered. This is the question behind a governance audit: of the assets you care about, which belong to no data product, and which have nobody responsible for them. You give the candidate set as a query — every asset, one platform, one folder, one domain — and each row comes back carrying the same owner and data-product lists BatchGetEntityOverlays returns, so a single call is both the count and the worklist. total_count is how many candidates match filter across every page, so you can say “312 of 4,190 tables are in no data product” without paging to the end. Freshness. By default this reads the same periodically recomputed membership the rest of this service reads, and tells you how old it is in members_computed_at. Ask for FRESHNESS_LIVE when the answer has to reflect every definition as of now — it re-resolves them, which is far slower and far more expensive, so keep it for a one-off audit rather than a page that refreshes. Returns PERMISSION_DENIED if your credential can read neither data products nor owners, and also if filter names a kind it may not read: an empty list must not be the answer to both “nothing is uncovered” and “you may not look”. A kind you may not read still comes back as an empty list on each row, as it does elsewhere in this service. Returns INVALID_ARGUMENT if the selection resolves to more assets than one call will report on — see CoverageSelection for the limit and for how to choose a candidate set worth reading.

GetCoverageSummary

GetCoverageSummary (GetCoverageSummaryRequest) GetCoverageSummaryResponse Count coverage over one or more named candidate sets, without listing the assets themselves. The aggregate behind a coverage dashboard. Each selection you send comes back as one row of totals, keyed by the label you gave it, so a breakdown by type, platform, folder or domain is one round trip rather than one call per bucket. There is no server-side grouping, on purpose. This service knows what claims an asset, not what kind of thing the asset is, so naming the selections yourself — with_type("dbt_model"), in_folder(...), in_domain(...) — keeps the buckets in your own vocabulary and costs the same. Selections are counted independently and may overlap. An asset in two of them is counted in both. Returns PERMISSION_DENIED unless your credential can read both data products and owners. Every row names both, and a zero that was never looked at is indistinguishable from a zero that was.

HistoryService

(synq.monitors.history.v1.HistoryService)

History

History (HistoryRequest) HistoryResponse

MonitorInfoService

(synq.monitors.info.v1.MonitorInfoService)

MonitorInfo

MonitorInfo (MonitorInfoRequest) MonitorInfoResponse

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).

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

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

MonitorSegmentsService

(synq.monitors.segments.v1.MonitorSegmentsService) Reads and names the segments of a segmented custom monitor. A monitor configured with a segmentation expression splits the data it monitors into one time series per distinct value of that expression, and each of those is a segment. The label is what every downstream surface shows for a segment: the name of the check it produces, the search result, the alert. A segment with no label falls back to its raw value, so a monitor segmented on something encoded (an id, a code, a hashed bucket) reads as that raw value everywhere until the segment is named.

ListMonitorSegments

ListMonitorSegments (ListMonitorSegmentsRequest) ListMonitorSegmentsResponse Lists the segments a monitor has ingested so far, with their raw value and current label. A segment appears only once data has been observed for it, so a monitor that has not run yet lists none.

BatchUpdateMonitorSegmentLabels

BatchUpdateMonitorSegmentLabels (BatchUpdateMonitorSegmentLabelsRequest) BatchUpdateMonitorSegmentLabelsResponse Sets or clears the label of one or more segments. Segments are addressed by the id ListMonitorSegments returns. A segment id encodes a sanitised form of the segment value, so it cannot be constructed from that value: read the ids first, then write against them.

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.

QueriesService

(synq.queries.v1.QueriesService) QueriesService compiles and evaluates ResolverQL — the compact text query language used across Coalesce Quality to select entities — over the public API. ResolverQL is a string DSL (for example with_type("TABLE") or in_folder(...)); a structured synq.queries.v1.Query is its parsed, machine-readable form. This service is the bridge between the two and the read-only execution surface for both:

TranslateResolverQl compiles a ResolverQL expression into a structured Query without evaluating it — inspect it, validate it, or reuse it as a filter on another API (entity listing, folder browsing, …).
ResolveQuery compiles a ResolverQL expression (or takes an already-structured Query), evaluates it against the catalog, and returns the matched entity ids. This is the general author -> resolve loop.
DescribeResolverQl returns the language itself — every function, every accepted enum value — so you author against what this deployment compiles rather than against a table baked into your client.

All three authenticate and resolve your workspace from your credentials. DescribeResolverQl additionally needs no permission of its own, so any credential can read it; the other two read the catalog and are scoped.

DescribeResolverQl

DescribeResolverQl (DescribeResolverQlRequest) DescribeResolverQlResponse Describe the ResolverQL this deployment accepts: every function with its arguments and documentation, the category order to group them by, and the accepted values of every enum-typed argument. Read it before authoring a selection, and validate against it rather than against a copy compiled into your client. The language gains functions and accepted values as Coalesce Quality supports more, and a client working from its own table both misses what was added and refuses a query this server would compile. Nothing is passed, and no permission is needed beyond being authenticated — so a client holding a narrow credential, one that may write a deployment rule but cannot read entities, can still find out how to write the selection it is being asked for. Read it as an answer for your workspace, not as a constant. Most of it is the same for everyone, but the entity types you defined yourself are part of the language too: today they are reachable only through ResolverQlEnumDomain.pattern, which is why that field exists, and named by synq.entities.typedefs.v1.TypeDefsService.ListEntityTypeDefs. Caching it for the life of your process is fine; re-read it after you add or rename an entity type of your own.

TranslateResolverQl

TranslateResolverQl (TranslateResolverQlRequest) TranslateResolverQlResponse Compile a ResolverQL expression into a structured public Query. Unlike ResolveQuery, it does not evaluate the query against the catalog. A syntactically invalid or uncompilable expression fails with INVALID_ARGUMENT.

ResolveQuery

ResolveQuery (ResolveQueryRequest) ResolveQueryResponse Evaluate a selection and return the matched entity ids, paginated. Pass a ResolverQL expression via resolver_ql (it is compiled server-side) or an already-structured query. Invalid ResolverQL fails with INVALID_ARGUMENT.

TriggerService

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

TriggerDatachecks

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

SqlTestsDeploymentRulesService

(synq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService) SqlTestsDeploymentRulesService manages SqlTestDeploymentRules — rules that dynamically deploy SQL test templates onto every table or view a query matches, resyncing over time as the match set changes.

GetSqlTestDeployOverview

GetSqlTestDeployOverview (GetSqlTestDeployOverviewRequest) GetSqlTestDeployOverviewResponse Preview the effect of deploying a rule (which have not yet been saved), without deploying it.

GetSqlTestDeployDeleteOverview

GetSqlTestDeployDeleteOverview (GetSqlTestDeployDeleteOverviewRequest) GetSqlTestDeployDeleteOverviewResponse Preview the effect of deleting a rule, without deleting it.

ListSqlTestDeploymentRules

ListSqlTestDeploymentRules (ListSqlTestDeploymentRulesRequest) ListSqlTestDeploymentRulesResponse

BatchGetSqlTestDeploymentRules

BatchGetSqlTestDeploymentRules (BatchGetSqlTestDeploymentRulesRequest) BatchGetSqlTestDeploymentRulesResponse

DeploySqlTestDeploymentRule

DeploySqlTestDeploymentRule (DeploySqlTestDeploymentRuleRequest) DeploySqlTestDeploymentRuleResponse Deploy (create or update) a SqlTestDeploymentRule and immediately sync tests onto its current match set.

BatchDeploySqlTestDeploymentRules

BatchDeploySqlTestDeploymentRules (BatchDeploySqlTestDeploymentRulesRequest) BatchDeploySqlTestDeploymentRulesResponse

DeleteSqlTestDeploymentRule

DeleteSqlTestDeploymentRule (DeleteSqlTestDeploymentRuleRequest) DeleteSqlTestDeploymentRuleResponse

BatchDeleteSqlTestDeploymentRules

BatchDeleteSqlTestDeploymentRules (BatchDeleteSqlTestDeploymentRulesRequest) BatchDeleteSqlTestDeploymentRulesResponse

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.

TestSuggestionsService

(synq.datachecks.testsuggestions.v1.TestSuggestionsService)

BatchCreateTestSuggestions

BatchCreateTestSuggestions (BatchCreateTestSuggestionsRequest) BatchCreateTestSuggestionsResponse

BatchGetTestSuggestionsForEntities

BatchGetTestSuggestionsForEntities (BatchGetTestSuggestionsForEntitiesRequest) BatchGetTestSuggestionsForEntitiesResponse

BatchAcceptTestSuggestions

BatchAcceptTestSuggestions (BatchAcceptTestSuggestionsRequest) BatchAcceptTestSuggestionsResponse

BatchRejectTestSuggestions

BatchRejectTestSuggestions (BatchRejectTestSuggestionsRequest) BatchRejectTestSuggestionsResponse

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).

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.

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.

DeleteComment

DeleteComment (DeleteCommentRequest) DeleteCommentResponse Delete a comment on an issue. Only the actor who posted the comment may delete it. Deleting an already-deleted comment succeeds.

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.

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.

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.

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.

DwhAgentService

(synq.agent.dwh.v1.DwhAgentService)

Connect

Connect (ConnectRequest) ConnectResponse buf:lint:ignore RPC_NO_CLIENT_STREAMING

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

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.

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

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.

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. Reporting a locally executed run is part of running one, so the scope that authorises editing and running suites also authorises reporting their results — a pipeline needs one credential, not two.

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.

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.

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 ReconciliationSuite.name). Validates the ReconciliationSuite 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.

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 ReconciliationSuite proto. Only the suite configuration fields are extracted (connections are ignored).

RenderYaml

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

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.

UpdateDeploymentCategories

UpdateDeploymentCategories (UpdateDeploymentCategoriesRequest) UpdateDeploymentCategoriesResponse Change the categories declared for a deployment’s reconciliation checks without re-promoting the suite snapshot. Each field is patched independently: omitting one leaves it as it was, sending an empty string clears it, and sending a value sets or replaces it — so changing the governance category can never disturb the technical one. The new categories reach the published checks immediately; a re-promote is not needed for them to take effect.

UpdateDeploymentCaseImpacts

UpdateDeploymentCaseImpacts (UpdateDeploymentCaseImpactsRequest) UpdateDeploymentCaseImpactsResponse Patch the per-case ReconciliationFailureImpact 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 RECONCILIATION_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).

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.

IamService

(synq.auth.iam.v1.IamService)

Iam

Iam (IamRequest) IamResponse Iam returns information about caller authentication

PlatformsService

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

SetPlatformAuthentication

SetPlatformAuthentication (SetPlatformAuthenticationRequest) SetPlatformAuthenticationResponse

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.

DeleteComment

DeleteComment (DeleteCommentRequest) DeleteCommentResponse Delete a comment on an incident. Only the actor who posted the comment may delete it. Deleting an already-deleted comment succeeds.

CommitsService

(synq.git.commits.v1.CommitsService)

GetDiffByChangeId

GetDiffByChangeId (GetDiffByChangeIdRequest) GetDiffByChangeIdResponse

GetDiffByCommit

GetDiffByCommit (GetDiffByCommitRequest) GetDiffByCommitResponse

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 Report how many domains the workspace uses, split into top-level and sub-domains.

DomainsService

(synq.domains.v2.DomainsService) DomainsService manages data domains — named areas of ownership that group the assets, data products and sub-domains belonging to one part of the business. 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 domain may contain other domains and data products, so membership resolution is recursive. Every write that adds such a reference — including a change of parent_id — is rejected if it would close a loop, so a definition can always be resolved in finite time.

Upsert

Upsert (UpsertRequest) UpsertResponse Create or update a domain. The id is supplied by the caller (a UUID); repeating the same request converges to the same domain. Mutable fields are optional: a set field is written, an omitted field is left unchanged. Pass etag to guard against overwriting a concurrent edit.

BatchGet

BatchGet (BatchGetRequest) BatchGetResponse Fetch multiple domains by id. Ids that do not exist (or, unless include_deleted is set, are deleted) are omitted from the response rather than causing an error.

List

List (ListRequest) ListResponse List the domains in the workspace, paginated. Narrow to one level of the hierarchy with parent_id.

FetchDomainWithSubDomains

FetchDomainWithSubDomains (FetchDomainWithSubDomainsRequest) FetchDomainWithSubDomainsResponse Fetch a domain together with its direct sub-domains, keyed by id.

Delete

Delete (DeleteRequest) DeleteResponse Delete a domain. Idempotent — deleting an already-deleted or unknown domain succeeds. Soft-deletes by default; set purge to hard-delete and release the id, which is refused while the domain still has sub-domains. Pass etag to guard against deleting a concurrently-edited domain.

SetDefinition

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

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 domain, resolved from its definition — including everything contributed by the data products and domains it references, and by its own sub-domains — and returned as opaque entity ids. Paginated.

GetUsage

GetUsage (GetUsageRequest) GetUsageResponse Report how many domains the workspace uses, split into top-level and sub-domains.

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.

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.

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

AtlanProviderService

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

GetAtlanConnections

GetAtlanConnections (GetAtlanConnectionsRequest) GetAtlanConnectionsResponse

GetAtlanDataProducts

GetAtlanDataProducts (GetAtlanDataProductsRequest) GetAtlanDataProductsResponse

GetAtlanDomains

GetAtlanDomains (GetAtlanDomainsRequest) GetAtlanDomainsResponse

Messages

Delivery

(synq.deliveries.v1.Delivery) Delivery is one event as it was addressed to one integration: what it was about, whether it went, and what happened when it did. One event reaches every integration subscribed to it, so an event that fans out to three integrations produces three deliveries. They share event_id and each has its own id.

Field	Type	Description
id	string	Opaque identifier of this delivery, composed by the service. Pass it back to `BatchGetDeliveries`, `ListAttempts` and `Redeliver`; do not parse it or build one yourself, as its composition can change.
event_id	string	Identifier of the event this delivery carries, shared by every integration the same event reached. Filter `ListDeliveries` on it to answer “which of my integrations did this event reach, and what did each of them do with it”. It is also the `event_id` in the webhook payload a receiver got, so a customer holding a received webhook can find its delivery from it.
integration_id	string	The integration this delivery was addressed to.
event_type	string	Name of the `synq.webhooks.v1.Event.EventType` the delivery carries — for example `EVENT_TYPE_ISSUE_CREATED`. Empty when the event has no representation for this kind of integration.
subject	DeliverySubject	What the event is about, so a delivery can be found from the issue or incident a question is asked about.
created_at	Timestamp	When the event happened. This is the event time, not the time it was sent — `last_attempt_at` is that. Deliveries are listed newest event first.
outcome	Outcome	What became of the delivery.
skip_reason	SkipReason	Why nothing was sent. Set exactly when `outcome` is `OUTCOME_SKIPPED` or `OUTCOME_NOT_ROUTED`.
attempt_count	int32	How many attempts have been made so far, across every request this delivery produced. Zero for a delivery that sent nothing, and for one still queued.
last_attempt_at	Timestamp	When the most recent attempt started. Unset until the first attempt.
next_attempt_at	Timestamp	When the next attempt is due. Set only while `outcome` is `OUTCOME_PENDING`; an attempt can still start slightly later than this under load.
duration	Duration	How long the attempts took in total. Useful as “how long did this take to land” rather than as a measure of one request.
status_code	int32	HTTP status of the most recent attempt. Zero when no response was received — either nothing has been sent yet, or the request failed before one arrived, in which case the attempt carries the transport error.
redelivery_of	string	The delivery this one replays, set when it was produced by `Redeliver`. Empty for a first delivery.
matched_alert_configs	repeated MatchedAlertConfig	Which alert configurations selected this integration for this event — the answer to “why did I get this”. More than one when several configurations match the same event, because their alerts are merged into a single delivery per integration. Empty for deliveries not produced by alerting, such as a test delivery.

Always populated by BatchGetDeliveries; populated by ListDeliveries only when the request sets include_routing. | | correlation_key | string | The key the destination deduplicates on — a PagerDuty dedup_key, an Opsgenie alias — so an incident in your own tool can be traced back to the delivery that opened it. Empty for destinations that create no such object. Populated on the same terms as matched_alert_configs. |

DeliverySubject

(synq.deliveries.v1.DeliverySubject) DeliverySubject is the object an event is about.

Field	Type	Description
type	SubjectType	Which kind of object `id` refers to.
id	string	Identifier of the issue or incident, as the rest of the API uses it. For a test delivery this is the event id, since a test is about nothing else.
title	string	Title at the time the delivery was decided, kept so a delivery stays readable after the issue is renamed or closed.
url	string	Link to the object in the app. Empty when the subject has no page.

MatchedAlertConfig

(synq.deliveries.v1.MatchedAlertConfig) MatchedAlertConfig names one alert configuration that selected an integration for an event.

Field	Type	Description
alert_config_id	string	Identifier of the alert configuration.
name	string	Its name when the delivery was decided, so the delivery stays attributable after the configuration is renamed or deleted.
fqn	string	Fully-qualified name, set only for configurations managed as code.
ownership_id	string	The ownership the configuration belongs to. Empty for workspace-level configurations.
owner_path	string	The owner the integration was reached through. Empty when the configuration names the integration directly rather than routing to an owner.

Attempt

(synq.deliveries.v1.Attempt) Attempt is one try at handing a delivery to its destination, recorded as it happened: what was sent, what came back, and how long it took. A delivery can produce more than one outgoing request — an integration that creates an object and then annotates it makes two — and each request is retried on its own. Attempts of the same request share request_id and count up in attempt.

Field	Type	Description
delivery_id	string	The delivery this attempt belongs to.
attempt	int32	Which try this was for `request_id`, starting at 1.
request_id	string	Opaque identifier of the outgoing request. Group attempts by it to follow one request’s retries; compare it to tell two requests of the same delivery apart.
attempted_at	Timestamp	When the attempt started.
duration	Duration	How long it took, whether it succeeded or failed.
error	string	Why the attempt never produced a response — a connection failure, a TLS error, a timeout. Empty when a response was received, however it read.
oneof transport.http	HttpAttempt	none

(synq.deliveries.v1.Header) Header is one HTTP header of an attempt. A header whose value carries a credential is never returned, on either the request or the response side. That covers headers you configured as secret, credentials held for the destination, and the standard credential-bearing names (Authorization, Proxy-Authorization, Cookie, Set-Cookie, X-Api-Key, X-Auth-Token) whatever their contents — a destination echoing its own authorization header back is withheld too. Signature headers are returned in full: X-Coalesce-Signature is a digest of the body and X-Coalesce-Timestamp is a timestamp, neither of which is the signing secret, and the exact bytes are what you need to reproduce a verification that failed.

Field	Type	Description
name	string	Header name, as sent.
value	string	Header value. Empty when `withheld` is set.
withheld	bool	Whether the value was withheld. The header itself is still reported, so the record shows which headers were present.
fingerprint	string	Short digest of a withheld value, stable for the same value. Enough to answer “is this the same token as the one that worked yesterday” by comparing two deliveries, without disclosing either value.
secret_version	string	Which version of the stored secret the withheld value was read from, so a delivery can be attributed to a specific secret across a rotation. Empty for values that come from no stored secret.

HttpAttempt

(synq.deliveries.v1.HttpAttempt) HttpAttempt is one HTTP request and the response it got. Credential-bearing headers are never returned, whichever side they appear on — see Header.

Field	Type	Description
method	string	Method used, upper-case.
url	string	Full URL the request was sent to, query string included.
request_headers	repeated Header	Headers as sent.
request_body	string	Body as sent. A value the destination requires to be secret — a routing key, for instance — is replaced by a marker naming the field it stood in, so the record shows that a value was sent rather than implying none was.
request_bytes	int32	Size of the body actually sent, in bytes, before any such substitution.
status_code	int32	HTTP status returned. Zero when no response arrived; `error` on the attempt then says why.
response_headers	repeated Header	Headers the destination returned.
response_body	string	Body the destination returned, cut short past a fixed size — see `response_truncated`.
response_bytes	int32	Size of the response body as the destination sent it, before truncation.
response_truncated	bool	Whether `response_body` was cut short. When set, `response_bytes` is the full size and `response_body` holds the leading bytes.

BatchGetDeliveriesRequest

(synq.deliveries.v1.BatchGetDeliveriesRequest)

Field	Type	Description
ids	repeated string	Delivery ids to fetch (1–200, unique), as returned by `ListDeliveries`, `Redeliver` or `SendTestDelivery`.

BatchGetDeliveriesResponse

(synq.deliveries.v1.BatchGetDeliveriesResponse)

Field	Type	Description
deliveries	map DeliveriesEntry	The deliveries found, keyed by id. Ids that do not exist are absent.

BatchGetDeliveriesResponse.DeliveriesEntry

(synq.deliveries.v1.BatchGetDeliveriesResponse.DeliveriesEntry)

Field	Type	Description
key	string	none
value	Delivery	none

GetDeliveryRequest

(synq.deliveries.v1.GetDeliveryRequest)

Field	Type	Description
id	string	Delivery id.

GetDeliveryResponse

(synq.deliveries.v1.GetDeliveryResponse)

Field	Type	Description
oneof _delivery.delivery	optional Delivery	The delivery. Absent when there is none with that id.

ListAttemptsRequest

(synq.deliveries.v1.ListAttemptsRequest)

Field	Type	Description
delivery_id	string	Delivery whose attempts to list.

ListAttemptsResponse

(synq.deliveries.v1.ListAttemptsResponse)

Field	Type	Description
attempts	repeated Attempt	Every attempt made, oldest first. Empty for a delivery that sent nothing, and for one still waiting on its first attempt.

ListDeliveriesRequest

(synq.deliveries.v1.ListDeliveriesRequest)

Field	Type	Description
oneof _integration_id.integration_id	optional string	Restrict to one integration. Omit for the whole workspace’s feed.
oneof _event_id.event_id	optional string	Restrict to one event — every integration it reached, and what each did with it. This is the `event_id` from a received webhook payload. Setting it searches everything still retained, ignoring `since` and `until`.
oneof _subject_id.subject_id	optional string	Restrict to the issue or incident the delivery was about. Takes the same identifier the rest of the API uses for that object. Setting it searches everything still retained, ignoring `since` and `until`.
event_types	repeated string	Restrict to these event types, by `synq.webhooks.v1.Event.EventType` name. Empty matches every type.
outcomes	repeated Outcome	Restrict to these outcomes. Empty matches every outcome.
status_codes	repeated int32	Restrict to deliveries whose most recent attempt returned one of these HTTP statuses. Empty matches every status.
oneof _since.since	optional Timestamp	Only deliveries for events at or after this time. Defaults to the start of the retention window, and is ignored when `event_id` or `subject_id` names what to return. Note that this bounds the event time, which for an issue is when the issue began rather than when the delivery was sent.
oneof _until.until	optional Timestamp	Only deliveries for events strictly before this time. Defaults to now, and is ignored when `event_id` or `subject_id` names what to return.
pagination	Pagination	Pagination. Deliveries are returned newest event first; pass the `last_id` of the previous page as the cursor.
include_routing	bool	Also return `matched_alert_configs` and `correlation_key` on each delivery. Off by default: it costs a second read per delivery, and a feed rarely needs it. `BatchGetDeliveries` always returns them.

ListDeliveriesResponse

(synq.deliveries.v1.ListDeliveriesResponse)

Field	Type	Description
deliveries	repeated Delivery	The matching deliveries, newest event first.
page_info	PageInfo	Cursor for the next page.

OutcomeCount

(synq.deliveries.v1.OutcomeCount)

Field	Type	Description
outcome	Outcome	none
count	int32	none

RedeliverRequest

(synq.deliveries.v1.RedeliverRequest)

Field	Type	Description
delivery_id	string	Delivery to send again.

RedeliverResponse

(synq.deliveries.v1.RedeliverResponse)

Field	Type	Description
delivery_id	string	Id of the delivery created by the replay. Poll `BatchGetDeliveries` with it to follow the outcome.

SendTestDeliveryRequest

(synq.deliveries.v1.SendTestDeliveryRequest)

Field	Type	Description
integration_id	string	Integration to send the test to.
oneof _message.message	optional string	Message to carry in the test payload, so a test can be recognised on the receiving end. Defaults to a generic one.

SendTestDeliveryResponse

(synq.deliveries.v1.SendTestDeliveryResponse)

Field	Type	Description
delivery_id	string	Id of the delivery created. Poll `BatchGetDeliveries` with it to follow the outcome.

SkipReasonCount

(synq.deliveries.v1.SkipReasonCount)

Field	Type	Description
skip_reason	SkipReason	none
count	int32	none

StatusClassCount

(synq.deliveries.v1.StatusClassCount)

Field	Type	Description
status_class	StatusClass	none
count	int32	none

SummariseDeliveriesRequest

(synq.deliveries.v1.SummariseDeliveriesRequest)

Field	Type	Description
oneof _integration_id.integration_id	optional string	Restrict to one integration. Omit to summarise the whole workspace.
since	Timestamp	Start of the window, on event time. Required — a summary of everything kept is rarely the question, and always the most expensive one.
oneof _until.until	optional Timestamp	End of the window, on event time. Defaults to now.

SummariseDeliveriesResponse

(synq.deliveries.v1.SummariseDeliveriesResponse)

Field	Type	Description
since	Timestamp	The window actually summarised, after defaults were applied.
until	Timestamp	none
total	int32	Deliveries in the window, whatever became of them.
by_outcome	repeated OutcomeCount	Counts per outcome. Outcomes with no deliveries are omitted.
by_status_class	repeated StatusClassCount	Counts per HTTP status class of the most recent attempt. Deliveries that were never attempted are omitted rather than counted as a class.
by_skip_reason	repeated SkipReasonCount	Counts per reason for sending nothing. Only over the deliveries counted as `OUTCOME_SKIPPED` or `OUTCOME_NOT_ROUTED`.

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)

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)

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.

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.

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

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)

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)

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)

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 either a Microsoft Teams channel or a specific member.

Field	Type	Description
channel	string	Teams channel name or ID. Leave unset to direct-message a member instead.
member_id	string	Microsoft Teams member id for direct-message delivery.

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. Deprecated: use synq.alerts.v2.Alert, whose trigger is the canonical synq.queries.v1.Query + resolver_ql selection. This message is served only by the deprecated synq.alerts.services.v1.AlertsService and is scheduled for removal.

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. Deprecated: the v2 trigger selects entities with synq.queries.v1.Query + resolver_ql instead. Scheduled for removal with synq.alerts.services.v1.

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.
ongoing	OngoingAlertsStrategy	Delivery strategy. Unset or stream sends one alert per schema change; a schedule batches them into a periodic digest on the given cron cadence.

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. Deprecated: the v2 trigger selects entities with synq.queries.v1.Query + resolver_ql instead. Scheduled for removal with synq.alerts.services.v1.

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.entity_ids	EntityIds	Alert on specific entities, named by the ids the API returned for them. Read back as `identifier_list`, with each id on the identifier it names.
oneof part.query	SelectionQuery	Nested selection query for complex filtering.
oneof part.unsupported	Unsupported	Unsupported query types for backward compatibility.

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.

AlertIdentifier

(synq.alerts.services.v2.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.v2.BatchGetRequest)

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

BatchGetResponse

(synq.alerts.services.v2.BatchGetResponse)

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

BatchGetResponse.AlertsEntry

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

Field	Type	Description
key	string	none
value	Alert	none

CreateRequest

(synq.alerts.services.v2.CreateRequest) CreateRequest creates a new alert configuration. The kind oneof carries the full specification of the alert; its target and trigger constraints are enforced on the concrete kind messages. Incident-owner alerts are not created here — turn them on with ToggleIncidentOwnerAlert.

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.
oneof _template.template	optional AlertTemplate	Optional custom template for the rendered alert message. Common to every alert kind; currently applied only to issue alerts.
oneof kind.issue_lifecycle	IssueLifecycleAlert	An issue alert on selected entities.
oneof kind.schema_change	SchemaChangeAlert	A schema change alert on selected entities.
oneof kind.incident_lifecycle	IncidentLifecycleAlert	An incident lifecycle alert.

CreateResponse

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

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

DeleteRequest

(synq.alerts.services.v2.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.v2.DeleteResponse) DeleteResponse confirms the deletion (empty response). Empty response - successful deletion is indicated by HTTP 200 status.

ListRequest

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

Field	Type	Description
oneof _owner.owner	optional Owner	Optional filter by owner of the alert configurations. Only issue and schema change alerts carry an owner; filtering by owner therefore returns those only.

ListResponse

(synq.alerts.services.v2.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.

RenameRequest

(synq.alerts.services.v2.RenameRequest) RenameRequest changes an alert’s human-readable name.

Field	Type	Description
identifier	AlertIdentifier	Identifier for the config to rename.
name	string	New human-readable name for the alert configuration.

RenameResponse

(synq.alerts.services.v2.RenameResponse) RenameResponse returns the renamed alert configuration.

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

SendTestAlertRequest

(synq.alerts.services.v2.SendTestAlertRequest) SendTestAlertRequest delivers a static test message to the given targets.

Field	Type	Description
name	string	Alert name shown in the test message. Optional — leave empty while an alert is still being created; the message then omits the name.
kind	TestAlertKind	The alert kind the test stands in for. Optional; selects the message wording only, so an unspecified kind produces a generic test message.
targets	repeated AlertingTarget	The targets to deliver the test message to. At least one is required. Owner targets are expanded to each owner’s configured channels.

SendTestAlertResponse

(synq.alerts.services.v2.SendTestAlertResponse) SendTestAlertResponse reports the per-target outcome of the test send.

Field	Type	Description
dispatches	repeated TestAlertDispatch	One entry per delivered target, in the order they were resolved. Owner targets contribute one entry per resolved channel.

TestAlertDispatch

(synq.alerts.services.v2.TestAlertDispatch) TestAlertDispatch is the outcome of delivering the test message to one target.

Field	Type	Description
target	AlertingTarget	The resolved target this outcome refers to.
dispatched	bool	True once the message was handed to the delivery channel; the delivery itself is asynchronous, so this does not confirm the recipient received it.
error	string	Why this target was not dispatched; empty when dispatched is true.

ToggleEnabledRequest

(synq.alerts.services.v2.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.v2.ToggleEnabledResponse) ToggleEnabledResponse confirms the toggle operation (empty response). Empty response - successful toggle is indicated by HTTP 200 status.

ToggleIncidentOwnerAlertRequest

(synq.alerts.services.v2.ToggleIncidentOwnerAlertRequest) ToggleIncidentOwnerAlertRequest turns the workspace’s incident-owner alert on or off.

Field	Type	Description
is_enabled	bool	true turns the incident-owner alert on (creating it if absent); false turns it off (removing it). Setting the current state is a no-op.

ToggleIncidentOwnerAlertResponse

(synq.alerts.services.v2.ToggleIncidentOwnerAlertResponse) ToggleIncidentOwnerAlertResponse reports the resulting state.

Field	Type	Description
is_enabled	bool	Whether the incident-owner alert is on after the call.

UpdateSettingsRequest

(synq.alerts.services.v2.UpdateSettingsRequest) UpdateSettingsRequest updates an alert’s trigger and/or its kind-specific settings. At least one of the two must be provided; whichever is omitted is left unchanged (neither can be cleared). The provided settings must match the alert’s existing kind — switching an alert from one kind to another is not permitted.

Field	Type	Description
identifier	AlertIdentifier	Identifier for the config to update.
oneof _trigger.trigger	optional Trigger	New entity selection. Issue and schema change alerts only. Omit to keep the current trigger; it cannot be cleared.
oneof settings.issue_lifecycle	IssueAlertSettings	Settings for an issue alert.
oneof settings.schema_change	SchemaChangeAlertSettings	Settings for a schema change alert.
oneof settings.incident_lifecycle	IncidentLifecycleAlertSettings	Settings for an incident lifecycle alert.

UpdateSettingsResponse

(synq.alerts.services.v2.UpdateSettingsResponse) UpdateSettingsResponse returns the updated alert configuration.

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

UpdateTargetsRequest

(synq.alerts.services.v2.UpdateTargetsRequest) UpdateTargetsRequest replaces an alert’s delivery targets.

Field	Type	Description
identifier	AlertIdentifier	Identifier for the config to update.
targets	repeated AlertingTarget	The complete set of delivery targets, replacing the existing ones. At least one target is required; the allowed target types depend on the alert’s kind.

UpdateTargetsResponse

(synq.alerts.services.v2.UpdateTargetsResponse) UpdateTargetsResponse returns the updated alert configuration.

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

UpdateTemplateRequest

(synq.alerts.services.v2.UpdateTemplateRequest) UpdateTemplateRequest sets or clears an alert’s message template.

Field	Type	Description
identifier	AlertIdentifier	Identifier for the config to update.
oneof _template.template	optional AlertTemplate	New custom template for the rendered alert message. Omit to clear the template and revert to the default rendering. Currently applied only to issue alerts; accepted and ignored for other kinds.

UpdateTemplateResponse

(synq.alerts.services.v2.UpdateTemplateResponse) UpdateTemplateResponse returns the updated alert configuration.

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

AlertingTarget

(synq.alerts.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.Alert) Alert represents the configuration for an alert. An alert is exactly one concrete kind, distinguished by the kind oneof:

issue_lifecycle: fires on the issues of selected entities.
schema_change: fires on the schema changes of selected entities.
incident_lifecycle: fires on incident state transitions. The identity, template and ownership fields are shared; everything specific to how an alert triggers and delivers lives on its kind message.

Incident-owner alerts (which notify each incident’s owner) are not configurable and are not represented here; they are turned on or off with AlertsService.ToggleIncidentOwnerAlert.

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.
created_at	Timestamp	Timestamp when the alert config was created.
is_disabled	bool	Whether the alert config is currently disabled.
oneof _template.template	optional AlertTemplate	Optional custom template for the rendered alert message. Common to every alert kind. Currently applied only to issue alerts; on other kinds it is accepted and ignored until templating is supported for them.
oneof kind.issue_lifecycle	IssueLifecycleAlert	Fires on the issues of selected entities.
oneof kind.schema_change	SchemaChangeAlert	Fires on the schema changes of selected entities.
oneof kind.incident_lifecycle	IncidentLifecycleAlert	Fires on incident state transitions.

EmailCustomizationOptions

(synq.alerts.v2.EmailCustomizationOptions) EmailCustomizationOptions customises the addresses used when an alert is delivered by email. Unset addresses fall back to the workspace defaults.

Field	Type	Description
oneof _from.from	optional EmailSender	Sender address emails are sent from.
oneof _reply_to.reply_to	optional EmailSender	Reply-to address for emails.

EmailSender

(synq.alerts.v2.EmailSender) EmailSender is an email address paired with an optional display name.

Field	Type	Description
email	string	Email address.
name	string	Display name shown alongside the address.

IncidentLifecycleAlert

(synq.alerts.v2.IncidentLifecycleAlert) IncidentLifecycleAlert fires when an incident transitions into one of the selected states. It takes no entity selection.

Field	Type	Description
targets	repeated AlertingTarget	Targets where alerts will be sent. At least one is required.
settings	IncidentLifecycleAlertSettings	Incident lifecycle alert settings.

IncidentLifecycleAlertSettings

(synq.alerts.v2.IncidentLifecycleAlertSettings) IncidentLifecycleAlertSettings configures an alert that fires when an incident enters one of the selected states.

Field	Type	Description
states	repeated State	Incident states whose transitions fire this alert; an empty list would create an alert that never fires.

IssueAlertSettings

(synq.alerts.v2.IssueAlertSettings) IssueAlertSettings is the unified alert settings type for issue-based alerts.

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.
oneof _email_customization_options.email_customization_options	optional EmailCustomizationOptions	Optional customisation of the sender and reply-to addresses on email alerts.

IssueGroupingStrategy

(synq.alerts.v2.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.v2.IssueGroupingStrategy.NoGrouping) NoGrouping - each issue triggers a separate alert.

IssueGroupingStrategy.SystemDetected

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

IssueLifecycleAlert

(synq.alerts.v2.IssueLifecycleAlert) IssueLifecycleAlert fires on the issues of the entities its trigger selects.

Field	Type	Description
trigger	Trigger	Selects the entities that can trigger this alert.
targets	repeated AlertingTarget	Targets where alerts will be sent. At least one is required.
settings	IssueAlertSettings	Issue alert settings.
oneof _owner.owner	optional Owner	Optional owner information. The owner is fixed when the alert is created.

OngoingAlertsStrategy

(synq.alerts.v2.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.v2.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.v2.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.v2.OngoingAlertsStrategy.Stream) Stream strategy - alerts are sent continuously as issues persist. No configuration needed - alerts stream continuously.

Owner

(synq.alerts.v2.Owner) Owner attributes an alert to an owner and ownership. Only entity-scoped alerts (issue and schema change) can be owned.

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

SchemaChangeAlert

(synq.alerts.v2.SchemaChangeAlert) SchemaChangeAlert fires on the schema changes of the entities its trigger selects.

Field	Type	Description
trigger	Trigger	Selects the entities that can trigger this alert.
targets	repeated AlertingTarget	Targets where alerts will be sent. At least one is required.
settings	SchemaChangeAlertSettings	Schema change alert settings.
oneof _owner.owner	optional Owner	Optional owner information. The owner is fixed when the alert is created.

SchemaChangeAlertSettings

(synq.alerts.v2.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.
ongoing	OngoingAlertsStrategy	Delivery strategy. Unset or stream sends one alert per schema change; a schedule batches them into a periodic digest on the given cron cadence.

Trigger

(synq.alerts.v2.Trigger) Trigger selects the entities whose issues or schema changes fire this alert: a structured query, an optional ResolverQL string that takes precedence when set, and a read-only canonical rendering.

Field	Type	Description
query	Query	Structured selection of the entities that can trigger this alert. On write it is the selection unless `resolver_ql` is set, which takes precedence. Always populated on read, best-effort — a part with no public form is carried as `unsupported`.
resolver_ql	string	ResolverQL selection string, a more expressive alternative to `query` for selections it cannot express (e.g. lineage walks, column predicates). When set on write it takes precedence and `query` is ignored. On read it is echoed back verbatim for alerts authored via ResolverQL and empty for structured alerts, so writing a read response back unchanged preserves the authored form. See `rendered_resolver_ql` for the ResolverQL form of a structured alert.
rendered_resolver_ql	string	Output-only canonical ResolverQL rendering of this alert’s selection, populated regardless of how it was authored (it equals `resolver_ql` for ResolverQL-authored alerts). Ignored on write. Empty only for selections with no ResolverQL representation.

AlertTemplate

(synq.alerts.templates.v2.AlertTemplate) AlertTemplate customises the message rendered for an alert. The body is either verbatim text (plain), rendered exactly as given, or a structured template (structured) assembled from named blocks written in Jinja-compatible syntax and grouped by where they render.

Field	Type	Description
title	string	Optional custom title for the rendered message.
oneof body.plain	string	Verbatim message text, rendered as-is with no templating.
oneof body.structured	StructuredTemplate	A structured, dynamically rendered body.

StructuredTemplate

(synq.alerts.templates.v2.StructuredTemplate) StructuredTemplate is a dynamic template split into the two tiers a message renders in. Within each tier, blocks render in list order. A block that should appear in both tiers is listed in both summary and issue_details with the same name.

Field	Type	Description
summary	repeated TemplateBlock	Blocks rendered once, in the group/summary message.
issue_details	repeated TemplateBlock	Blocks rendered per issue, in the per-issue attachment or card.

TemplateBlock

(synq.alerts.templates.v2.TemplateBlock) TemplateBlock is one unit of Jinja-compatible source.

Field	Type	Description
oneof _name.name	optional string	Optional block name. A block listed in both `summary` and `issue_details` under the same name is one shared block. Leave it unset and the server assigns and returns a stable name. Names reserved for built-in catalog blocks render under the server’s own layout rather than emitting your content verbatim, so give a custom block a distinct name.
content	string	Jinja-compatible source of the block body.

Folder

(synq.entities.folders.v1.Folder) Folder is one node in the folder / containment hierarchy: an integration root, a container (database, schema, project), or a nested folder. Members that are not themselves folders (tables, models, …) are returned as entity ids, not as Folders.

Field	Type	Description
folder_entity_id	string	Opaque, authoritative id of this folder. Round-trip it verbatim as the `parent` of `Browse` or the `folder` of `ListMembers`; do not parse it. It is the canonical handle for a folder — always prefer it over rebuilding a location from `ref` when calling back in.
ref	FolderRef	Structured, human-friendly address of this folder. Populated when it can be derived from the surrounding hierarchy (always for `GetFolderOf`, and for `Browse` when the parent location is known). When it cannot be derived, `folder_entity_id` remains the authoritative handle.
name	string	Display name of this folder (its own leaf name, e.g. “sales”).
full_name	repeated string	Full display path from the root down to this folder (root first, leaf last), e.g. [“clickhouse-prod”, “default”, “sales”]. Suitable for rendering a breadcrumb.
type	EntityType	Entity type of this node. Folders synthesized purely for grouping report an unspecified type; container entities that also act as folders (databases, schemas, projects) report their real type.
platform	DataPlatformType	Platform this folder belongs to, when known.
child_folder_count	uint32	Number of direct sub-folders. Best-effort: it may be reported as a collapsed count for lazily-loaded folders and can be 0 when the count was not loaded.
member_count	uint32	Number of direct, non-folder members (entities that sit directly in this folder). Best-effort and may be 0 when not loaded.
role	FolderRole	How this folder participates in browsing.

BrowseRequest

(synq.entities.folders.v1.BrowseRequest)

Field	Type	Description
oneof parent.parent_folder_entity_id	string	Opaque id of the parent folder to browse into (from `Folder.folder_entity_id`).
oneof parent.parent_ref	FolderRef	Structured address of the parent folder to browse into.
filter	Query	Optional filter. When set, the returned `member_entity_ids` are limited to entities matching this query.

BrowseResponse

(synq.entities.folders.v1.BrowseResponse)

Field	Type	Description
folders	repeated Folder	Direct sub-folders of the browsed location (or the roots, when no `parent` was given).
member_entity_ids	repeated string	Opaque entity ids of the direct, non-folder members of the browsed folder. Empty when browsing the roots. Shallow by default — members of sub-folders are not included unless `depth` expanded them.

GetFolderOfRequest

(synq.entities.folders.v1.GetFolderOfRequest)

Field	Type	Description
entity_ids	repeated string	Opaque entity ids to look up. Ids that do not exist, or that live in no folder, are absent from the response.

GetFolderOfResponse

(synq.entities.folders.v1.GetFolderOfResponse)

Field	Type	Description
breadcrumbs_by_entity_id	map BreadcrumbsByEntityIdEntry	Requested entity id -> its containing breadcrumb(s).

(synq.entities.folders.v1.GetFolderOfResponse.Breadcrumb) One containing breadcrumb: the folders from a root down to (and including) the entity’s immediate parent, ordered root first.

Field	Type	Description
folders	repeated Folder	none

GetFolderOfResponse.Breadcrumbs

(synq.entities.folders.v1.GetFolderOfResponse.Breadcrumbs) All breadcrumbs for one entity. Most entities have a single breadcrumb; an entity placed in several hierarchies has one per hierarchy.

Field	Type	Description
breadcrumbs	repeated Breadcrumb	none

GetFolderOfResponse.BreadcrumbsByEntityIdEntry

(synq.entities.folders.v1.GetFolderOfResponse.BreadcrumbsByEntityIdEntry)

Field	Type	Description
key	string	none
value	Breadcrumbs	none

ListMembersRequest

(synq.entities.folders.v1.ListMembersRequest)

Field	Type	Description
oneof folder.folder_entity_id	string	Opaque id of the folder (from `Folder.folder_entity_id`).
oneof folder.folder_ref	FolderRef	Structured address of the folder.
deep	bool	When true, include entities in all nested sub-folders. When false (default), return only the entities placed directly in this folder.
types	repeated EntityType	Optional entity-type filter. Empty returns all types.
filter	Query	Optional query filter. When set, only members matching this query are returned.
pagination	Pagination	Pagination.

ListMembersResponse

(synq.entities.folders.v1.ListMembersResponse)

Field	Type	Description
entity_ids	repeated string	Opaque entity ids of the folder’s members.
page_info	PageInfo	Pagination cursor for the next page.

EntityTraitDef

(synq.entities.typedefs.v1.EntityTraitDef) EntityTraitDef describes one trait a selection query can filter entities by. A trait names a property a type has rather than a type itself, so a selection can ask for “everything a monitor can run on” instead of listing the forty-odd types that satisfy it today. The set of types it stands for is worked out each time the query runs, so a selection saved this way covers a new platform’s types as soon as Coalesce Quality supports them, and you never have to revisit it. In a query written as text this is with_type(traits="is_monitorable"); in a structured query it is the traits field on synq.queries.v1.WithType. Read this list rather than keeping your own. Traits are added as the platform grows, and a name that is not in the list selects NOTHING — so a stale copy narrows a selection to empty rather than failing where you would notice.

Field	Type	Description
name	string	The trait’s name, and the exact string a query carries: `is_monitorable`. Stable and safe to store. Matching ignores case.
short_name	string	The trait’s name for display: “Monitorable”, “Warehouse table”.
description	string	A sentence explaining what the trait means and what selecting on it gets you.
entity_types	repeated EntityType	Every entity type that carries this trait today.

It is this server’s current answer, not a definition — the point of selecting by trait is that this set grows without your query changing. Use it to show or preview what a selection covers, never to expand a trait into types and store that instead. |

EntityTypeDef

(synq.entities.typedefs.v1.EntityTypeDef) EntityTypeDef describes one kind of entity that exists in your workspace — a BigQuery table, a dbt model, an Airflow DAG, or a type you defined yourself. Use it to turn the entity_type that other endpoints return into something you can show a person or make a decision about: a name to display, the platform it came from, and what Coalesce Quality does with it. The built-in types and your own custom types both come back here, in this same shape. A custom type is the one with a non-zero type_id.

Field	Type	Description
entity_type	EntityType	The entity type, matching the `entity_type` other endpoints return for an entity of this kind. Compare against it directly.

If your generated code is older than the server, a type it does not know arrives as an unrecognised number — name still identifies it. | | name | string | A stable name for the type that never changes, safe to store and to compare against. Built-in types use the enum spelling, e.g. ENTITY_TYPE_BQ_TABLE. Your own types are named CUSTOM_TYPE_<type_id>, e.g. CUSTOM_TYPE_20, which stays the same even if you rename the type. Prefer this over the numeric value whenever you store a reference to a type. It is also the name a selection query spells the type by, lowercased and without the ENTITY_TYPE_ prefix: with_type("bq_table") for a built-in, with_type("custom_type_20") for one of your own. Matching there ignores case, so this value can be passed through as it is. | | short_name | string | The type’s name without its platform: “Table”, “View”, “DAG”. Use it where the platform is already clear from the surrounding context. For a type you defined yourself, this is the name you gave it. | | short_plural_name | string | The plural of short_name, for counts and headings: “Tables”, “Views”. Empty for a type you defined yourself, since you gave it a single name — fall back to short_name. | | full_name | string | The type’s name including its platform: “BigQuery Table”, “Snowflake View”. Use it where a type appears on its own, so that a table from two different warehouses still reads clearly. For a type you defined yourself, this is the same as short_name. | | full_plural_name | string | The plural of full_name: “BigQuery Tables”. Empty under the same condition as short_plural_name. | | description | string | A sentence explaining the type, where there is one. Often empty. | | platform | DataPlatformType | The platform this type belongs to — the warehouse, BI tool or orchestrator it comes from. Pair it with ListPlatformDefs to show that platform’s name. A type you defined yourself belongs to no external platform, so it reports Coalesce Quality itself. | | traits | Traits | What Coalesce Quality knows about entities of this type. For a built-in type this is everything it knows. For a type you defined yourself it is the traits that can be declared on a custom type, each reported whether you set it or not; the traits Coalesce Quality works out on its own for built-in types are not reported for a custom type, so read those with a default. | | type_id | int32 | The id of a type you defined yourself, and 0 for a built-in type. It is the same type_id that appears on your entities of this type, and the id you pass to synq.entities.custom.v1.TypesService to change the type or fetch its icon. A non-zero value is how you tell your own types from the built-in ones. |

ExecutionTypeDef

(synq.entities.typedefs.v1.ExecutionTypeDef) ExecutionTypeDef describes one kind of run Coalesce Quality records against an entity — a dbt invocation, a warehouse query job, a detected schema change. Use it to name the execution_type that execution and run endpoints return.

Field	Type	Description
execution_type	ExecutionType	The execution type, matching the `execution_type` other endpoints return.
name	string	A stable name for the execution type that never changes, safe to store: the enum spelling, e.g. `EXECUTION_TYPE_DBT_INVOCATION`.
short_name	string	The execution type’s name for display: “Query Job”, “Schema Change”, “dbt”.
platform	DataPlatformType	The platform this kind of run comes from. Unset for the kinds Coalesce Quality produces itself, such as a detected schema change.
traits	Traits	What Coalesce Quality knows about this kind of run. Empty for a kind that has no traits of its own.

PlatformDef

(synq.entities.typedefs.v1.PlatformDef) PlatformDef describes one platform Coalesce Quality connects to — a warehouse, a BI tool, an orchestrator, a transformation framework. Use it to show a platform’s name rather than building one out of an enum value.

Field	Type	Description
platform	DataPlatformType	The platform, matching the `platform` on an EntityTypeDef and the platform fields other endpoints return.
name	string	A stable name for the platform that never changes, safe to store: the enum spelling, e.g. `DATA_PLATFORM_TYPE_BIGQUERY`.
display_name	string	The platform’s name as it is normally written: “BigQuery”, “ClickHouse”, “Microsoft SQL Server”, “dbt”. Use this anywhere a person will read it.
traits	Traits	What Coalesce Quality knows about the platform. `is_dwh` tells you whether it is a data warehouse — true for BigQuery and Snowflake, false for dbt or Looker.

Traits

(synq.entities.typedefs.v1.Traits) Traits are the facts Coalesce Quality knows about a kind of thing, beyond its name — whether it is a transformation model, whether it lives in a warehouse, whether you can put a monitor on it. They come back as maps rather than as named fields so that new traits reach you without regenerating your client. Look up the ones you care about by name and ignore the rest: if (def.traits.flags[“is_model”]) { … } Common flag names are is_model, is_source, is_dwh_table, is_dwh_view, is_bi_like, is_monitorable and is_searchable. More are added over time, so treat the map as open-ended. A name missing from the map has no answer for this type. Read traits with a default rather than assuming false, so your code keeps working against both an older and a newer server: isModel = def.traits.flags.get(“is_model”, false)

Field	Type	Description
flags	map FlagsEntry	Yes/no traits, by name. For example `{"is_model": true, "is_dwh_table": false}`.
strings	map StringsEntry	Traits whose value is a piece of text, by name. For example `{"synql_alias": "table"}`. There are far fewer of these than flags, and most types have none.

Traits.FlagsEntry

(synq.entities.typedefs.v1.Traits.FlagsEntry)

Field	Type	Description
key	string	none
value	bool	none

Traits.StringsEntry

(synq.entities.typedefs.v1.Traits.StringsEntry)

Field	Type	Description
key	string	none
value	string	none

ListEntityTraitDefsRequest

(synq.entities.typedefs.v1.ListEntityTraitDefsRequest)

ListEntityTraitDefsResponse

(synq.entities.typedefs.v1.ListEntityTraitDefsResponse)

Field	Type	Description
entity_trait_defs	repeated EntityTraitDef	Every trait a selection query can filter by, ordered by name.

ListEntityTypeDefsRequest

(synq.entities.typedefs.v1.ListEntityTypeDefsRequest)

ListEntityTypeDefsResponse

(synq.entities.typedefs.v1.ListEntityTypeDefsResponse)

Field	Type	Description
entity_type_defs	repeated EntityTypeDef	Every entity type in your workspace, built-in and your own, ordered by entity type value. Your own types sort together after the built-in ones, and two calls against an unchanged workspace return the same order.

ListExecutionTypeDefsRequest

(synq.entities.typedefs.v1.ListExecutionTypeDefsRequest)

ListExecutionTypeDefsResponse

(synq.entities.typedefs.v1.ListExecutionTypeDefsResponse)

Field	Type	Description
execution_type_defs	repeated ExecutionTypeDef	Every kind of run, ordered by execution type value.

ListPlatformDefsRequest

(synq.entities.typedefs.v1.ListPlatformDefsRequest)

ListPlatformDefsResponse

(synq.entities.typedefs.v1.ListPlatformDefsResponse)

Field	Type	Description
platform_defs	repeated PlatformDef	Every platform, ordered by platform value.

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

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.
include_segments	bool	Include the per-segment checks of segmented monitors.

A segmented monitor publishes one check entity per distinct value of its segmentation column, so a single monitor can stand behind hundreds of them and they can outnumber an asset’s other checks by an order of magnitude. They are left out by default so a coverage read stays readable, and asked for explicitly when the caller wants the individual segment ids — the same ids alerts, search results and the monitor-predictions read use. Segment checks are only ever reported on the asset the monitor runs on: they are a slice of one monitor on one asset, and never propagate downstream. The parent monitor’s own check propagates as it always has, so downstream coverage is unchanged by this field. |

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.

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 technical category (empty = no explicit technical 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).
updated_by	Actor	Who last set this category: display name, and the account or channel they acted through. Absent when the setter could not be resolved to anything a reader would recognise. Server-derived; 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 the server-set editor and timestamp.

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	Technical category to use for this check — what kind of check it is, mechanically, e.g. “nullness”. Empty when the check declares none, in which case the category a categorisation rule computes is used instead.
oneof _governance_category.governance_category	optional string	Governance category to use for this check — what the check is for, e.g. “Completeness”. Empty when the check declares none, in which case the category a categorisation rule computes is used instead.

BatchGetRulesRequest

(synq.entities.checks.v2.BatchGetRulesRequest)

Field	Type	Description
ids	repeated string	Rule ids to read (1–200, unique).

BatchGetRulesResponse

(synq.entities.checks.v2.BatchGetRulesResponse)

Field	Type	Description
rules	map RulesEntry	Rules keyed by id. Ids the caller cannot see, or that do not exist, are absent.

BatchGetRulesResponse.RulesEntry

(synq.entities.checks.v2.BatchGetRulesResponse.RulesEntry)

Field	Type	Description
key	string	none
value	CategorisationRule	none

DeleteRuleRequest

(synq.entities.checks.v2.DeleteRuleRequest)

Field	Type	Description
id	string	Id of the rule to delete.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.
oneof _actor.actor	optional Actor	Who is making the change. See UpsertRuleRequest.actor.

DeleteRuleResponse

(synq.entities.checks.v2.DeleteRuleResponse)

GetRecategorisationStatusRequest

(synq.entities.checks.v2.GetRecategorisationStatusRequest)

GetRecategorisationStatusResponse

(synq.entities.checks.v2.GetRecategorisationStatusResponse)

Field	Type	Description
status	RecategorisationStatus	Progress of the caller’s workspace sweep.

ListRuleMatchesRequest

(synq.entities.checks.v2.ListRuleMatchesRequest)

Field	Type	Description
rule_ids	repeated string	Rules to report on. Empty returns every rule that currently categorises at least one check.
oneof _sample_size.sample_size	optional int32	How many check ids to return per rule as a sample. Defaults to 100, and may be 0 for counts only. The counts are always exact whatever this is set to.

ListRuleMatchesResponse

(synq.entities.checks.v2.ListRuleMatchesResponse)

Field	Type	Description
matches	map MatchesEntry	Matches keyed by rule id. Rules that currently categorise nothing are absent.

ListRuleMatchesResponse.MatchesEntry

(synq.entities.checks.v2.ListRuleMatchesResponse.MatchesEntry)

Field	Type	Description
key	string	none
value	RuleMatches	none

ListRulesRequest

(synq.entities.checks.v2.ListRulesRequest)

Field	Type	Description
oneof _dimension.dimension	optional CategoryDimension	Restrict to one dimension. Omit to return both.
oneof _scope.scope	optional RuleScope	Restrict to the workspace’s own rules or to the platform-provided ones. Omit to return both.
pagination	Pagination	Pagination. Defaults to 200 rules per page.

ListRulesResponse

(synq.entities.checks.v2.ListRulesResponse)

Field	Type	Description
rules	repeated CategorisationRule	Matching rules, in the order they are tried: workspace rules before platform-provided ones, then by descending priority.
page_info	PageInfo	Pagination cursor for the next page. Empty when this is the last page.

PreviewRuleRequest

(synq.entities.checks.v2.PreviewRuleRequest)

Field	Type	Description
oneof _id.id	optional string	Set to an existing rule’s id to preview an edit to it — the candidate replaces that rule during resolution, so the result reflects the change rather than the addition of a second rule. Omit to preview a new rule.
dimension	CategoryDimension	The dimension the candidate would categorise along.
scope	RuleScope	Scope the candidate would be saved with. Defaults to RULE_SCOPE_WORKSPACE.
title	string	Title the candidate would be saved with. Does not affect the outcome.
category	string	The category the candidate would assign.
matcher	CheckMatcher	Which checks the candidate would apply to.
priority	int32	Priority the candidate would be saved with. It participates in resolution exactly as it would once saved, so previewing at the wrong priority reports the wrong impact.
oneof _sample_size.sample_size	optional int32	How many check ids to return in each of the response’s samples — it caps `affected_entity_ids` and `explicit_category_entity_ids` independently, so either may come back at this size. Defaults to 100, and may be 0 for counts only. The counts are always exact whatever this is set to.

PreviewRuleResponse

(synq.entities.checks.v2.PreviewRuleResponse)

Field	Type	Description
matched_count	int64	Checks whose predicate the candidate matches at all — its raw reach, whether or not it ends up winning them.
affected_count	int64	Checks whose effective category on the candidate’s dimension would actually change. This is the rule’s real impact. It equals newly_categorised_count + reassigned_count, and matched_count equals this plus unchanged_count.
newly_categorised_count	int64	Of the affected checks, how many have no category on this dimension today.
reassigned_count	int64	Of the affected checks, how many already have a different category that the candidate would take over. Worth a second look before saving.
unchanged_count	int64	Checks the candidate matches whose effective category would not change. The three fields below say why, and add up to this one.
affected_entity_ids	repeated string	A sample of the affected checks, ordered by entity id.
affected_entity_ids_truncated	bool	True when the sample was cut short by `sample_size`.
higher_priority_rule_count	int64	Of the unchanged checks, how many a rule of higher priority already wins, so the candidate never gets to assign anything. Raise the candidate’s priority to take these over.
explicit_category_count	int64	Of the unchanged checks, how many carry a category set explicitly on the check, or declared by the tool that produced it. Either outranks every rule, so these are the checks the candidate looks like it covers and does not — no priority will win them. Clear the explicit category to hand a check back to the rules.
same_category_count	int64	Of the unchanged checks, how many the candidate does win, assigning the category the check already has. Nothing to do about these; the rule is simply agreeing with what is there.
explicit_category_entity_ids	repeated string	A sample of the checks counted in `explicit_category_count`, ordered by entity id — the ones worth showing a customer, because a rule that reads as covering them does not.
explicit_category_entity_ids_truncated	bool	True when that sample was cut short by `sample_size`.

UpsertRuleRequest

(synq.entities.checks.v2.UpsertRuleRequest)

Field	Type	Description
id	string	Client-supplied UUID identifying the rule. The same id updates the same rule; a new id creates a new rule.
oneof _dimension.dimension	optional CategoryDimension	The dimension the rule categorises along. Required when creating; omit to keep it on update.
oneof _scope.scope	optional RuleScope	Scope of the rule. Defaults to RULE_SCOPE_WORKSPACE when creating; omit to keep it on update. Platform-provided rules cannot be edited from a workspace.
oneof _title.title	optional string	Human-readable title, shown wherever the rule is credited for a category. Required when creating; omit to keep it on update.
oneof _category.category	optional string	The category assigned to matching checks. Required when creating; omit to keep it on update. Prefer a name the workspace already uses — read them from ChecksCategoriesService.ListCategories.
oneof _matcher.matcher	optional CheckMatcher	Which checks the rule applies to. Required when creating; omit to keep it on update. Replaces the previous matcher wholesale — there is no partial update within a matcher.
oneof _priority.priority	optional int32	Rank within the rule’s scope: the highest number is tried first. Defaults to 0 when creating; omit to keep it on update.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard. When set, the write fails with a conflict if the rule was modified since this etag was read.
oneof _actor.actor	optional Actor	Who is making the change, when the caller acts on someone’s behalf — an agent, a bot, an automation. Recorded as the editor and shown back on reads. Omit it when the caller’s own credentials already identify them.

UpsertRuleResponse

(synq.entities.checks.v2.UpsertRuleResponse)

Field	Type	Description
rule	CategorisationRule	The stored rule after the write.

CheckCategories

(synq.entities.checks.v2.CheckCategories) The category state of a single check, on both dimensions.

Field	Type	Description
entity_id	string	The check this describes. Treat it as opaque: acquire it from a listing or from IdentifierResolveService and pass it back unchanged.
technical	ResolvedCategory	Technical category — what kind of check this is, mechanically.
governance	ResolvedCategory	Governance category — what the check is for.
check	CheckSummary	What the check is, so a listing is actionable on its own. Absent for a check that carries an explicit category but is not (or is no longer) present in the catalogue.
etag	string	Optimistic-concurrency token covering the categories set explicitly on this check. Pass it back on UpsertCheckCategories or DeleteCheckCategories to have the write rejected if someone changed them in the meantime. Empty when the check carries no explicit category. Form: `W/"<entity_id>-<version>"`.
updated_by	Actor	Who last set the explicit categories: display name, and the account or channel they acted through. Absent when no explicit categories are set, and when the setter could not be resolved to anything a reader would recognise.
updated_at	Timestamp	When the explicit categories were last changed. Absent when none are set.

CheckCategoryDeletion

(synq.entities.checks.v2.CheckCategoryDeletion) One check whose explicit categories should be cleared, on both dimensions.

Field	Type	Description
entity_id	string	The check to clear.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard, with the same meaning as on CheckCategoryUpdate.

CheckCategoryUpdate

(synq.entities.checks.v2.CheckCategoryUpdate) The categories to set explicitly on one check. Each dimension is updated independently, and presence is meaningful: omit a field to leave that dimension as it is, send an empty string to clear it so the check falls back to its producer-declared or rule-computed value, send a non-empty string to set or replace it.

Field	Type	Description
entity_id	string	The check to categorise.
oneof _technical.technical	optional string	Technical category to set — what kind of check this is, mechanically.
oneof _governance.governance	optional string	Governance category to set — what the check is for.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard. When set, the write fails with a conflict if the check’s explicit categories changed since this etag was read. Pass an empty string to require that the check has no explicit category yet, which turns the write into a create-only operation.

ComputedCategory

(synq.entities.checks.v2.ComputedCategory) What the workspace’s categorisation rules compute for a check on one dimension, whatever ends up in effect.

Field	Type	Description
category	string	The category the rule assigns.
rule_id	string	The rule that assigns it. Pass it to BatchGetRules to read the rule, or to ListCheckCategories to list every check the rule categorised.
rule_title	string	Title of that rule, so it can be named without a second call.

ResolvedCategory

(synq.entities.checks.v2.ResolvedCategory) The category a check resolves to on one dimension, together with where that value came from. Reading source matters as much as reading category: a value that came from a rule changes when the rules change, while one set explicitly on the check stays until someone clears it.

Field	Type	Description
category	string	The category in effect. Empty when the check is uncategorised on this dimension.
source	CategorySource	Which of the three sources produced `category`.
override	string	The category set explicitly on the check, if any. Populated whatever the effective value is, so you can tell an explicit category apart from the one it replaced. Empty when none is set.
rule_id	string	The rule that computed the category. Populated only when `source` is CATEGORY_SOURCE_RULE; pass it to BatchGetRules to read the rule, or to ListCheckCategories to list every check the rule categorised.
rule_title	string	Title of the rule named by `rule_id`, so “categorised by …” can be rendered without a second call.
rule_scope	RuleScope	Whether the rule that won is one of the workspace’s own or a platform-provided default. Populated only when `source` is CATEGORY_SOURCE_RULE.
computed	ComputedCategory	What the categorisation rules compute for this check, populated whenever a rule matches it at all.

When source is CATEGORY_SOURCE_RULE this is the value in effect and repeats category. When a category set explicitly on the check, or one its producer declared, is standing in front of the rules, this is what the check falls back to once that is cleared — the one part of the resolution a client cannot work out from the fields above. Absent when no rule matches. |

CategorisationRule

(synq.entities.checks.v2.CategorisationRule) A rule that assigns a category to every check it matches. Rules are how a workspace categorises at scale: they apply to the checks that exist today and to every check ingested afterwards, so nobody has to revisit individual checks as tools publish new ones. Rules resolve independently per dimension, and exactly one rule wins a check. Rules are tried in this order, and the first whose matcher matches assigns the category:

Scope first. Every workspace rule is tried before any platform-provided one, whatever their priorities are — so a workspace rule at priority 0 still beats a global rule at priority 1000. This is what makes your own rules an override of the defaults rather than a competitor to them.
Then priority, highest number first. priority is a rank, not a position: 10 is tried before 1.
Then, among rules of equal scope and priority, most recently updated first, and finally by id. resolution_order reports the resulting position, so you never have to reproduce this ordering yourself.

A category a rule computes is used only when the check has neither a category set explicitly on it nor one its producer declared.

Field	Type	Description
id	string	Client-supplied UUID identifying the rule.
dimension	CategoryDimension	The dimension this rule categorises along.
scope	RuleScope	Whether the rule belongs to the workspace or is a platform default.
title	string	Human-readable title, shown wherever the rule is credited for a category.
category	string	The category assigned to matching checks.
matcher	CheckMatcher	Which checks the rule applies to.
priority	int32	Rank within the rule’s scope: the highest number is tried first. Ties are broken as described above.
resolution_order	int32	Position of this rule in the order rules are tried for its dimension, counting from 0 across both scopes — 0 is the rule that gets first refusal on every check. Output-only, and recomputed whenever any rule in the dimension changes.
updated_by	Actor	Who last edited the rule: display name, and the account or channel they acted through. Absent on a platform-provided rule, which nobody in your workspace edited, and on a rule whose editor could not be resolved to anything a reader would recognise. Output-only.
etag	string	Optimistic-concurrency token: pass it back on UpsertRule or DeleteRule to have the write rejected if the rule changed in the meantime. Form: `W/"<id>-<version>"`.
created_at	Timestamp	When the rule was created. Output-only.
updated_at	Timestamp	When the rule was last updated. Output-only.

CheckSummary

(synq.entities.checks.v2.CheckSummary) Enough of a check to recognise it and act on it without a second call. Every field is output-only and reflects the check as the tool that produced it described it — a dbt test, a monitor, a reconciliation case. Nothing here is editable through the categorisation API; to change any of it, change it in the tool that publishes the check.

Field	Type	Description
name	string	Name of the check, as its producer names it. Always the last element of `full_name` when that is populated; kept as its own field so a client that only needs the label never has to index into an array.
full_name	repeated string	Full display path down to the check, root first and leaf last — suitable for rendering a breadcrumb as-is, the same order and meaning as `synq.entities.folders.v1.Folder.full_name`: `["prod", "analytics", "orders", "not_null_customer_id"]`.

The leading segments are the producer’s own containers — a dbt project, a warehouse database and schema — so how many there are varies by platform. Drop the last element for the path to the check’s parent. | | package | string | Package the check comes from, e.g. “dbt”, “dbt_utils”. Empty when the producer has no notion of packages. | | kind | string | General kind of the check, e.g. “not_null”, “unique”, “row_count”. This is the attribute categorisation rules most often match on. | | entity_type | EntityType | Entity type of the check itself, e.g. ENTITY_TYPE_DBT_TEST. | | data_platform_type | DataPlatformType | Platform the check runs on, e.g. DATA_PLATFORM_TYPE_DBT. | | is_platform_native | bool | Whether the check is native to its platform (a dbt test in a dbt project) rather than defined in Coalesce Quality. | | description | string | Description of the check, where the producer supplied one. | | checked_entity_ids | repeated string | The entities the check validates. Empty when the check’s targets could not be resolved. | | annotations | map AnnotationsEntry | Free-form key/value metadata the tool that produced the check attached to it — a dbt test’s meta entries, a SQLMesh audit’s, a custom label. This is what a categorisation rule’s annotation_matches predicate is written against, so reading them is how you find out what there is to match on in your own workspace. |

CheckSummary.AnnotationsEntry

(synq.entities.checks.v2.CheckSummary.AnnotationsEntry)

Field	Type	Description
key	string	none
value	string	none

BatchGetCheckCategoriesRequest

(synq.entities.checks.v2.BatchGetCheckCategoriesRequest)

Field	Type	Description
entity_ids	repeated string	Checks to read (1–500, unique).

BatchGetCheckCategoriesResponse

(synq.entities.checks.v2.BatchGetCheckCategoriesResponse)

Field	Type	Description
categories	map CategoriesEntry	Category state keyed by check id. Ids that do not exist are absent.

BatchGetCheckCategoriesResponse.CategoriesEntry

(synq.entities.checks.v2.BatchGetCheckCategoriesResponse.CategoriesEntry)

Field	Type	Description
key	string	none
value	CheckCategories	none

DeleteCheckCategoriesRequest

(synq.entities.checks.v2.DeleteCheckCategoriesRequest)

Field	Type	Description
categories	repeated CheckCategoryDeletion	The checks to clear. Every entry must name a distinct check.
oneof _actor.actor	optional Actor	Who is making the change. See UpsertCheckCategoriesRequest.actor.

DeleteCheckCategoriesResponse

(synq.entities.checks.v2.DeleteCheckCategoriesResponse)

ListCategoriesRequest

(synq.entities.checks.v2.ListCategoriesRequest)

Field	Type	Description
oneof _dimension.dimension	optional CategoryDimension	Restrict to one dimension. Omit to return both.

ListCategoriesResponse

(synq.entities.checks.v2.ListCategoriesResponse)

Field	Type	Description
categories	repeated CategoryInfo	Every category name in use, sorted by name within each dimension.
dimensions	repeated DimensionSummary	Coverage per dimension, so “N of M checks categorised” can be rendered without summing the entries above.

ListCategorisationFiltersRequest

(synq.entities.checks.v2.ListCategorisationFiltersRequest)

Field	Type	Description
selected	CategorisationFacets	The values already chosen, if any. Each returned list is narrowed to values that co-occur with this selection.

ListCategorisationFiltersResponse

(synq.entities.checks.v2.ListCategorisationFiltersResponse)

Field	Type	Description
available	CategorisationFacets	The values available given `selected`.

ListCheckCategoriesRequest

(synq.entities.checks.v2.ListCheckCategoriesRequest)

Field	Type	Description
technical_filter	CategorisationFilter	Keep only checks that are, or are not, categorised on the technical dimension.
governance_filter	CategorisationFilter	Keep only checks that are, or are not, categorised on the governance dimension.
technical_override_filter	OverrideFilter	Keep only checks whose technical category was, or was not, set explicitly.
governance_override_filter	OverrideFilter	Keep only checks whose governance category was, or was not, set explicitly.
rule_ids	repeated string	Keep only checks currently categorised by one of these rules, on either dimension. This is the paginated companion to ChecksCategorisationRulesService.ListRuleMatches, which reports exact counts and a sample per rule.
technical_categories	repeated string	Keep only checks whose effective technical category is one of these.
governance_categories	repeated string	Keep only checks whose effective governance category is one of these.
attributes	CategorisationFacets	Keep only checks with these attributes — the same platform / entity type / package / kind selection a categorisation rule matches on, so a listing can be narrowed to exactly the checks a candidate rule would consider.
entity_ids	repeated string	Keep only these checks. Combines with the other filters, so it answers “which of these checks are uncategorised” in a single call.
pagination	Pagination	Pagination. Defaults to 200 checks per page.

ListCheckCategoriesResponse

(synq.entities.checks.v2.ListCheckCategoriesResponse)

Field	Type	Description
categories	repeated CheckCategories	The matching checks, ordered by entity id.
page_info	PageInfo	Pagination cursor for the next page. Empty when this is the last page.

UpsertCheckCategoriesRequest

(synq.entities.checks.v2.UpsertCheckCategoriesRequest)

Field	Type	Description
categories	repeated CheckCategoryUpdate	The checks to categorise. Every entry must name a distinct check.
oneof _actor.actor	optional Actor	Who is making the change, when the caller acts on someone’s behalf — an agent, a bot, an automation. Recorded as the editor and shown back on reads. Omit it when the caller’s own credentials already identify them.

UpsertCheckCategoriesResponse

(synq.entities.checks.v2.UpsertCheckCategoriesResponse)

Field	Type	Description
categories	repeated CheckCategories	The resolved category state of each updated check, in request order.

RuleMatches

(synq.entities.checks.v2.RuleMatches) The checks one categorisation rule currently categorises — the state already applied to the workspace, not a projection of what a rule would do. The count is always exact. The sample is a readable excerpt, not the full set: to page through every check a rule categorised, call ListCheckCategories with the rule’s id.

Field	Type	Description
check_count	int64	How many checks the rule categorises in the workspace.
sample_entity_ids	repeated string	A sample of those checks, ordered by entity id.
sample_truncated	bool	True when the sample was cut short, meaning the rule categorises more checks than the sample shows.

AnnotationMatch

(synq.entities.checks.v2.AnnotationMatch) A condition on one annotation of a check. Annotations are the key/value metadata a producer attaches to a check — a dbt test’s meta entries, for example — which makes them the way to categorise by something only your own team knows, such as a domain or an owning squad.

Field	Type	Description
key	string	Annotation key to look up on the check.
oneof match.exists	bool	Matches when the key is present, whatever its value. Set it to true; a false value is not a negation and is rejected.
oneof match.equals	string	Matches when the value equals this string exactly.
oneof match.in	AnnotationValues	Matches when the value is one of these.
oneof match.regex	string	Matches when the value matches this RE2 regular expression.

AnnotationValues

(synq.entities.checks.v2.AnnotationValues) A list of accepted annotation values.

Field	Type	Description
values	repeated string	none

CheckAttributesMatcher

(synq.entities.checks.v2.CheckAttributesMatcher) Selects checks by their attributes. A check matches when every populated field matches it; an empty field places no constraint, so an entirely empty matcher matches every check in the workspace. This is the form to reach for first: it is what the rule editor writes, what reads back legibly, and what ListCategorisationFilters offers values for.

Field	Type	Description
facets	CategorisationFacets	Platform, entity type, package and kind the check must be one of.
names	repeated string	Patterns matched against the check’s name. `*` stands for any sequence of characters, including none; every other character matches literally. A check matches when at least one pattern matches. An empty list matches any name.
annotation_matches	repeated AnnotationMatch	Conditions on the check’s annotations. A check must satisfy every entry.

CheckMatcher

(synq.entities.checks.v2.CheckMatcher) Which checks a categorisation rule applies to.

Field	Type	Description
oneof matcher.attributes	CheckAttributesMatcher	Select checks by their attributes. Covers almost every rule and is the only form the rule editor can render.
oneof matcher.expression	string	A CEL expression returning a boolean, for the rare predicate the attribute matcher cannot express — combining alternatives across dimensions, or matching on a substring of a name. See https://github.com/google/cel-spec for the language.

Variables available to the expression: platform, asset_type, package, kind, name, description (string) is_platform_native (bool) annotations (map<string, string>) Platform and entity-type enum value names are available as string constants. For example: platform == PLATFORM_DBT && kind.startsWith(“not_null”) |

RecategorisationStatus

(synq.entities.checks.v2.RecategorisationStatus) Progress of the workspace-wide re-categorisation that follows a rule change. A rule change takes effect on newly ingested checks immediately. Checks that already exist are rewritten by a sweep, scheduled automatically whenever rules are created, updated or deleted; several edits in quick succession coalesce into one sweep. The sweep normally completes in seconds, so reading this is about confirming a change landed rather than waiting on it — until it finishes, some checks still carry the categories the previous rules gave them.

Field	Type	Description
state	State	Current state of the sweep.
oneof _scheduled_at.scheduled_at	optional Timestamp	When the pending sweep was queued.
oneof _started_at.started_at	optional Timestamp	When the current or most recent sweep started.
oneof _finished_at.finished_at	optional Timestamp	When the most recent sweep finished.
scanned_count	int64	Checks examined by the current or most recent sweep.
rewritten_count	int64	Checks whose categorisation actually changed in that sweep.
oneof _last_error.last_error	optional string	Populated when the most recent sweep failed. The next rule change schedules a fresh sweep.

CategorisationFacets

(synq.entities.checks.v2.CategorisationFacets) A set of check attributes. The same four dimensions select checks in three places — the predicate of a categorisation rule, the filter on a check listing, and the values a workspace actually has — so one message carries them everywhere and a value read from one can be passed straight to the next. An empty list places no constraint on its dimension. Within a list the values are alternatives; across lists they combine.

Field	Type	Description
data_platform_types	repeated DataPlatformType	Platforms the check runs on.
entity_types	repeated EntityType	Entity types of the check itself, e.g. ENTITY_TYPE_DBT_TEST.
packages	repeated string	Packages the check comes from, e.g. “dbt_utils”.
kinds	repeated string	Check kinds, e.g. “not_null”, “unique”.

CategoryInfo

(synq.entities.checks.v2.CategoryInfo) One category name in a workspace’s vocabulary, with how it is produced and how much of the workspace currently carries it. Category names are free-form workspace strings, not a fixed list. Offering this vocabulary in a picker rather than a text box is what keeps a workspace converging on one spelling per concept.

Field	Type	Description
name	string	The category name.
dimension	CategoryDimension	The dimension the name belongs to. The same name can exist on both dimensions; they are separate entries.
has_workspace_rule	bool	At least one rule in the caller’s workspace produces this category.
has_global_rule	bool	At least one platform-provided rule produces this category.
check_count	int64	How many checks currently resolve to this category on this dimension, whatever produced it. A name can have rules and no checks (nothing matches yet), or checks and no rules (every one of them was categorised explicitly or by its producer).

DimensionSummary

(synq.entities.checks.v2.DimensionSummary) How much of a workspace one dimension covers.

Field	Type	Description
dimension	CategoryDimension	The dimension summarised.
categorised_check_count	int64	Checks in the workspace with a category on this dimension.
uncategorised_check_count	int64	Checks in the workspace with no category on this dimension. This is the number to drive down.

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
unavailable_sources	repeated CodeSourceError	Sources that could not be read while assembling this response. Empty on a complete response, which is the normal case.

Code is composed from several independent sources, so one of them being briefly unavailable degrades the response rather than failing it: the codes that were read are returned, and the source that was not is named here. Retry to pick up what is missing. An empty codes always means the entity has no code, never that a source was unavailable — a request that could read nothing at all returns an error rather than an empty response, because the two are otherwise indistinguishable. |

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

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

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	Short label for the custom entity type, shown beside the type’s icon, in type filters, and on the type badge of every entity of this type.

It is the only name a custom type has, so keep it short enough to read as a caption rather than a description — “Kafka Topic”, not a sentence. | | 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). |

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. Every identifier the API RETURNS also carries entity_id, the entity’s opaque id. Read it when you just need to name the entity again — it is one string for every platform, where the structured variants below only cover the platforms that have one.

Field	Type	Description
entity_id	string	Opaque id of the entity, set on every identifier the API returns. Round-trip it verbatim; the format is not part of this contract and may change, and it is never constructed by hand.

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

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
definer_platform	DataPlatformType	Data platform of the entity that defines this code — dbt, SQLMesh, Snowflake, and so on. `definer_entity_type` says what kind of thing defines the code; this says which tool it belongs to.

Use it to order the code an entity has when it has more than one piece: a warehouse table modelled by a transformation framework carries both the framework’s source and the warehouse’s own DDL, and the framework source is what a reader normally wants first. | | has_execution_error | bool | True when the definer failed to produce this code the last time it ran — a model that did not compile, a routine whose body could not be read. The content is then the last body that was captured, which may be stale or empty; execution_error says what went wrong. | | execution_error | string | Message describing the failure has_execution_error reports. Empty when there is no failure, and may also be empty when the producer recorded a failure without a message. | | is_truncated | bool | True when content holds only the first part of the file. Files above the ingestion size cap are stored as a prefix, and a client showing this code should say so rather than presenting the prefix as the whole body. original_size_bytes gives the untruncated size. | | original_size_bytes | uint64 | Size in bytes of the code before any truncation. Read it together with is_truncated, which is what makes it meaningful: where content was cut, this is the size of the whole body, and a truncated body always has one. Zero where nothing measured the source, which is the normal case for code that is not read from a file and never happens for a truncated body. |

CodeSourceError

(synq.entities.v1.CodeSourceError) CodeSourceError reports one source that could not be read while the rest of the response was assembled. That source’s code is missing or incomplete in codes; every other source in the response is complete. Retry the same request to pick the missing source up — these are transient by nature. A request in which every source failed returns an error instead.

Field	Type	Description
source	CodeSource	Which source was unavailable.
message	string	Human-readable reason, for logging and for telling a reader why part of the code is missing. Not a stable string; do not branch on it.

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. Set it to the name the entity is known by in the system it comes from, rather than shortening it to fit — the limit is set wide enough to carry a generated name whole.
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

FolderRef

(synq.entities.v1.FolderRef) FolderRef is the human-friendly, structured address of a folder: the entity it hangs under (root_entity_id) plus the ordered folder names from that root down to the folder (folders). It is the stable way to name a folder across responses. Prefer it over the opaque folder entity id when you want to log, display, or reconstruct a location — the segments are the same names a user sees in the catalog, and they survive changes to the underlying id encoding. A FolderRef with an empty folders list names the root entity itself (a top-level integration or container the hierarchy hangs from). This type lives in synq.entities.v1 (rather than a folder-specific package) so it can be shared by both the folders navigation API and the query API without an import cycle.

Field	Type	Description
root_entity_id	string	Opaque id of the entity the folder hierarchy hangs under — an integration root or container (for example a warehouse instance, a database, or a transformation project). Take it verbatim from `FolderRef.root_entity_id` of a folder you already read, or from an entity id returned elsewhere.
folders	repeated string	Ordered folder names from the root down to this folder (root first, leaf last), for example [“staging”, “sales”]. Empty means the ref points at the root entity itself. Folder names are kept as separate segments (not joined with ”/”) because some platforms allow ”/” inside a single folder name.

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).

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

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.

A value is something entities are filtered and searched by, not free-form metadata, so keep it to a label a person would pick out of a list. The limit is set to hold an identifier or a link the annotated system generated — truncating one of those produces a value that no longer resolves, and no longer matches the filter it exists for. Put prose in the entity description instead. |

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.

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. See ColumnRemovalChangeType.column_id.
native_type	string	Data type of the new column.
ordinal_position	int32	Position where the column was added in the schema.
human_name	string	Name of the column as it appears in the source system. See ColumnRemovalChangeType.human_name.

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. See ColumnRemovalChangeType.column_id.
previous_native_type	string	Previous data type of the column.
current_native_type	string	New data type of the column.
human_name	string	Name of the column as it appears in the source system. See ColumnRemovalChangeType.human_name.
ordinal_position	int32	Position of the changed column in the current version of the schema.

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. Normalized to lower case with special characters stripped, so several columns of one schema can share it.
native_type	string	Native data type of the removed column.
ordinal_position	int32	Original position of the column in the schema.
human_name	string	Name of the column as it appears in the source system, which is what distinguishes two columns sharing a column_id. Empty when the source system reported no distinct name, and on changes recorded before this field existed.

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.

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. Every requested path is present; a path with no SQL details has an empty set of constructs.

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 reports how many of the workspace’s entities use each SQL construct.

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).

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

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.

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.

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.

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.

BatchGetEntityAnnotationsRequest

(synq.entities.annotations.v1.BatchGetEntityAnnotationsRequest) BatchGetEntityAnnotationsRequest is the request message for the BatchGetEntityAnnotations method.

Field	Type	Description
ids	repeated Identifier	The entities to read annotations for. Each entry is validated by Identifier’s own rules — its `id` oneof is `required`, and protovalidate recurses into the elements of a repeated message field — so an identifier naming nothing is refused here. There is no per-item `required` to add beside it: `repeated.items.required` is unenforceable and buf lint rejects it, and it would have nothing to catch, because an entry on the wire is always a message rather than a null.

BatchGetEntityAnnotationsResponse

(synq.entities.annotations.v1.BatchGetEntityAnnotationsResponse) BatchGetEntityAnnotationsResponse is the response message for the BatchGetEntityAnnotations method.

Field	Type	Description
entity_annotations	repeated EntityAnnotations	One entry per requested entity that carries any annotation. An entity with none is omitted rather than returned empty, so the response says which of the requested entities are annotated at all.

EntityAnnotations

(synq.entities.annotations.v1.EntityAnnotations) EntityAnnotations is the annotations one entity carries.

Field	Type	Description
id	Identifier	The entity, echoed back in the spelling it was requested in.
annotations	repeated Annotation	Annotations the entity carries, one entry per name, ordered by name.

Read over the entity’s whole identity group rather than the one id asked for: a dbt model, the warehouse table it builds and a catalog entity virtualising the same table are one entity to a reader, and which of them an annotation was published against is a property of the producer, not of the thing being annotated. |

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.

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.

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

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)

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)

Field	Type	Description
oneof _pagination.pagination	optional Pagination	Pagination. Omitting this, or sending a zero page_size, returns every group in one response — there is no server-side default page size. A group carries every one of its member identifiers, so a workspace with large groups is worth paging even though the group count is small. Pass page_info.last_id from the previous response as the cursor to fetch the next page.

ListEntityGroupsResponse

(synq.entities.custom.v1.ListEntityGroupsResponse)

Field	Type	Description
entities_groups	repeated Group	none
page_info	PageInfo	Paging information for this response. Always populated. Repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty to walk the whole workspace.

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

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)

Field	Type	Description
oneof _pagination.pagination	optional Pagination	Pagination. Omitting this, or sending a zero page_size, returns every entity in one response — there is no server-side default page size. Set page_size to bound the response; pass page_info.last_id from the previous response as the cursor to fetch the next page.

ListEntitiesResponse

(synq.entities.custom.v1.ListEntitiesResponse)

Field	Type	Description
entities	repeated Entity	none
page_info	PageInfo	Paging information for this response. Always populated. Repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty to walk the whole workspace.

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.

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)

Field	Type	Description
oneof _pagination.pagination	optional Pagination	Pagination. Omitting this, or sending a zero page_size, returns every type in one response — there is no server-side default page size. Set page_size to bound the response; pass page_info.last_id from the previous response as the cursor to fetch the next page.

ListTypesResponse

(synq.entities.custom.v1.ListTypesResponse)

Field	Type	Description
types	repeated Type	List of entities.
page_info	PageInfo	Paging information for this response. Always populated. Repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty to walk the whole workspace.

UpsertTypeRequest

(synq.entities.custom.v1.UpsertTypeRequest)

Field	Type	Description
type	Type	Entity to create or update.

UpsertTypeResponse

(synq.entities.custom.v1.UpsertTypeResponse)

DeleteRelationshipsRequest

(synq.entities.custom.v1.DeleteRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

DeleteRelationshipsResponse

(synq.entities.custom.v1.DeleteRelationshipsResponse)

Field	Type	Description
results	repeated RelationshipWriteResult	One result per relationship in the request, in request order.

ListRelationshipsRequest

(synq.entities.custom.v1.ListRelationshipsRequest)

Field	Type	Description
ids	repeated Identifier	Return relationships for the given entity_id. Either upstream or downstream. Leave empty to return every relationship in the workspace: an edge hangs off endpoints a caller may not know up front, so enumerating them by id requires already knowing every entity an edge can touch.
oneof _pagination.pagination	optional Pagination	Pagination. Omitting this, or sending a zero page_size, returns every matching relationship in one response — there is no server-side default page size. Set page_size to bound the response; pass page_info.last_id from the previous response as the cursor to fetch the next page.

ListRelationshipsResponse

(synq.entities.custom.v1.ListRelationshipsResponse)

Field	Type	Description
relationships	repeated Relationship	none
page_info	PageInfo	Paging information for this response. Always populated. Repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty to walk the whole result set.

Relationship

(synq.entities.custom.v1.Relationship)

Field	Type	Description
upstream	Identifier	none
downstream	Identifier	none

RelationshipWriteResult

(synq.entities.custom.v1.RelationshipWriteResult) RelationshipWriteResult reports what one requested relationship did to the stored graph.

Field	Type	Description
relationship	Relationship	The relationship this result answers for, as sent, with `entity_id` filled in on both endpoints.

An edge is held between the two entities the endpoints resolve to, not between the identifiers as written, and one entity accepts several spellings — a warehouse name that differs only in case or punctuation usually names the same table. So compare these two ids, rather than the identifiers you sent, to tell whether two relationships are the same edge. | | outcome | RelationshipWriteOutcome | What the write did to that edge. |

UpsertRelationshipsRequest

(synq.entities.custom.v1.UpsertRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

UpsertRelationshipsResponse

(synq.entities.custom.v1.UpsertRelationshipsResponse)

Field	Type	Description
results	repeated RelationshipWriteResult	One result per relationship in the request, in request order.

CheckRelationship

(synq.entities.custom.v1.CheckRelationship)

Field	Type	Description
check	Identifier	none
checked	Identifier	none
checked_columns	repeated string	none

CheckRelationshipWriteResult

(synq.entities.custom.v1.CheckRelationshipWriteResult) CheckRelationshipWriteResult reports what one requested check relationship did to the stored graph.

Field	Type	Description
check_relationship	CheckRelationship	The check relationship this result answers for, as sent, with `entity_id` filled in on both endpoints.

The pair of entities the endpoints resolve to is what the relationship is held under, so compare these two ids rather than the identifiers you sent to tell whether two of them are the same relationship. checked_columns is part of the payload, not of that pair: restating the same pair with a different column list replaces the stored one. | | outcome | RelationshipWriteOutcome | What the write did to that relationship. |

DeleteCheckRelationshipsRequest

(synq.entities.custom.v1.DeleteCheckRelationshipsRequest)

Field	Type	Description
check_relationships	repeated CheckRelationship	none

DeleteCheckRelationshipsResponse

(synq.entities.custom.v1.DeleteCheckRelationshipsResponse)

Field	Type	Description
results	repeated CheckRelationshipWriteResult	One result per check relationship in the request, in request order.

ListCheckRelationshipsRequest

(synq.entities.custom.v1.ListCheckRelationshipsRequest)

Field	Type	Description
oneof _pagination.pagination	optional Pagination	Pagination. Omitting this, or sending a zero page_size, returns every check relationship in one response — there is no server-side default page size. Set page_size to bound the response; pass page_info.last_id from the previous response as the cursor to fetch the next page.

ListCheckRelationshipsResponse

(synq.entities.custom.v1.ListCheckRelationshipsResponse)

Field	Type	Description
check_relationships	repeated CheckRelationship	none
page_info	PageInfo	Paging information for this response. Always populated. Repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty to walk the whole workspace.

UpsertCheckRelationshipsRequest

(synq.entities.custom.v1.UpsertCheckRelationshipsRequest)

Field	Type	Description
check_relationships	repeated CheckRelationship	none

UpsertCheckRelationshipsResponse

(synq.entities.custom.v1.UpsertCheckRelationshipsResponse)

Field	Type	Description
results	repeated CheckRelationshipWriteResult	One result per check relationship in the request, in request order.

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.
oneof feature.column_lineage	ColumnLineage	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. Leave unset to list the features of every custom entity in the workspace.
oneof _pagination.pagination	optional Pagination	Pagination. Omitting this, or sending a zero page_size, returns every matching feature in one response — there is no server-side default page size. Set page_size to bound the response; pass page_info.last_id from the previous response as the cursor to fetch the next page.

ListEntityFeaturesResponse

(synq.entities.custom.v1.ListEntityFeaturesResponse)

Field	Type	Description
features	repeated Feature	List of features for the entity.
page_info	PageInfo	Paging information for this response. Always populated. Repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty to walk the whole result set.

UpsertEntityFeatureRequest

(synq.entities.custom.v1.UpsertEntityFeatureRequest)

Field	Type	Description
feature	Feature	The feature to create or update.

UpsertEntityFeatureResponse

(synq.entities.custom.v1.UpsertEntityFeatureResponse)

ColumnEdge

(synq.entities.custom.features.v1.ColumnEdge) ColumnEdge is one column of one upstream entity feeding one column of the entity this feature belongs to.

Field	Type	Description
upstream	Identifier	The entity the data comes from. Any entity: another custom entity, or a table, model or dashboard from a connected platform. An upstream that does not exist yet is remembered and the edge appears once it does.
upstream_column	string	Column of the upstream entity the data comes from.
column	string	Column of this entity the data flows into.

ColumnLineage

(synq.entities.custom.features.v1.ColumnLineage) ColumnLineage declares column-level lineage flowing INTO a custom entity, for the cases SQL cannot express: an upstream that is itself a custom entity, or a component whose transformation is not written in SQL at all. Use it when SqlDefinition does not fit — when there is no SQL to give at all, or when you would rather state the result than have it derived. A component whose transformation is written in Python, or a hand-maintained mapping, has no SQL for a parser to read. If the component DOES have SQL, prefer SqlDefinition: a name in it that is not a database object — another custom entity, a queue, a service — is bound to the entity it stands for with SqlDefinition.references, and the column lineage is then derived from the SQL and stays correct as the SQL changes. The declaration is complete and replaces the previous one whole: an edge missing from a write is withdrawn, and deleting the feature withdraws all of them. Only one ColumnLineage feature is allowed per entity, so re-writing it under the same feature_id is how it is edited. Declaring a column edge also declares the table-level edge it implies, so the entity appears downstream of each upstream named here whether or not a Relationship says so too. Column lineage is only ever shown along a table-level edge, which is why the two travel together. An entity that has BOTH this feature and a SqlDefinition is served from this declaration in the SQL-lineage view — an explicit statement takes precedence over lineage derived from SQL. Declare column lineage here only for what the SQL cannot say, or state the entity’s whole column lineage here and treat this as the authority for it.

Field	Type	Description
state_at	Timestamp	Time when this lineage was declared, will default to `now` if not set. A later declaration replaces an earlier one, so an explicit time is how a backfill avoids overwriting a fresher declaration.
edges	repeated ColumnEdge	Column-level edges into this entity. Every edge names one upstream entity and one column on each side.

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.

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.

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 technical category of the check — what kind of check this is, mechanically (e.g. “nullness”, “uniqueness”, “freshness”), so the same check expressed on another platform shares one category.

Presence is meaningful on update: omit the field to leave the current value untouched, send an empty string to clear it, send a non-empty string to set or replace it. Leaving it unset means the check is uncategorised for this dimension and the workspace’s categorisation rules decide it from package + kind; the quality.check_category annotation on the entity is read as the lower-precedence fallback. | | oneof _governance_category.governance_category | optional string | Explicit governance category of the check — what the check is for, the data-quality dimension a governance function tracks coverage against (e.g. “Completeness”, “Accuracy”, “Timeliness”). Resolves independently of category and follows the same presence semantics: omitted leaves it unchanged, empty clears it, non-empty sets it. Unset means uncategorised for this dimension; the quality.governance_category annotation on the entity is the lower-precedence fallback. |

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.
references	repeated SqlTableReference	Names in this SQL that are not database objects, each bound to the entity it stands for. A reference the SQL makes to one of these names resolves to that entity instead of being looked up in the database and dropped.

Use it for the upstreams and downstreams a database cannot address: another custom entity, a queue, a service, an API. A name that IS a database object needs no binding — it resolves on its own. The bindings are part of the definition and replace with it: a binding dropped from a later write is gone, and the lineage it produced is withdrawn. |

SqlTableReference

(synq.entities.custom.features.v1.SqlTableReference) SqlTableReference binds one name, as the SQL writes it, to the entity that name stands for.

Field	Type	Description
instance_name	string	The name as the SQL writes it. Matched case-insensitively; a part left empty defaults from the definition’s `database_context`, exactly as an unqualified table reference in the SQL does. So a binding of just `object_name: "orders_topic"` under a definition whose database is `kafka` matches both `FROM kafka.orders_topic` and `FROM orders_topic`.
database_name	string	none
schema_name	string	none
object_name	string	none
entity	Identifier	The entity this name stands for. Any entity: another custom entity, or a table, model or dashboard from a connected platform. An entity that does not exist yet is remembered and the edge appears once it does.

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

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)

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.

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.

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)

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
oneof _verified.verified	optional bool	True when the mapping was established by the user proving ownership of the Slack account through “Sign in with Slack” (OIDC), rather than being self-asserted. Server-set only — never trusted from client input. Empty (unset/false) means the mapping is self-asserted.
oneof _team_id.team_id	optional string	Slack workspace/team the user_id belongs to. Set when the mapping was established via sign-in (a Slack user_id is only unique within a team). Empty for self-asserted mappings.
oneof _linked_via.linked_via	optional string	How the mapping was established: “manual” (self-asserted selection) or “slack_oauth” (verified sign-in). Empty is treated as “manual”.

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

BatchGetEntityOverlaysRequest

(synq.overlays.v1.BatchGetEntityOverlaysRequest)

Field	Type	Description
entity_ids	repeated string	The entities to ask about: 1 to 1000 ids, no duplicates.

An entity_id is opaque. Take one from any listing or search response, or from synq.entities.resolve.v1.IdentifierResolveService if what you hold is a warehouse table name or a model name, and pass it back unchanged. Do not build one yourself or parse one apart — the format carries no meaning you can rely on and is not part of this contract. |

BatchGetEntityOverlaysResponse

(synq.overlays.v1.BatchGetEntityOverlaysResponse)

Field	Type	Description
entities	repeated EntityOverlays	One entry per requested entity, in the order they were requested.

BatchGetOverlayMemberCountsRequest

(synq.overlays.v1.BatchGetOverlayMemberCountsRequest)

Field	Type	Description
overlay_entity_ids	repeated string	The overlays to count: 1 to 1000 ids, no duplicates.

Opaque ids, as returned by BatchGetEntityOverlays or by the listing calls of the service that defines the overlay. Data products and owners may be mixed freely in one request. |

BatchGetOverlayMemberCountsResponse

(synq.overlays.v1.BatchGetOverlayMemberCountsResponse)

Field	Type	Description
overlays	repeated OverlayMemberCount	One entry per requested overlay, in the order they were requested.

CoverageSelection

(synq.overlays.v1.CoverageSelection) CoverageSelection names the assets a coverage question is asked about. It is a candidate set, not a filter on overlays: nothing outside it is considered, and an asset inside it is reported whether anything claims it or not. with_type("dbt_model") asks about your models, in_folder(...) asks about one part of the warehouse, and an empty candidate set is a valid question with the answer zero. Choose the candidate types deliberately — it is the difference between a useful answer and an unreadable one. The two dimensions want different sets. Data products group the things you monitor, so a product-coverage question usually asks about tables, views and models; left unrestricted the answer is mostly monitors, tests and recon cases, which belong to no product by design and bury the assets you were looking for. Owner coverage is the opposite: a check very often should have someone responsible for it, so include those types when asking about owners. So a governance audit is normally several narrow selections rather than one broad one — which is also what GetCoverageSummary takes, one per bucket. A selection resolving to more than 100,000 assets is rejected with INVALID_ARGUMENT naming the limit; narrow it and ask again.

Field	Type	Description
oneof selection.resolver_ql	string	The candidate query in resolver query language. The fuller of the two forms — everything the structured query expresses is expressible here, and several filters are only expressible here.
oneof selection.public_query	Query	The candidate query in structured form, as the filter builder produces it. Use `resolver_ql` for anything it cannot express.

CoverageSummary

(synq.overlays.v1.CoverageSummary) CoverageSummary is one selection’s totals. The counts overlap rather than partition: an asset in a product and with an owner is in with_dataproduct, in with_owner and in with_both. Only with_neither is disjoint from the rest. So the uncovered counts are total - with_dataproduct and total - with_owner, and “in a product but unowned” is with_dataproduct - with_both.

Field	Type	Description
key	string	The key of the selection this row answers for, echoed back.
total	int64	Candidates in the selection.
with_dataproduct	int64	Candidates in at least one data product.
with_owner	int64	Candidates with at least one owner.
with_both	int64	Candidates in at least one data product and with at least one owner.
with_neither	int64	Candidates nothing claims — the gap a coverage audit is looking for.

EntityOverlays

(synq.overlays.v1.EntityOverlays) EntityOverlays is one entity and the overlays claiming it, one list per kind. Kinds are separate lists rather than one tagged list because what you can do with an id depends on its kind: an owner id reads through the owners service, a data-product id through the data-products service.

Field	Type	Description
entity_id	string	The entity this entry answers for, echoed back from the request.
owner_entity_ids	repeated string	Owners responsible for this entity — the parties an alert about it reaches. Read their names and contact channels with `synq.owners.v1.OwnersService`.

Empty when no owner claims the entity, and also when your credential may not read owners. Order is not significant and may change between calls; sort if you display them. | | dataproduct_entity_ids | repeated string | Data products this entity belongs to. Read their names and definitions with synq.dataproducts.v2.DataproductsService. Empty when the entity is in no data product, and also when your credential may not read data products. Order is not significant and may change between calls; sort if you display them. |

GetCoverageSummaryRequest

(synq.overlays.v1.GetCoverageSummaryRequest)

Field	Type	Description
selections	repeated NamedSelection	The candidate sets to count: 1 to 20, with distinct keys.
freshness	Freshness	Where the answer is computed from. Defaults to the recomputed membership.

FRESHNESS_LIVE re-resolves every definition once for the whole request, not once per selection, so several selections cost little more than one. |

GetCoverageSummaryResponse

(synq.overlays.v1.GetCoverageSummaryResponse)

Field	Type	Description
summaries	repeated CoverageSummary	One entry per requested selection, in the order they were requested.
oneof _members_computed_at.members_computed_at	optional Timestamp	When the recomputation behind these totals last ran to completion — the start of the most recent successful pass over the workspace’s overlays.

Absent under FRESHNESS_LIVE, and absent when the workspace has no overlay of a readable kind, or none has been computed yet. |

ListEntityCoverageRequest

(synq.overlays.v1.ListEntityCoverageRequest)

Field	Type	Description
selection	CoverageSelection	The assets to report on. Required.
filter	CoverageFilter	Which coverage state to keep. Defaults to all candidates.

ListEntityCoverageResponse

(synq.overlays.v1.ListEntityCoverageResponse)

Field	Type	Description
entities	repeated EntityOverlays	One page of matching candidates, each with the overlays claiming it.

The same message BatchGetEntityOverlays returns: a row under COVERAGE_FILTER_WITHOUT_DATAPRODUCT has an empty dataproduct_entity_ids and may still name owners, which is how “owned but in no product” reads without a second call. | | total_count | int64 | How many candidates match filter across every page. Independent of pagination — the number to show beside a list, not the length of it. | | page_info | PageInfo | Pagination cursor for the next page. | | rendered_resolver_ql | string | The candidate selection rendered back to canonical resolver query language, whichever form it was sent in. Useful to log what was actually asked, and to lift a query built with the structured form into one you can hand-edit. Empty when the selection has no resolver-QL representation; the answer is unaffected. | | oneof _members_computed_at.members_computed_at | optional Timestamp | When the recomputation behind this answer last ran to completion — the start of the most recent successful pass over the workspace’s overlays. Every overlay is recomputed on each pass, so this is the age of the whole answer rather than of any one overlay in it. This is the number to alert on: it stops advancing as soon as the recomputation stops succeeding, whether or not any membership has changed. Absent under FRESHNESS_LIVE (nothing was read from an index), and absent when no overlay of a readable kind exists in the workspace, or none has been computed yet (there is no membership to be stale). |

NamedSelection

(synq.overlays.v1.NamedSelection) NamedSelection is one candidate set and the label you want its row keyed by.

Field	Type	Description
key	string	Your own label for this selection, echoed back on the matching summary. It is never interpreted — use whatever names the bucket in your dashboard. Must be unique within the request.
selection	CoverageSelection	The assets this row counts. Required.

OverlayMemberCount

(synq.overlays.v1.OverlayMemberCount)

Field	Type	Description
overlay_entity_id	string	The overlay this entry answers for, echoed back from the request.
member_count	int64	How many distinct entities belong to it.

Zero covers every case where there is nothing to count: an overlay with no members, an id that does not exist, and an id your credential may not read. If you need to tell those apart, read the overlay itself through the service that defines it. |

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).”

HistoryRequest

(synq.monitors.history.v1.HistoryRequest)

Field	Type	Description
monitor_path	string	Monitor synq path (e.g. monitor::integration::db::schema::table::volume). REST clients pass this as the `monitorPath` query parameter.
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

MonitorInfoRequest

(synq.monitors.info.v1.MonitorInfoRequest)

Field	Type	Description
id	Identifier	Identifier of the monitor, or of a monitor-like entity such as a dbt test or a SQL test. Its `synq_path` spelling also accepts a custom monitor’s own id, in either of the forms `monitor_id` takes.
oneof _monitor_id.monitor_id	optional string	Id of a custom monitor, as `synq.monitors.custom_monitors.v1.ListMonitors` returns it and `BatchUpdateMonitor` takes it. Accepts the bare UUID or the `custom-<uuid>` form. An alternative to `id` rather than an addition to it: setting both is an error.

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.
oneof _description.description	optional string	Human-provided description of what this monitor checks. Unset for monitor types that don’t carry one.
oneof _sql_source.sql_source	optional string	SQL query used as the data source instead of querying the monitored table or view directly, when the monitor is configured with one.
oneof _deleted_at.deleted_at	optional Timestamp	When set, the monitor has been deleted: it no longer runs, no longer reports metrics, and is excluded from every listing. The record is still served by id so a stored or stale identifier resolves to something, which makes this the only signal that the monitor is gone. Unset for a live monitor.

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

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.

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 to read. Accepts the monitor’s synq_path, the `::seg-<value>` synq_path of one of its segments, or — for a custom monitor — its own id as `synq.monitors.custom_monitors.v1.ListMonitors` returns it: the bare UUID or the `custom-<uuid>` form.
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

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)

Field	Type	Description
overview	MonitorsDeploymentOverview	What the deploy did: the monitors it created, removed and left in place, the surviving monitors whose settings it changed, and the assets it skipped.

Computed inside this call, before the write, from the same overview the deploy acted on — so unlike an overview a caller fetches for itself, no decision window separates it from what happened. Optional and additive: an older server leaves it unset, and a caller must then answer from what it knew before the call rather than treat the absence as an error. |

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)

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.entity_ids	EntityIds	Deploy monitors on specific entities, named by the ids the API returned for them. Read back as `identifier_list`, with each id on the identifier it names.
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
overlapping_rule_ids	repeated string	Deployment rules OTHER than the one this overview is for that also govern the assets it leaves monitored (the ones in active_monitors_for / active_custom_monitors_for). Exact and complete: it is read off the same rule/asset rows the overview itself is computed from, so no per-asset lookup can improve on it. Empty when no other rule covers those assets — and note that a rule whose contribution is shadowed instead (SkippedAsset.reason SKIPPED_HIGHER_PRIORITY_RULE) is not here; those assets are not left monitored by this rule at all.

Ids only. Read their titles, owners and types with ListDeploymentRules(rule_ids). |

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	Config ID this rule was authored from, when deployed via configuration as code. Unset for rules authored directly through this API.

On a write this field is only ever set, never unset: omitting it keeps the stored value, so a full-replace update cannot detach the rule from the config that owns it. An empty string is a real config id — the one a deploy that declares no namespace uses — so sending it attaches the rule to that config rather than clearing the field. No value detaches a rule; recreating it is the only way to hand it back to the app. |

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
delay_model	DelayModel	How the delay and volume_change_delay metrics model the expected arrival time of new data. Unset leaves the stored value unchanged.

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.
delay_model	DelayModel	How the delay and volume_change_delay metrics model the expected arrival time of new data. Unset leaves the stored value unchanged.

SkippedAsset

(synq.monitors.automated_monitors.v1.SkippedAsset)

Field	Type	Description
asset_path	string	none
reason	string	Why the asset was skipped, as a stable SCREAMING_SNAKE token. Clients branch on these, so treat the spellings as part of this API: adding a value is safe, renaming one is a breaking change. A value not listed here may appear — a client must fall through to “skipped, reason unrecognised” rather than assume the set is closed.

SKIPPED_HIGHER_PRIORITY_RULE another rule of higher precedence governs the asset, so this rule’s settings never reach it (see rule precedence) SKIPPED_NO_FRESHNESS_COLUMN_MATCH no column matched the freshness field SKIPPED_NO_FRESHNESS_FIELD_PATTERN no freshness field pattern is configured SKIPPED_NO_INTEGRATION the asset’s integration is gone SKIPPED_TEST_PREPARATION_FAILED the test could not be prepared SKIPPED_TEST_OWNED_BY_OTHER_RULE another rule already deploys that test A string rather than an enum for compatibility: an enum would have to be introduced as a second field, since the producers already write these tokens. | | reason_code | SkipReason | Machine-checkable form of reason, so a client can branch on a value the compiler knows instead of string-matching a wire constant. reason remains authoritative and keeps being written unchanged; reason_code is SKIP_REASON_UNSPECIFIED for a reason this field does not yet cover — fall through to “skipped, reason unrecognised” rather than treat that as impossible, since the set of reasons is expected to grow. |

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
delay_model	DelayModel	How the delay and volume_change_delay metrics model the expected arrival time of new data. Unset leaves the stored value unchanged.

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	How the monitored data is split into time segments. When omitted, the monitor takes one whole-data snapshot per scheduled run instead of segmenting by time (and gets no historical backfill on its first run). Must be omitted for table_stats monitors.
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	Config ID this monitor was authored from, when deployed via configuration as code. Unset for monitors authored directly through this API.

On a write this field is only ever set, never unset: omitting it keeps the stored value, so a full-replace update cannot detach the monitor from the config that owns it. An empty string is a real config id — the one a deploy that declares no namespace uses — so sending it attaches the monitor to that config rather than clearing the field. No value detaches a monitor; recreating it is the only way to hand it back to the app. | | 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. | | oneof _category.category | optional string | Technical category this monitor declares for itself — what kind of check it is mechanically (e.g. “volume”, “freshness”). It is the monitor’s own declaration, not an administrative override: it is authoritative over any categorisation rule the workspace would otherwise apply, and is itself overridden by an explicit per-check category an admin sets. The value is free-form and workspace-defined — whatever vocabulary your categorisation rules already use. It is displayed with underscores turned into spaces, so snake_case reads well. Send the whole monitor on every upsert: leaving this out is the same as sending it empty, and both mean the monitor declares no technical category. A monitor then falls back to its quality.check_category annotation, which remains accepted and keeps working — this field simply outranks it. A segmented monitor’s segments take this value too. A segment is the same monitor sliced by a column value, so it cannot declare a category of its own. | | oneof _governance_category.governance_category | optional string | Governance category this monitor declares for itself — what the check is for, the data quality dimension governance reports on (e.g. “timeliness”). Resolves independently of category — setting one never suppresses the other — and follows the same precedence, the same free-form vocabulary and the same full-state upsert rule described above. Its annotation fallback is quality.governance_category. | | oneof _deleted_at.deleted_at | optional Timestamp | When the monitor was deleted. Unset while it is live, which is every monitor an ordinary listing reports; a deleted one comes back only from a listing that asked for it. Read-only, and ignored on writes. |

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.
delay_model	DelayModel	How the delay and volume_change_delay metrics model the expected arrival time of new data. Unset leaves the stored value unchanged.

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 whenever time_partitioning is set. To monitor without time segmentation, omit the whole time_partitioning message rather than sending an empty expression.
interval	Duration	Length of one time segment. Optional: defaults to the interval implied by the schedule (24h for daily, 1h for hourly) and must equal it when set. On-demand monitors have no schedule interval to inherit, so they must set it explicitly whenever time_partitioning is set.

ValueList

(synq.monitors.custom_monitors.v1.ValueList)

Field	Type	Description
values	repeated string	none

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
errors	repeated CreateError	One entry per requested monitor that was not created, most commonly because a monitor with that id already exists. Empty when every requested monitor was created.

BatchCreateMonitorResponse.CreateError

(synq.monitors.custom_monitors.v1.BatchCreateMonitorResponse.CreateError) Details of a requested monitor that was not created.

Field	Type	Description
id	string	none
reason	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
errors	repeated UpdateError	One entry per requested monitor that was not updated, most commonly because no monitor with that id exists. Empty when every requested monitor was updated.

BatchUpdateMonitorResponse.UpdateError

(synq.monitors.custom_monitors.v1.BatchUpdateMonitorResponse.UpdateError) Details of a requested monitor that was not updated.

Field	Type	Description
id	string	none
reason	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
include_deleted	bool	Include deleted monitors in the listing. Off by default, so an ordinary listing keeps describing only what is live.

Turn it on to resolve a monitor_ids entry that may name a deleted monitor. The id this endpoint returns is the only reference a caller holds after creating or listing a monitor, and the monitored asset needed to address the same monitor as an entity is on the stored row and nowhere else, so a listing that excluded it left the id unresolvable. One entry per monitor either way: a monitor keeps a row per version, and the listing reports the latest one. deleted_at on each returned monitor is what tells a deleted monitor from a live one. | | 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.

BatchUpdateMonitorSegmentLabelsRequest

(synq.monitors.segments.v1.BatchUpdateMonitorSegmentLabelsRequest)

Field	Type	Description
segments	repeated SegmentLabel	The segments to name. Each entry replaces that segment’s label outright; a segment not listed is left alone.

BatchUpdateMonitorSegmentLabelsRequest.SegmentLabel

(synq.monitors.segments.v1.BatchUpdateMonitorSegmentLabelsRequest.SegmentLabel)

Field	Type	Description
id	string	Id of the segment to name, as returned by ListMonitorSegments.
label	string	The name to give the segment. An empty string clears the label, so the segment falls back to showing its raw value.

BatchUpdateMonitorSegmentLabelsResponse

(synq.monitors.segments.v1.BatchUpdateMonitorSegmentLabelsResponse)

Field	Type	Description
segments	repeated MonitorSegment	The segments that were updated, in their state after the update.
errors	repeated UpdateError	One entry per requested segment that was not updated, most commonly because no segment with that id has been ingested. Empty when every requested segment was updated.

BatchUpdateMonitorSegmentLabelsResponse.UpdateError

(synq.monitors.segments.v1.BatchUpdateMonitorSegmentLabelsResponse.UpdateError) Details of a requested segment that was not updated.

Field	Type	Description
id	string	The id as it was requested.
reason	string	none

ListMonitorSegmentsRequest

(synq.monitors.segments.v1.ListMonitorSegmentsRequest)

Field	Type	Description
monitor_id	string	The monitor whose segments to list: either a custom monitor id, or the Coalesce Quality path of the monitor. Both are accepted wherever this API addresses a monitor.

ListMonitorSegmentsResponse

(synq.monitors.segments.v1.ListMonitorSegmentsResponse)

Field	Type	Description
segments	repeated MonitorSegment	The monitor’s segments, ordered by name. Empty when the monitor is not segmented, or has not ingested any data yet.

MonitorSegment

(synq.monitors.segments.v1.MonitorSegment)

Field	Type	Description
id	string	Identifier of this segment. Opaque: pass it back to BatchUpdateMonitorSegmentLabels to name the segment, or to synq.monitors.predictions.v1.MonitorPredictionsService as synq_path to read this segment’s predictions. Do not construct or parse it.
monitor_id	string	Id of the monitor this segment belongs to, as accepted by synq.monitors.custom_monitors.v1.CustomMonitorsService.
segmentation_expression	string	The monitor’s segmentation expression: the column or expression whose distinct values produce the segments, for example “country”.
value	string	The value of the segmentation expression this segment covers, exactly as it was read from the monitored data.
oneof _label.label	optional string	The name given to this segment. Unset when the segment has never been named, in which case every surface shows `value` instead.
name	string	What this segment is shown as: `label` when one is set, `value` otherwise. This is the name that reaches check names, search and alerts.
created_at	Timestamp	When this segment was first observed in the monitored data.
last_ingested_at	Timestamp	When this segment was last observed in the monitored data. A segment whose value stops appearing keeps its last observation time until the monitor drops it.

ResolverQlArg

(synq.queries.v1.ResolverQlArg) One argument of a function, positional or keyword.

Field	Type	Description
name	string	The argument’s name. For a keyword argument this is the spelling written before the `=`.
type	string	The value shape the argument takes — a string, a list of strings, a boolean, a nested query. Names are the language’s own and are stable.
required	bool	Whether the call fails to compile without this argument.
enum_domain	string	Names an entry in `enum_domains` when the argument accepts only values from a fixed vocabulary. Empty when any value of `type` is accepted.
doc	string	What this argument does, in one sentence. Empty when the function’s own doc says all there is to say.

ResolverQlEnumDomain

(synq.queries.v1.ResolverQlEnumDomain) The values one enum-typed argument accepts.

Field	Type	Description
values	repeated string	Every value the domain enumerates, lowercase. A value is matched case-insensitively, so a caller holding an upper-case spelling can send it as it is.
pattern	string	An RE2 pattern of values accepted in addition to `values`, matched against the lowercased value. Empty when the domain accepts nothing beyond the list.

It exists because one domain is not fully enumerated: the entity types a workspace defines itself are a reserved band of the asset-type vocabulary rather than members of it, spelled custom_type_<id>, and values today holds only the built-in half. A client that validates against values alone rejects a query this server compiles. Keep honouring the pattern even once a domain enumerates more than it does today: it is what makes a value the list has not caught up with still acceptable. |

ResolverQlFunction

(synq.queries.v1.ResolverQlFunction) One function of the ResolverQL language, as this deployment compiles it.

Field	Type	Description
name	string	The name the query writes, lowercase and canonical. Function names compile case-insensitively, so `WITH_TYPE` reaches the same function as `with_type`.
category	string	Which job this function does, one of the values in `categories`. Use it to group the catalog the way the product does rather than inventing an order.
doc	string	What the function selects, in one sentence. Written for a person choosing between functions; safe to show verbatim.
variadic	bool	Whether the function accepts more arguments than it declares. A variadic function with no declared arguments — `and`, `or` — takes any number of sub-queries.
default_kwarg	string	The keyword argument a bare positional value is routed to when the call names none. Empty when the function has no such argument.
positional	repeated ResolverQlArg	Arguments in the order they are written before any `name=value` argument.
kwargs	repeated ResolverQlArg	Arguments written as `name=value`, ordered by name. An argument that can be written either way appears in `positional` only.

FolderOf

(synq.queries.v1.FolderOf) Resolves the folder(s) containing a set of assets, for use as the folder source of InFolder — i.e. “everything in the same folder as these assets”. Name the assets either the simple way (entity_ids, opaque asset ids) or with a full input_query when they need to be computed (e.g. by name or type). Set exactly one.

Field	Type	Description
entity_ids	repeated string	Simplified source: the assets named directly by opaque entity id. Use this for the common “same folder as these specific assets” case; equivalent to an input_query that lists the same ids.
input_query	Query	General source: resolve the folder(s) of whatever assets this query matches (e.g. a name or type filter). Use when the assets can’t be listed up front.
include_all_ancestors	bool	When false (default): only each asset’s immediate parent folder. When true: every ancestor folder up the hierarchy, so `InFolder` then also matches assets in those ancestor folders.

IdentitiesOf

(synq.queries.v1.IdentitiesOf) Resolves to the identities of whatever the inner query matches. The same real-world table is often described by several assets — a transformation model and the warehouse table it materialises into are one asset with several representations. Those representations form an identity group. IdentitiesOf takes the assets matched by input_query and returns their identity groups, so a selection made in one platform’s terms also covers the equivalent assets in every other platform. The typical use is subtraction: “this warehouse database, except whatever my transformation tool already owns” is an EXCEPT whose removal clause is an IdentitiesOf over the transformation models. Without it the two selections overlap on every materialised table.

Field	Type	Description
input_query	Query	The assets whose identities to resolve. Required.
limit_to_types	repeated Type	Restrict the result to these types. When empty, only the other members of each identity group are returned. When set, an input asset that already has one of these types is returned as well.

InFolder

(synq.queries.v1.InFolder) Resolves to entities located in one or more folders. Give the folders exactly one way (they are mutually exclusive; if more than one is set, folders wins, then folder_of, then path):

folders — the preferred, human-authorable form: name each folder by its root entity plus its ordered folder-name segments. No opaque ids required.
folder_of — “the same folder(s) as these assets”: resolves the folder(s) containing the assets matched by an inner query, then matches everything in them. Lets you select siblings without naming a folder.
path — legacy opaque folder identifiers. Kept for back-compat; prefer folders. Discover a folder’s structured address with the folders navigation API instead of hand-writing an id.

deep controls recursion (see its field comment). InFolder lives here rather than in query_parts.proto because FolderOf nests a full Query, which would make query_parts.proto import query.proto and form a proto file import cycle.

Field	Type	Description
path	repeated string	Opaque folder identifiers (a folder’s own entity id). `folders` is the structured, human-authorable alternative. When `path` is the only source set and `deep` is unset, `deep` defaults to true for back-compat with queries authored before `deep` existed.
folders	repeated FolderRef	Structured, human-authorable folder addresses (root entity + folder-name segments). Take a `FolderRef` verbatim from a folder returned by the folders navigation API, or build one from names you can see in the catalog.
folder_of	FolderOf	Resolve the folders to search from a set of assets, rather than naming them. Selects everything in the folder(s) that contain those assets.
oneof _deep.deep	optional bool	When false or unset, matches only the direct members of the folder(s). When true, matches the entire recursive subtree (members of subfolders too).

Exception: when only the legacy path source is set and deep is unset, it defaults to true (preserves the behaviour of queries authored before this flag existed). With folders or folder_of, unset means false (shallow). |

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.identities_of	IdentitiesOf	none
oneof part.with_default_visible_types	WithDefaultVisibleTypes	none
oneof part.entity_ids	EntityIds	Pin specific entities by the ids the API returned for them. Read back as `identifier_list`, with each id on the identifier it names.
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.

EntityIds

(synq.queries.v1.EntityIds) Selects exactly the entities you list, by the entity_id the API returned for each of them. This is the pin-these-specific-entities part of a query: the assets a user ticked in a list, the results of a search you just ran, the entities another API call handed you. Because you pass the ids back as they were given, you do not need to know what kind of entity each one is, or how its address in the source system is spelled. identifier_list is the alternative, and the choice between them is about what you have in hand:

entity_ids — you are holding ids the API gave you. Pass them through unchanged.
identifier_list — you are naming entities by their address in the source system (a BigQuery project/dataset/table, a dbt model, a Looker explore), for example because a person or a config file wrote it down rather than an API call.

Reading back a selection you wrote with entity_ids. Selections are always returned as identifier_list, whichever of the two you sent — one uniform shape, so integrations built before entity_ids existed keep reading stored queries unchanged. Your ids are not lost in the process: every returned identifier carries its entity_id, so you can match each one back to what you sent, and compare a saved selection against the one you are about to save. The returned id is the entity’s canonical form, which can differ from an equivalent spelling you sent for the same entity. An id that matches nothing selects nothing, and is not an error — so a saved query keeps working after one of the entities it names is deleted or renamed, rather than failing every time it is read or resolved.

Field	Type	Description
entity_ids	repeated string	The entities to select. An id may not be blank.

An empty list selects no entities, exactly as an empty identifier_list does. Be deliberate about it, because it is not the same as leaving the part out: a part that selects nothing still counts, so it empties an AND, adds nothing to an OR, and removes nothing from an EXCEPT. If what you mean is “do not restrict on specific entities”, omit the part instead of sending it empty. Ids may be up to 1024 characters — the same limit as Identifier.entity_id, where you read them from, so any id the API returned is accepted here. |

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

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

WithDefaultVisibleTypes

(synq.queries.v1.WithDefaultVisibleTypes) Resolves to every asset of a type the catalog shows by default — the “everything” starting set. Use it as the base of a subtraction, e.g. an EXCEPT query whose first part is WithDefaultVisibleTypes and whose second part is what to leave out. On its own it selects the whole catalog, so it is rarely useful as the only part of a query. “Default visible” excludes the supporting asset types the catalog hides unless asked for (columns, tests, and similar), so this is not literally every entity.

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, or carry one of the provided traits.

Field	Type	Description
type	Type	none
types	repeated Type	none
traits	repeated string	Traits to select by, instead of — or alongside — naming types.

A trait is a property a type has, so is_monitorable means “everything a monitor can run on” without listing the forty-odd types that satisfy it today. The list it stands for is worked out each time the selection runs, so a selection saved this way covers a new platform’s tables as soon as we support them, and you never have to revisit it. Entities carrying any of the traits match. When types is also set the two narrow each other: the entity must be one of the named types AND carry one of the traits. Accepted values, and what each one means, come from the selection-query grammar the API publishes (describe_resolver_ql, or the query editor’s reference). A name that is not in it selects nothing rather than being ignored, so a typo narrows the result to empty instead of widening it — check a trait against the grammar before storing a selection. In a query written as text this is with_type(traits="is_monitorable"), and there a name outside the grammar is rejected outright. |

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

DescribeResolverQlRequest

(synq.queries.v1.DescribeResolverQlRequest)

DescribeResolverQlResponse

(synq.queries.v1.DescribeResolverQlResponse)

Field	Type	Description
functions	repeated ResolverQlFunction	Every function the language has, ordered by name.
categories	repeated string	The categories a function’s `category` names, in the order the product presents them. Group the catalog by this rather than sorting the names.
enum_domains	map EnumDomainsEntry	The accepted values of every enum-typed argument, keyed by the name an argument’s `enum_domain` carries. A domain absent here places no restriction on the argument beyond its type.

DescribeResolverQlResponse.EnumDomainsEntry

(synq.queries.v1.DescribeResolverQlResponse.EnumDomainsEntry)

Field	Type	Description
key	string	none
value	ResolverQlEnumDomain	none

ResolveQueryRequest

(synq.queries.v1.ResolveQueryRequest)

Field	Type	Description
oneof selection.resolver_ql	string	ResolverQL expression to compile and evaluate.
oneof selection.query	Query	Structured query to evaluate.
pagination	Pagination	Pagination over the matched entity set. `page_size` defaults per API when unset; pass the previous response’s `page_info.last_id` as the cursor to fetch the next page.

ResolveQueryResponse

(synq.queries.v1.ResolveQueryResponse)

Field	Type	Description
entity_ids	repeated Identifier	Opaque identifiers of the matched entities, one page worth. Round-trip each id verbatim to the rest of the entities API.
page_info	PageInfo	Pagination cursor for the next page.
rendered_resolver_ql	string	The resolved selection rendered as canonical ResolverQL. Empty when the selection has no ResolverQL representation.

TranslateResolverQlRequest

(synq.queries.v1.TranslateResolverQlRequest)

Field	Type	Description
resolver_ql	string	ResolverQL expression to compile, for example `with_type("TABLE")`.

TranslateResolverQlResponse

(synq.queries.v1.TranslateResolverQlResponse)

Field	Type	Description
query	Query	The compiled structured query. Pass it verbatim to any public API that accepts a `synq.queries.v1.Query` (for example a folder browse `filter`), or to `ResolveQuery.query` to evaluate it.
rendered_resolver_ql	string	The compiled query rendered back to canonical ResolverQL. Empty when the query has no ResolverQL representation (legacy / deprecated operands).

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.

ScopeAuthorization

(synq.v1.ScopeAuthorization)

Field	Type	Description
scopes	repeated Scope	none

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.

BatchDeleteSqlTestDeploymentRulesRequest

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestDeploymentRulesRequest)

Field	Type	Description
ids	repeated string	IDs of the SqlTestDeploymentRules to delete.

BatchDeleteSqlTestDeploymentRulesResponse

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestDeploymentRulesResponse)

BatchDeploySqlTestDeploymentRulesRequest

(synq.datachecks.sqltests.v1.BatchDeploySqlTestDeploymentRulesRequest)

Field	Type	Description
deployment_rules	repeated SqlTestDeploymentRule	List of SqlTestDeploymentRules to deploy.

BatchDeploySqlTestDeploymentRulesResponse

(synq.datachecks.sqltests.v1.BatchDeploySqlTestDeploymentRulesResponse)

Field	Type	Description
deployed_ids	repeated string	IDs for which SqlTestDeploymentRules were deployed without error.
errors	repeated DeployError	Errors raised while deploying. Empty if there were no errors.

BatchDeploySqlTestDeploymentRulesResponse.DeployError

(synq.datachecks.sqltests.v1.BatchDeploySqlTestDeploymentRulesResponse.DeployError)

Field	Type	Description
id	string	none
reason	string	none

BatchGetSqlTestDeploymentRulesRequest

(synq.datachecks.sqltests.v1.BatchGetSqlTestDeploymentRulesRequest)

Field	Type	Description
ids	repeated string	none

BatchGetSqlTestDeploymentRulesResponse

(synq.datachecks.sqltests.v1.BatchGetSqlTestDeploymentRulesResponse)

Field	Type	Description
deployment_rules	map DeploymentRulesEntry	none

BatchGetSqlTestDeploymentRulesResponse.DeploymentRulesEntry

(synq.datachecks.sqltests.v1.BatchGetSqlTestDeploymentRulesResponse.DeploymentRulesEntry)

Field	Type	Description
key	string	none
value	SqlTestDeploymentRuleView	none

DeleteSqlTestDeploymentRuleRequest

(synq.datachecks.sqltests.v1.DeleteSqlTestDeploymentRuleRequest)

Field	Type	Description
id	string	none

DeleteSqlTestDeploymentRuleResponse

(synq.datachecks.sqltests.v1.DeleteSqlTestDeploymentRuleResponse)

DeploySqlTestDeploymentRuleRequest

(synq.datachecks.sqltests.v1.DeploySqlTestDeploymentRuleRequest)

Field	Type	Description
deployment_rule	SqlTestDeploymentRule	none

DeploySqlTestDeploymentRuleResponse

(synq.datachecks.sqltests.v1.DeploySqlTestDeploymentRuleResponse)

GetSqlTestDeployDeleteOverviewRequest

(synq.datachecks.sqltests.v1.GetSqlTestDeployDeleteOverviewRequest)

Field	Type	Description
id	string	none

GetSqlTestDeployDeleteOverviewResponse

(synq.datachecks.sqltests.v1.GetSqlTestDeployDeleteOverviewResponse)

Field	Type	Description
overview	SqlTestsDeploymentOverview	none

GetSqlTestDeployOverviewRequest

(synq.datachecks.sqltests.v1.GetSqlTestDeployOverviewRequest)

Field	Type	Description
deployment_rule	SqlTestDeploymentRule	none

GetSqlTestDeployOverviewResponse

(synq.datachecks.sqltests.v1.GetSqlTestDeployOverviewResponse)

Field	Type	Description
overview	SqlTestsDeploymentOverview	none

ListSqlTestDeploymentRulesRequest

(synq.datachecks.sqltests.v1.ListSqlTestDeploymentRulesRequest)

Field	Type	Description
sources	repeated Source	none
configs_filter	ConfigsFilter	Filter SqlTestDeploymentRules 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 SqlTestDeploymentRuleType	Filter by rule type. When empty, rules of every type are returned. When set, only rules whose type is listed are returned. The filter is applied server-side before paging, so every page reflects only the selected types.
oneof _pagination.pagination	optional Pagination	Pagination. Omitting this, or sending a zero page_size, returns every matching rule in one response — there is no server-side default page size. Set page_size to bound the response; pass page_info.last_id from the previous response as the cursor to fetch the next page.

ListSqlTestDeploymentRulesResponse

(synq.datachecks.sqltests.v1.ListSqlTestDeploymentRulesResponse)

Field	Type	Description
deployment_rules	repeated SqlTestDeploymentRuleView	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.

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. Placeholder: {{ table }} is substituted with the anchor table’s fully qualified name, quoted for the warehouse — the matched table when the test is deployed by a deployment rule, which is how one query covers every table the rule matches instead of being copied onto each of them. It is the only supported placeholder; any other {{ name }} token is rejected. 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. Placeholder: {{ table }} is substituted with the anchor table’s fully qualified name, quoted for the warehouse — the matched table when the test is deployed by a deployment rule. It is the only supported placeholder; any other {{ name }} token is rejected. It renders a table name, so it belongs where a table name goes — the FROM clause of a subquery of your own: “total > (SELECT max(total) FROM {{ table }})”. It is not a column qualifier. The generated FROM clause carries no alias, and on BigQuery the fully qualified name is a single quoted identifier, so ”{{ table }}.id” does not resolve. To name the anchor’s columns, use BusinessQueryTest, where you write the FROM clause and can alias it. | | 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 this test was authored from, when deployed via configuration as code. Unset for tests authored directly through this API.

On a write this field is only ever set, never unset: omitting it keeps the stored value, so a full-replace update cannot detach the test from the config that owns it. An empty string is a real config id — the one a deploy that declares no namespace uses — so sending it attaches the test to that config rather than clearing the field. No value detaches a test; recreating it is the only way to hand it back to the app. | | 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. | | oneof _category.category | optional string | Technical category this test declares for itself — what kind of check it is mechanically (e.g. “nullness”, “uniqueness”). It is the test’s own declaration, not an administrative override: it is authoritative over any categorisation rule the workspace would otherwise apply, and is itself overridden by an explicit per-check category an admin sets. The value is free-form and workspace-defined — whatever vocabulary your categorisation rules already use. It is displayed with underscores turned into spaces, so snake_case reads well. Send the whole test on every upsert: leaving this out is the same as sending it empty, and both mean the test declares no technical category. A test then falls back to its quality.check_category annotation, which remains accepted and keeps working — this field simply outranks it. | | oneof _governance_category.governance_category | optional string | Governance category this test declares for itself — what the check is for, the data quality dimension governance reports on (e.g. “completeness”). Resolves independently of category — setting one never suppresses the other — and follows the same precedence, the same free-form vocabulary and the same full-state upsert rule described above. Its annotation fallback is quality.governance_category. | | oneof _deployment_rule_id.deployment_rule_id | optional string | ID of the SqlTestDeploymentRule that deployed this test, when it was created by a deployment rule rather than authored directly. OUTPUT ONLY. A test with this set is rule-managed: direct edits through this API are rejected. |

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)

RuleTest

(synq.datachecks.sqltests.v1.RuleTest) RuleTest is a SQL test template deployed by a SqlTestDeploymentRule onto every table or view the rule’s selection matches. It carries the same test kinds as SqlTest.template, but — unlike Template — has no anchor entity: the anchor is whichever table or view the rule matched, filled in separately for each deployed test.

Field	Type	Description
name	string	Human friendly name for this test. Required (non-empty) for business_rule_test and business_query_test — for those two kinds, name is the test’s identity key across rule redeployments, so a renamed test is treated as a different test. Optional for every other kind: leave it unset and a name is generated.
description	string	Description of purpose and motivation, copied onto every test this rule deploys.
severity	Severity	Overrides the rule’s config-level severity for this test only. Leave unset to use the config-level severity.
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.

SqlTestDeploymentChange

(synq.datachecks.sqltests.v1.SqlTestDeploymentChange) SqlTestDeploymentChange describes one test’s planned or applied change for a single table or view within a SqlTestsDeploymentOverview.

Field	Type	Description
table_path	string	Synq path of the table or view the test targets or would target.
sql_test_path	string	Synq path of the SqlTest, when it already exists (create-side changes may leave this empty until the test is actually deployed).
test_name	string	Name of the test, resolved from its RuleTest.name (or the generated name for non-business test kinds).
reason_code	SqlTestSkipReason	Why this change happens, when the reason is something other than the rule’s selection. Today that is one case: SQL_TEST_SKIP_REASON_MISSING_COLUMNS on a `tests_to_delete` entry whose table lost a column the test reads, so a caller can say “column dropped: amount” rather than reporting a bare delete. Unset (SQL_TEST_SKIP_REASON_UNSPECIFIED) otherwise, including for a delete caused by the table no longer matching the rule’s selection — treat unset as “no extra reason”, never as a list this change cannot appear in.
missing_columns	repeated string	Columns the table lacks, spelled as the test declares them, when `reason_code` is SQL_TEST_SKIP_REASON_MISSING_COLUMNS. Empty otherwise.

SqlTestDeploymentRule

(synq.datachecks.sqltests.v1.SqlTestDeploymentRule) SqlTestDeploymentRule dynamically deploys SQL test templates onto every table or view its selection matches, keeping them in sync as tables and columns change. Use it instead of authoring one SqlTest per table when the same set of checks should apply to many tables (e.g. “not_null(email) on every table that has an email column”).

Field	Type	Description
id	string	Unique identifier for this rule.
title	string	Human friendly name for this rule.
oneof config.query_config	SqlTestsQueryConfig	Deploys tests onto every match of a query; the match set is resynced over time.
oneof config.exclusive_query_config	SqlTestsExclusiveQueryConfig	Deploys tests onto every match of a query; this rule exclusively owns the match set.
oneof config.static_config	SqlTestsStaticConfig	Deploys tests onto a single fixed table or view.
oneof config.exclusive_static_config	SqlTestsExclusiveStaticConfig	Exclusively owns a single fixed table or view.
source	Source	none
oneof _config_id.config_id	optional string	Config ID this rule was authored from, when deployed via configuration as code. Unset for rules authored directly through this API.

SqlTestDeploymentRuleView

(synq.datachecks.sqltests.v1.SqlTestDeploymentRuleView) SqlTestDeploymentRuleView is a SqlTestDeploymentRule together with a summary of how many tests it currently has deployed.

Field	Type	Description
id	string	none
title	string	none
test_count	int32	Number of tests currently deployed by this rule, across every matched table or view.
oneof config.query_config	SqlTestsQueryConfig	none
oneof config.exclusive_query_config	SqlTestsExclusiveQueryConfig	none
oneof config.static_config	SqlTestsStaticConfig	none
oneof config.exclusive_static_config	SqlTestsExclusiveStaticConfig	none
source	Source	none
oneof _config_id.config_id	optional string	none

SqlTestsDeploymentOverview

(synq.datachecks.sqltests.v1.SqlTestsDeploymentOverview) SqlTestsDeploymentOverview previews or reports the effect of deploying a SqlTestDeploymentRule, per test rather than per table — a table with three tests deployed appears as three entries, one for each test.

Field	Type	Description
tests_to_create	repeated SqlTestDeploymentChange	Tests that would be newly created by this deploy.
tests_to_update	repeated SqlTestDeploymentChange	Tests that already exist and would be updated (e.g. a changed severity or template) by this deploy.
tests_to_delete	repeated SqlTestDeploymentChange	Tests that would be deleted by this deploy, because their table or view no longer matches the rule’s selection.
tests_to_keep	repeated SqlTestDeploymentChange	Tests that already exist, still match, and would be left unchanged.
skipped_tables	repeated SkippedTable	Tables or views this rule matched but could not deploy tests onto.
skipped_tests	repeated SkippedTest	Tests this rule declares that this deploy did not deploy — because another rule already owns them on the table, or because the table’s columns do not support them.
summary	SqlTestsDeploymentOverviewSummary	Counts over the lists above, so a rule matching thousands of tables can be reported without reading every row. Always populated.

SqlTestsDeploymentOverview.SkippedTable

(synq.datachecks.sqltests.v1.SqlTestsDeploymentOverview.SkippedTable) SkippedTable names a table or view the rule’s selection matched, but that this deploy could not deploy tests onto.

Field	Type	Description
table_path	string	Synq path of the skipped table or view.
reason	string	Why the table or view was skipped, as a stable SCREAMING_SNAKE token:

SKIPPED_HIGHER_PRIORITY_RULE an exclusive rule has carved the table out SKIPPED_NO_INTEGRATION the table has no integration to run a test against SKIPPED_TEST_PREPARATION_FAILED the integration’s configuration is unavailable, or the table’s dialect cannot render the test Clients branch on these, so treat the spellings as part of this API: adding a value is safe, renaming one is a breaking change. A value not listed here may appear — fall through to “skipped, reason unrecognised” rather than assume the set is closed. reason_code is the checkable form. | | reason_code | SqlTestSkipReason | Machine-checkable form of reason, so a client can branch on a value the compiler knows instead of string-matching a wire constant. reason remains authoritative and keeps being written unchanged; reason_code is SQL_TEST_SKIP_REASON_UNSPECIFIED for a reason this enum does not yet cover. |

SqlTestsDeploymentOverview.SkippedTest

(synq.datachecks.sqltests.v1.SqlTestsDeploymentOverview.SkippedTest) SkippedTest names one test the rule declares that this deploy left in place rather than deploying, because another rule already deployed it on that table. Rules covering the same table merge additively: each deploys the tests that are not there yet, and never touches a test another rule owns.

Field	Type	Description
table_path	string	Synq path of the table or view carrying the test.
sql_test_path	string	Synq path of the SqlTest, when it already exists (empty while the owning rule has not deployed it yet).
test_name	string	Name of the test, resolved the same way as in SqlTestDeploymentChange.
reason	string	Why the test was skipped, as a stable SCREAMING_SNAKE token:

SKIPPED_TEST_OWNED_BY_OTHER_RULE another rule already deploys that test SKIPPED_MISSING_COLUMNS the table lacks a column the test reads SKIPPED_SCHEMA_UNAVAILABLE no schema is known for the table yet Clients branch on these, so treat the spellings as part of this API: adding a value is safe, renaming one is a breaking change. A value not listed here may appear — fall through to “skipped, reason unrecognised” rather than assume the set is closed. reason_code is the checkable form. | | owner_rule_id | string | Id of the deployment rule that owns the test. Set only for SKIPPED_TEST_OWNED_BY_OTHER_RULE. | | owner_rule_title | string | Title the owning rule carried when this plan was made. A title can be renamed — use owner_rule_id to look the rule up. | | reason_code | SqlTestSkipReason | Machine-checkable form of reason. Same contract as SkippedTable.reason_code: reason stays authoritative, and this is SQL_TEST_SKIP_REASON_UNSPECIFIED for a reason this enum does not yet cover. | | missing_columns | repeated string | Columns the test reads that the table does not have, spelled as the test declares them. Set for SKIPPED_MISSING_COLUMNS; empty for every other reason. A test is skipped whole — not_null[a, b] with only b missing lists just b but deploys neither column — so this names the gap, not the test’s column list. | | referenced_table_path | string | Synq path of the referenced table, for a relationships test skipped because that table (rather than the table under test) lacks the column. Empty otherwise. |

SqlTestsDeploymentOverviewSummary

(synq.datachecks.sqltests.v1.SqlTestsDeploymentOverviewSummary) SqlTestsDeploymentOverviewSummary counts a SqlTestsDeploymentOverview, so a caller can render “40 tables, 78 tests, 2 skipped for a missing column” without walking lists that run to thousands of entries for a warehouse-wide rule. Every count is derived from the lists in the same message — it adds no information a reader of those lists could not compute, only the ability to skip reading them.

Field	Type	Description
tables_matched	int32	Distinct tables and views this plan touches: every table_path appearing in tests_to_create, tests_to_update, tests_to_delete, tests_to_keep, skipped_tests or skipped_tables, counted once.
tests_to_create	int32	len(tests_to_create).
tests_to_update	int32	len(tests_to_update).
tests_to_delete	int32	len(tests_to_delete).
tests_to_keep	int32	len(tests_to_keep).
tests_skipped	int32	len(skipped_tests). Skipped tables are not counted here — see skipped_by_reason, which covers both lists. A test dropped because its column went away is a delete, not a skip, and counts in tests_to_delete.
skipped_by_reason	map SkippedByReasonEntry	One entry per skip across BOTH skipped_tables and skipped_tests, keyed by the SqlTestSkipReason value name (e.g. “SQL_TEST_SKIP_REASON_MISSING_COLUMNS”), and “SQL_TEST_SKIP_REASON_UNSPECIFIED” for a reason string this enum does not cover. The two lists count in different units — a skipped table is one table, a skipped test is one test — so the values sum to more than `tests_skipped` whenever a table was skipped.
missing_columns_histogram	map MissingColumnsHistogramEntry	Lowercased column name to the number of tests citing it as missing, counted over every entry carrying `missing_columns` — the skipped_tests the rule could not deploy AND the tests_to_delete it is removing because the column went away. Both answer the same question, “which columns does this rule not find”, and a dropped column shows up as deletes rather than skips, so counting only one of the two reports an empty histogram for the case it exists for. A test missing two columns adds one to each. Lowercased so a column two tests spell differently is one entry. Empty when nothing cited a missing column.

SqlTestsDeploymentOverviewSummary.MissingColumnsHistogramEntry

(synq.datachecks.sqltests.v1.SqlTestsDeploymentOverviewSummary.MissingColumnsHistogramEntry)

Field	Type	Description
key	string	none
value	int32	none

SqlTestsDeploymentOverviewSummary.SkippedByReasonEntry

(synq.datachecks.sqltests.v1.SqlTestsDeploymentOverviewSummary.SkippedByReasonEntry)

Field	Type	Description
key	string	none
value	int32	none

SqlTestsExclusiveQueryConfig

(synq.datachecks.sqltests.v1.SqlTestsExclusiveQueryConfig) SqlTestsExclusiveQueryConfig selects tables and views by query and takes exclusive ownership of the match set: any table or view previously managed by this rule that no longer matches has its deployed tests removed on the next sync, with no keep_removed_tests opt-out (a rule managing an exclusive set never “keeps” a table that stopped matching).

Field	Type	Description
query	EntitySelectionQuery	Structured selection of tables and views this rule exclusively owns.
resolver_ql	string	ResolverQL selection string for the exclusion set. Same semantics as SqlTestsQueryConfig.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. OUTPUT ONLY, populated for every rule, ignored on write.

SqlTestsExclusiveStaticConfig

(synq.datachecks.sqltests.v1.SqlTestsExclusiveStaticConfig) SqlTestsExclusiveStaticConfig marks a single fixed path as exclusively owned by this rule — used to carve out a per-table override from a broader query rule (see SqlTestDeploymentRule precedence).

Field	Type	Description
path	string	Synq path of the table or view this rule exclusively owns.

SqlTestsQueryConfig

(synq.datachecks.sqltests.v1.SqlTestsQueryConfig) SqlTestsQueryConfig selects tables and views by query, deploying every test in tests onto each match. As the matched set changes over time (new tables, dropped columns, …), a periodic sync keeps deployed tests in step.

Field	Type	Description
query	EntitySelectionQuery	Structured selection of tables and views to deploy tests onto.
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. 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 rule regardless of how it was authored. OUTPUT ONLY — it is ignored on write; set `resolver_ql` to author a selection in ResolverQL.
tests	repeated RuleTest	Tests deployed onto every table or view this rule’s selection matches.
recurrence_rule	string	Recurrence rule for the execution schedule applied to every test this rule deploys. Empty means on-demand — deployed tests are never scheduled to run automatically. When set, it must carry an inline `DTSTART:` naming the first occurrence, e.g. “DTSTART:20260101T000000Z\nRRULE:FREQ=DAILY”.
timezone	string	IANA timezone name (e.g., “Europe/Prague”, “America/New_York”) used to interpret recurrence_rule. Empty defaults to UTC.
severity	Severity	Severity applied to every test this rule deploys, unless a RuleTest overrides it. Required — must be set to a value other than unspecified.
save_failures	bool	Applied to every test this rule deploys. Toggles saving of failure runs.
keep_removed_tests	bool	When a previously matched table or view stops matching this rule’s selection, its deployed tests are deleted by default. Set true to keep them as-is instead — they remain rule-managed but are no longer resynced.

SqlTestsStaticConfig

(synq.datachecks.sqltests.v1.SqlTestsStaticConfig) SqlTestsStaticConfig deploys tests onto a single, fixed table or view. Unlike the query-based configs, a static rule never resyncs against a changing match set — it pins one path.

Field	Type	Description
path	string	Synq path of the table or view this rule deploys tests onto.
tests	repeated RuleTest	Tests deployed onto the table or view at `path`.
recurrence_rule	string	Recurrence rule for the execution schedule applied to every test this rule deploys. Empty means on-demand. When set, it must carry an inline `DTSTART:` naming the first occurrence, e.g. “DTSTART:20260101T000000Z\nRRULE:FREQ=DAILY”.
timezone	string	IANA timezone name used to interpret recurrence_rule. Empty defaults to UTC.
severity	Severity	Severity applied to every test this rule deploys, unless a RuleTest overrides it. Required — must be set to a value other than unspecified.
save_failures	bool	Applied to every test this rule deploys. Toggles saving of failure runs.

BatchDeleteSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsRequest)

Field	Type	Description
ids	repeated string	IDs of the SqlTests to delete.

BatchDeleteSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsResponse)

Field	Type	Description
errors	repeated DeleteError	IDs that were not deleted, with the reason for each. Empty when everything in the request was deleted. Every other ID in the request is deleted regardless, so a caller reconciling a set can act on what failed without retrying what did not.

BatchDeleteSqlTestsResponse.DeleteError

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsResponse.DeleteError) Details of a single ID that could not be deleted.

Field	Type	Description
id	string	The ID from the request that was not deleted, echoed back as it was sent.
reason	string	Why it was not deleted. A test deployed by a SqlTestDeploymentRule cannot be deleted directly — delete or narrow the rule instead, or the rule’s next sync would recreate the test.

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. Each SqlTest is matched on the `id` it carries, and on its path when it has no id, so a caller that keeps its own ids can rename or re-target a test without replacing it.
sql_test_ids_to_reset	repeated string	List of SqlTest IDs to re-arm, given as the same `id` sent above. A test has no learned state to discard: this re-arms the scheduler of a test that carries a recurrence rule, so it runs immediately rather than at its next slot, and does nothing for a test scheduled externally.

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

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)

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.

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.

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.

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.

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.

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`.

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.

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.

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.

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.

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).

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	Database the connection opens with, so unqualified table names in a query resolve against it. It is not a scrape filter: metadata is read from system tables and covers every database the credentials can see, whatever this says.
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	Name this ClickHouse is published under, and the top element of every path and breadcrumb its tables appear in — `prod`, `staging`, `eu-analytics`. ClickHouse has no container above a database, so something has to name the service; left empty that is the connection host, which is correct but unreadable for a ClickHouse Cloud endpoint. It is not a database and does not restrict what is scraped. Changing it republishes every table under new paths, so pick one per service and keep it.
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.
oneof _cluster.cluster	optional ClickhouseClusterConf	How ClickHouse system tables are read. Omit to keep reading across a cluster named “default”, which every ClickHouse Cloud service provides.

ClickhouseCloudConf.AdditionalParametersEntry

(synq.integrations.v1.ClickhouseCloudConf.AdditionalParametersEntry)

Field	Type	Description
key	string	none
value	string	none

ClickhouseClusterConf

(synq.integrations.v1.ClickhouseClusterConf) How metadata reads address ClickHouse system tables. System tables are per-node, so on a service with more than one replica a plain read reflects whichever replica answered rather than the whole warehouse.

Field	Type	Description
mode	ClickhouseClusterMode	none
name	string	Cluster to read through, as named under remote_servers in the ClickHouse configuration. `SELECT DISTINCT cluster FROM system.clusters` lists what a server has. Empty means “default”. Ignored in single-node mode.

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.

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.

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.

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

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.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)

DeleteCommentRequest

(synq.issues.v2.DeleteCommentRequest)

Field	Type	Description
issue_id	string	ID of the issue the comment is on.
comment_id	string	ID of the comment to delete, as returned by PostComment or read from the issue’s comments.
actor	Actor	Actor deleting the comment. Must match the actor that posted it.

DeleteCommentResponse

(synq.issues.v2.DeleteCommentResponse)

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

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

Callback

(synq.webhooks.v1.Callback)

Field	Type	Description
url	string	none
action_name	string	none
oneof action.issues_command	IssuesCommand	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

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

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.identities_of	IdentitiesOf	none
oneof part.with_default_visible_types	WithDefaultVisibleTypes	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

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

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.

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.

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.

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.

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`.

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

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.

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`.

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.

ClickhouseClusterConf

(synq.agent.dwh.v1.ClickhouseClusterConf) How metadata reads address ClickHouse system tables. System tables are per-node, so on a service with more than one replica a plain read reflects whichever replica answered rather than the whole warehouse.

Field	Type	Description
mode	ClickhouseClusterMode	none
name	string	Cluster to read through, as named under remote_servers in the ClickHouse configuration. `SELECT DISTINCT cluster FROM system.clusters` lists what a server has. Empty means “default”. Ignored in single-node mode.

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 the connection opens with, so unqualified table names in a query resolve against it. It does not restrict what is scraped: metadata is read from system tables and covers every database the user can see, whatever this says. Leave it empty to open on “default”.
username	string	Username for authentication
password	string	Password for authentication
allow_insecure	bool	Whether to use disable SSL for connection
settings	map SettingsEntry	ClickHouse server settings applied to every connection, written as they would be in a DSN query string (e.g. “max_execution_time”: “300”). Values are typed the way ClickHouse types them in a connection string: “true” and “false” become 1 and 0, whole numbers become integers, anything else is passed through as text. A name given here replaces the value the agent would otherwise use.
cluster	ClickhouseClusterConf	How ClickHouse system tables are read. Omit to keep reading across a cluster named “default”, which every ClickHouse Cloud service provides.
instance_name	string	Name this ClickHouse is published under, and the top element of every path and breadcrumb its tables appear in — `prod`, `staging`, `eu-analytics`.

ClickHouse has no container above a database, so something has to name the service itself. Left empty, that is the connection host, which is correct but unreadable for a ClickHouse Cloud endpoint; a name given here replaces it. Two connections to the same service must give the same name, and a name is the identity of everything scraped through it: changing it republishes those tables under new paths, and the old ones are no longer produced. Pick one per service and keep it. |

ClickhouseConf.SettingsEntry

(synq.agent.dwh.v1.ClickhouseConf.SettingsEntry)

Field	Type	Description
key	string	none
value	string	none

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

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

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

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

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

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

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

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.

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.

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

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.

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.
thinking_effort	string	How long the thinking model deliberates before each answer: “none” (answer without thinking first), “low”, “medium” or “high”. Empty leaves it to the deployment default. It is a cost decision, not a capability one — the agent works at every level.

Free-form rather than an enum because the levels belong to whichever provider serves the model, and they keep being added. The value reaches the provider as given, so a level this build has never heard of works; one the model refuses is dropped for that request and logged. |

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.

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.

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

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 _mismatch_detail_level.mismatch_detail_level	optional MismatchDetailLevel	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).

ReconciliationFilter

(synq.agent.recon.v1.ReconciliationFilter) ReconciliationFilter 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.

ReconciliationOverride

(synq.agent.recon.v1.ReconciliationOverride) ReconciliationOverride 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.

ReconciliationRunRequest

(synq.agent.recon.v1.ReconciliationRunRequest) ReconciliationRunRequest 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 ReconciliationSuite	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 ReconciliationFilter	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 ReconciliationOverride	Per-reconciliation drill-down and override instructions.

ReconciliationRunRequest.VariableOverridesEntry

(synq.agent.recon.v1.ReconciliationRunRequest.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 ReconciliationMode	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.

The encoding matches SegmentInfo in the audit log, and is deliberately not self-describing: a numeric key appears as a JSON number when it fits the exact double range and as a JSON string above it, while a textual key always appears as a JSON string. A composite key is a JSON list, one element per key column. Only the key column’s own type distinguishes the cases, so the runner types these bounds after resolving the query shape. | | 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). | | oneof _seed_depth.seed_depth | optional int32 | Depth this segment sat at in the run being resumed. Carried so a resumed drill reports true absolute depth and can budget its own depth limit as “this many further levels” rather than re-spending a budget the previous run already consumed. |

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	AuditOutcome	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 AuditOutcome	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	ReconciliationOutcome	none
overall_match	bool	none
error	string	Error message if the reconciliation failed.

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	CutoffCombineStrategy	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	CutoffTruncateUnit	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	CutoffAggregateFunction	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.

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.

ResumeFromRun

(synq.agent.recon.v1.ResumeFromRun) ResumeFromRun turns an ad-hoc submission into a replay of a previous run: either a re-validation (“do the differences it found still exist”) or a deeper drill of the mismatches it stopped at. The suite comes from the parent run’s audit log, not from a config load, so the replay compares the same data the parent compared — template variables keep the values they resolved to and a cutoff keeps the watermark it derived. Credentials never come from an audit log: it records connection names only, and those are bound to integrations exactly as for any other ad-hoc run (connection_mappings, else a workspace integration of the same name).

Field	Type	Description
parent_invocation_id	string	Invocation id of the run to continue from. It must be a completed run in the caller’s workspace whose audit log carries a suite snapshot.
mode	ResumeMode	What to do with the parent’s results.
reconciliations	repeated string	Restrict the replay to these reconciliation names. Empty replays every reconciliation of the parent that is eligible for the mode.
reresolve	bool	Re-derive every query from the suite instead of replaying the SQL the parent executed. This moves the comparison window to the current clock, so it answers “does the suite pass now” rather than “is that difference still there”. Needed for a time-travel snapshot, which can otherwise never turn green.
include_passed	bool	RESUME_MODE_RECHECK only: re-run reconciliations that already passed. The default narrows to the ones that did not, which is the point of a re-validation.
drill_still_mismatched	bool	RESUME_MODE_RECHECK only: drill into whatever still mismatches, as an ordinary run with run_bisection does. A re-validation usually only needs the quick check, so this is opt-in.
oneof _threshold.threshold	optional int32	RESUME_MODE_DRILL_DEEPER only: row count at which drilling stops, overriding the reconciliation’s own. Lowering it is the usual reason to resume a bisection drill — the parent stopped at a coarser threshold.
oneof _extra_depth.extra_depth	optional int32	RESUME_MODE_DRILL_DEEPER only: how many further levels to drill below the resumed segments. Counted from the deepest resumed segment, so it means “this much deeper” rather than a budget the parent already spent. Absent leaves it unbounded.
additional_group_columns	repeated string	RESUME_MODE_DRILL_DEEPER only: extra group columns to break each divergent aggregate group down by. An aggregate drill already visits every configured group column, so resuming an aggregate reconciliation needs at least one more column to make progress.

SubmitAdhocSuiteRequest

(synq.agent.recon.v1.SubmitAdhocSuiteRequest)

Field	Type	Description
oneof _suite.suite	optional ReconciliationSuite	Inline suite configuration. Required when neither suite_id nor resume_from_run is 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. | | oneof _resume_from_run.resume_from_run | optional ResumeFromRun | Continue a previous run instead of executing a suite from its config. Mutually compatible with neither suite nor suite_id being set: the suite is rebuilt from the parent run’s audit log. | | 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 ReconciliationSuite.name.
oneof _suite_title.suite_title	optional string	none
oneof _suite_description.suite_description	optional string	none
suite_type	string	”managed” or “adhoc”.
suite	ReconciliationSuite	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	ReconciliationSuite	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	ReconciliationSuite	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.

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	ReconciliationMode	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

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	AuditOutcome	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	ReconciliationSuite	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_basis	string	Percentage basis applied to this measure, as a PercentageBasis value name.

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 SegmentMismatchType	Types of mismatch detected.
drill_stop_reason	DrillStopReason	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
reconciliation	Reconciliation	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	ReconciliationOutcome	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).
drill_stop_reason	DrillStopReason	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_basis	string	Which percentage formula was used, as a PercentageBasis value name.
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

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‘“

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”

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_basis. When set, differences ≤ this percentage are considered within tolerance.
percentage_basis	PercentageBasis	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.

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	ReconciliationSuite	The parsed suite configuration.

RenderYamlRequest

(synq.agent.recon.v1.RenderYamlRequest)

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

RenderYamlResponse

(synq.agent.recon.v1.RenderYamlResponse)

Field	Type	Description
yaml	string	The rendered YAML config string.

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.

CaseCategories

(synq.agent.recon.v1.CaseCategories) CaseCategories declares the categories for a single reconciliation case, overriding what the deployment declares. The two dimensions are independent, so a case can override one and inherit the other. Per field:

absent : inherit the deployment’s declaration
present, empty string : declare nothing for this case, even when the deployment declares a value — the category then falls to the reserved annotation or the workspace’s categorisation rules
present, non-empty : set this case’s category

An entry with neither field set therefore means the same as no entry at all, and is dropped rather than stored.

Field	Type	Description
oneof _category.category	optional string	none
oneof _governance_category.governance_category	optional string	none

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. ReconciliationSuite.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. | | reconciliation_failure_impacts | map ReconciliationFailureImpactsEntry | 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 RECONCILIATION_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. | | oneof _category.category | optional string | Categories to declare for the reconciliation checks this promotion publishes. See SuiteDeployment.category / .governance_category for what they mean and how they interact with annotations and categorisation rules. On a re-promote these behave as a patch of the previous deployment’s values, per field: - absent : keep whatever the previous deployment declared - present, empty string : clear the declaration, falling back to the reserved annotation or the workspace rules - present, non-empty : set or replace the declaration So a re-promote that says nothing about categories never silently drops one. Use UpdateDeploymentCategories to change them without re-promoting. | | oneof _governance_category.governance_category | optional string | none | | case_categories | map CaseCategoriesEntry | Initial per-case category overrides, keyed by case name. Keys omitted on a re-promote keep the previous deployment’s override; see CaseCategories for how a single dimension is inherited or cleared. Overrides for cases the promoted snapshot doesn’t contain are rejected with INVALID_ARGUMENT, so a renamed or deleted case surfaces as an error rather than a silently dead override. |

PromoteSuiteRequest.CaseCategoriesEntry

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

Field	Type	Description
key	string	none
value	CaseCategories	none

PromoteSuiteRequest.ReconciliationFailureImpactsEntry

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

Field	Type	Description
key	string	none
value	ReconciliationFailureImpact	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	ReconciliationSuite	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 _promoted_at.promoted_at | optional Timestamp | When this deployment reached production, and who put it there — taken from the most recent promotion in its history, not from whatever happened last. Read these rather than state_at / last_actor whenever the question is “when did this go live and on whose authority”. Pausing, rescheduling, editing annotations or changing categories all restamp state_at / last_actor and leave these two untouched, so a surface that renders the promotion from state_at reports the wrong time and often the wrong person. A re-promote is a promotion, so it restamps both. Unpromoting does not clear them: an inactive deployment still reports when it was last live. Both are absent only for a deployment whose history holds no promotion event. | | oneof _promoted_by.promoted_by | optional Actor | 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. | | reconciliation_failure_impacts | map ReconciliationFailureImpactsEntry | Effective per-case ReconciliationFailureImpact 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. | | oneof _category.category | optional string | Technical category declared for every reconciliation check this deployment publishes — the “what kind of check is this, mechanically” dimension the catalog groups and filters checks by (for example “nullness”, “uniqueness”, “freshness”), which is what lets one category cover the same check written as a dbt test, a SQLMesh audit or a reconciliation. Declared on the promotion rather than in the suite file, because a reconciliation only becomes a check once it is promoted: the suite file says what to reconcile, the promotion says how it behaves in production — the same reason schedule lives here and not in the file. Absent means this deployment declares no category. The category is then taken from a reserved quality.check_category annotation on the suite, the case or the deployment overlay (see deployment_annotations), and failing that from the workspace’s own categorisation rules. Setting this field outranks both. Free-form: the vocabulary is whatever the workspace already uses, not a fixed enum. Always read and write it together with governance_category — the two dimensions resolve independently and a surface that exposes one must expose both. | | oneof _governance_category.governance_category | optional string | Governance category declared for every reconciliation check this deployment publishes — the “what is this check for” dimension, orthogonal to category (for example “completeness”, “accuracy”, “timeliness”). It is the dimension a data-governance function tracks coverage against. Same declaration point, same precedence and same free-form vocabulary as category; resolved independently of it, so declaring one never suppresses the other’s annotation. | | case_categories | map CaseCategoriesEntry | Per-case overrides of the two fields above, keyed by case name from the suite config. Cases without an entry use the deployment-wide declaration. Worth overriding when the cases of one suite are the same kind of check but serve different governance purposes — a case comparing row counts is about completeness while a case comparing values is about accuracy, and they can carry different governance categories while sharing the deployment’s technical one. |

SuiteDeployment.CaseCategoriesEntry

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

Field	Type	Description
key	string	none
value	CaseCategories	none

SuiteDeployment.ReconciliationFailureImpactsEntry

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

Field	Type	Description
key	string	none
value	ReconciliationFailureImpact	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 ReconciliationSuite	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).
reconciliation_failure_impacts	map ReconciliationFailureImpactsEntry	Effective per-case ReconciliationFailureImpact map at this point in time. Snapshot semantics — every history entry carries the full map in force right after the event was recorded.
oneof _category.category	optional string	The declared categories in force at this point in time. Snapshot semantics, like the fields above: every history entry carries the values in force right after the event was recorded, not just the CATEGORIES_CHANGED ones. Absent means no category was declared at that time.
oneof _governance_category.governance_category	optional string	none
case_categories	map CaseCategoriesEntry	Per-case category overrides in force at this point in time. Snapshot semantics, like the map above.

SuiteDeploymentHistoryEntry.CaseCategoriesEntry

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

Field	Type	Description
key	string	none
value	CaseCategories	none

SuiteDeploymentHistoryEntry.ReconciliationFailureImpactsEntry

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

Field	Type	Description
key	string	none
value	ReconciliationFailureImpact	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	UnresolvedConnectionReason	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
reconciliation_failure_impacts	map ReconciliationFailureImpactsEntry	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.ReconciliationFailureImpactsEntry

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

Field	Type	Description
key	string	none
value	ReconciliationFailureImpact	none

UpdateDeploymentCaseImpactsResponse

(synq.agent.recon.v1.UpdateDeploymentCaseImpactsResponse)

Field	Type	Description
deployment	SuiteDeployment	none

UpdateDeploymentCategoriesRequest

(synq.agent.recon.v1.UpdateDeploymentCategoriesRequest)

Field	Type	Description
suite_id	string	none
oneof _category.category	optional string	Patch of the declared categories. Field presence is meaningful and the two fields are independent: - absent : leave the current value unchanged - present, empty string : clear the declaration - present, non-empty : set or replace the declaration

A request that sets nothing at all is accepted and changes nothing. | | oneof _governance_category.governance_category | optional string | none | | case_categories | map CaseCategoriesEntry | Patch of the per-case overrides, keyed by case name. Keys present in the request replace that case’s override; keys absent are left untouched, so this never resets overrides the caller didn’t mention. Send an entry with both fields absent to drop a case’s override and go back to inheriting the deployment’s declaration. Unknown case names are rejected with INVALID_ARGUMENT. | | oneof _change_summary.change_summary | optional string | none | | actor | Actor | Actor performing the category update. Required. |

UpdateDeploymentCategoriesRequest.CaseCategoriesEntry

(synq.agent.recon.v1.UpdateDeploymentCategoriesRequest.CaseCategoriesEntry)

Field	Type	Description
key	string	none
value	CaseCategories	none

UpdateDeploymentCategoriesResponse

(synq.agent.recon.v1.UpdateDeploymentCategoriesResponse)

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

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.

Reconciliation

(synq.agent.recon.v1.Reconciliation) Reconciliation 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	ReconciliationMode	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).

ReconciliationSuite

(synq.agent.recon.v1.ReconciliationSuite) ReconciliationSuite 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 Reconciliation	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.

ReconciliationSuite.VariablesEntry

(synq.agent.recon.v1.ReconciliationSuite.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	MismatchDetailLevel	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.

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.

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.

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.

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)

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

DeleteCommentRequest

(synq.incidents.v1.DeleteCommentRequest)

Field	Type	Description
incident_id	string	ID of the incident the comment is on.
comment_id	string	ID of the comment to delete, as returned by PostComment or read from the incident’s comments.
actor	Actor	Actor deleting the comment. Must match the actor that posted it.

DeleteCommentResponse

(synq.incidents.v1.DeleteCommentResponse)

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

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

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.identities_of	IdentitiesOf	none
oneof part.with_default_visible_types	WithDefaultVisibleTypes	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.

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)

DomainDefinition

(synq.domains.v2.DomainDefinition) The membership of a domain: 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). Unlike a data product, a domain is NOT a leaf: a part may pull in a whole data product or another domain, and membership is then resolved recursively. The server maintains the reference graph across domains and data products and rejects any write that would close a loop, naming the offending path — so a definition can always be resolved in finite time. The domain hierarchy counts as a reference too: a parent domain aggregates its sub-domains.

Field	Type	Description
parts	repeated Part	The parts of the definition. An asset is a member if it matches any part.

DomainDefinition.Part

(synq.domains.v2.DomainDefinition.Part) A single piece of a domain definition: a pinned asset, a whole data product, a whole other domain, 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.dataproduct_id	string	Include everything that belongs to a data product. Accepts either the bare data-product UUID or the `dataproduct-<uuid>` form that API returns as its `entity_id` — the prefix is stripped server-side.
oneof part.domain_id	string	Include everything that belongs to another domain, including that domain’s own sub-domains. Accepts either the bare domain UUID or the `domain-<uuid>` form — the prefix is stripped server-side. Rejected when it would make the domains reference each other in a loop.
oneof part.query	DomainQuery	Select assets by a query.

A query whose whole content is a single domain reference is equivalent to domain_id and is returned in that form on read, since both describe the same membership. |

DomainQuery

(synq.domains.v2.DomainQuery) The selection query behind a domain definition part, expressed for the public API. On write, provide the query in ONE of three forms:

resolver_ql — the resolver query language, a compact text form that is the canonical way to author selections as code;
public_query — a structured query (the same shape used elsewhere for asset selection), convenient to build from a filter UI; or
asset_selection_query — the structured form domains have always accepted, kept so an existing definition can be moved across unchanged. When more than one is set the first of that list 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) plus, best-effort, both structured forms. resolver_ql is not echoed back — read rendered_resolver_ql. A domain query may reference another domain or a data product (via the in_domain / in_dataproduct operands, or their resolver-query-language equivalents). Such a reference is resolved recursively and is rejected only when it would close a reference loop.

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.
asset_selection_query	AssetSelectionQuery	WRITE (option C) and READ. The structured form carried over from `synq.domains.v1`, for definitions authored against that API. On write it is used only when neither `resolver_ql` nor `public_query` is set. On read it is the stored query as-is, so a v1 definition round-trips through v2 unchanged. `public_query` is the richer form — prefer it for new integrations, since it can express domain and data-product references this one cannot.

BatchGetRequest

(synq.domains.v2.BatchGetRequest)

Field	Type	Description
ids	repeated string	Ids to fetch (1–200, unique). Each accepts either the bare UUID or the `domain-<uuid>` form; the prefix is stripped server-side.
include_deleted	bool	Include soft-deleted domains.
exclude_definition	bool	Omit the (potentially large) membership definition from each domain.

BatchGetResponse

(synq.domains.v2.BatchGetResponse)

Field	Type	Description
domains	map DomainsEntry	Domains keyed by id. Ids that do not exist (or are deleted, unless requested) are absent.

BatchGetResponse.DomainsEntry

(synq.domains.v2.BatchGetResponse.DomainsEntry)

Field	Type	Description
key	string	none
value	Domain	none

DeleteRequest

(synq.domains.v2.DeleteRequest)

Field	Type	Description
id	string	Id of the domain to delete. Accepts the bare UUID or the `domain-<uuid>` form (the prefix is stripped server-side).
purge	bool	Hard-delete instead of soft-delete, releasing the id for reuse. Refused while the domain still has sub-domains — delete or re-parent them first.
oneof _etag.etag	optional string	Optional optimistic-concurrency guard.

DeleteResponse

(synq.domains.v2.DeleteResponse)

FetchDomainWithSubDomainsRequest

(synq.domains.v2.FetchDomainWithSubDomainsRequest)

Field	Type	Description
id	string	Id of the domain. Accepts the bare UUID or the `domain-<uuid>` form.
exclude_definition	bool	Omit the membership definition from each domain.

FetchDomainWithSubDomainsResponse

(synq.domains.v2.FetchDomainWithSubDomainsResponse)

Field	Type	Description
domains	map DomainsEntry	The domain and its direct sub-domains, keyed by id.

FetchDomainWithSubDomainsResponse.DomainsEntry

(synq.domains.v2.FetchDomainWithSubDomainsResponse.DomainsEntry)

Field	Type	Description
key	string	none
value	Domain	none

GetUsageRequest

(synq.domains.v2.GetUsageRequest)

GetUsageResponse

(synq.domains.v2.GetUsageResponse)

Field	Type	Description
num_domains	int32	Number of top-level domains.
num_sub_domains	int32	Number of sub-domains, at any depth.

ListMembersRequest

(synq.domains.v2.ListMembersRequest)

Field	Type	Description
id	string	Id of the domain whose members to list. Accepts the bare UUID or the `domain-<uuid>` form (the prefix is stripped server-side).
pagination	Pagination	Pagination.

ListMembersResponse

(synq.domains.v2.ListMembersResponse)

Field	Type	Description
entity_ids	repeated string	Opaque entity ids of the assets that currently belong to the domain.
page_info	PageInfo	Pagination cursor for the next page.

ListRequest

(synq.domains.v2.ListRequest)

Field	Type	Description
pagination	Pagination	Pagination.
oneof _parent_id.parent_id	optional string	Restrict to the children of one domain. Pass an empty string to return only top-level domains. Omit to return every domain at any level.
include_deleted	bool	Include soft-deleted domains.
exclude_definition	bool	Omit the membership definition from each domain.

ListResponse

(synq.domains.v2.ListResponse)

Field	Type	Description
domains	repeated Domain	The matching domains.
page_info	PageInfo	Pagination cursor for the next page.

RemoveDefinitionPartRequest

(synq.domains.v2.RemoveDefinitionPartRequest)

Field	Type	Description
id	string	Id of the domain. Accepts the bare UUID or the `domain-<uuid>` 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.domains.v2.RemoveDefinitionPartResponse)

Field	Type	Description
domain	Domain	The stored domain after the part removal.

SetDefinitionRequest

(synq.domains.v2.SetDefinitionRequest)

Field	Type	Description
id	string	Id of the domain whose definition to replace. Accepts the bare UUID or the `domain-<uuid>` form (the prefix is stripped server-side).
definition	DomainDefinition	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.domains.v2.SetDefinitionResponse)

Field	Type	Description
domain	Domain	The stored domain after the definition write.

UpsertDefinitionPartRequest

(synq.domains.v2.UpsertDefinitionPartRequest)

Field	Type	Description
id	string	Id of the domain. Accepts the bare UUID or the `domain-<uuid>` 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.domains.v2.UpsertDefinitionPartResponse)

Field	Type	Description
domain	Domain	The stored domain after the part write.

UpsertRequest

(synq.domains.v2.UpsertRequest)

Field	Type	Description
id	string	Opaque id of the domain. Accepts either the bare UUID or the `domain-<uuid>` form — 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 domain; a new id creates a new domain.
oneof _name.name	optional string	Name. Required when creating; omit to keep the existing name on update.
oneof _description.description	optional string	Description. Omit to keep the existing description.
oneof _parent_id.parent_id	optional string	Parent domain, making this a sub-domain. Omit to keep the current parent; pass an empty string to detach the domain and make it top-level. Accepts the bare UUID or the `domain-<uuid>` form. The parent must already exist, and the write is rejected if it would make the hierarchy loop.
oneof _source.source	optional Source	Source. Omit to keep the existing source (defaults to SOURCE_SYNQ on create).
oneof _definition.definition	optional DomainDefinition	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 domain 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.domains.v2.UpsertResponse)

Field	Type	Description
domain	Domain	The stored domain after the upsert.

Domain

(synq.domains.v2.Domain) A data domain: a named area of ownership that groups the assets, data products and sub-domains belonging to one part of the business. Domains form a hierarchy through parent_id, and a parent’s membership includes everything its sub-domains contain.

Field	Type	Description
id	string	Opaque id of the domain (a UUID). Supplied by the caller on create, which makes Upsert idempotent. This is the value to pass wherever another API accepts a domain reference (for example the `in_domain` query operand).
name	string	Human-readable name.
description	string	Optional longer description.
oneof _parent_id.parent_id	optional string	Id of the parent domain, if this is a sub-domain. Absent for a top-level domain.
source	Source	none
definition	DomainDefinition	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 domain. Output-only.
updated_by	Actor	Who last edited the domain. Output-only.
created_at	Timestamp	When the domain was created. Output-only.
updated_at	Timestamp	When the domain was last updated. Output-only. Absent for a domain that has not been written since this field was introduced.
oneof _deleted_at.deleted_at	optional Timestamp	When the domain was soft-deleted, if it has been. Output-only.

DomainMembership

(synq.domains.members.v1.DomainMembership)

Field	Type	Description
user_id	string	none
domain_id	string	none
is_default	bool	none

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)

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

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

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

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

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

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

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

Enums

Outcome

(synq.deliveries.v1.Outcome) Outcome is what became of a delivery. It is a state the service maintains, not something to recompute from status codes: a 500 that will be retried and a 500 that exhausted the retries are the same status and different outcomes.

Name	Number	Description
OUTCOME_UNSPECIFIED	0	none
OUTCOME_PENDING	1	Accepted and queued, with at least one attempt still to come.
OUTCOME_DELIVERED	2	Every request the delivery produced was accepted by the destination.
OUTCOME_FAILED	3	The destination rejected it, or it was still failing when the retries ran out. No further attempt will be made — use `Redeliver` to try again.
OUTCOME_SKIPPED	4	The integration was reached and declined to send anything; `skip_reason` says why. Nothing was attempted and nothing will be.
OUTCOME_NOT_ROUTED	5	No integration could be resolved for the event at all; `skip_reason` says why. Distinct from `OUTCOME_SKIPPED`, where the integration was found and it was its own configuration that declined.

SubjectType

(synq.deliveries.v1.SubjectType)

Name	Number	Description
SUBJECT_TYPE_UNSPECIFIED	0	none
SUBJECT_TYPE_ISSUE	1	none
SUBJECT_TYPE_INCIDENT	2	none
SUBJECT_TYPE_DELIVERY_TEST	3	A delivery sent by `SendTestDelivery`, which is about no issue or incident.

StatusClass

(synq.deliveries.v1.StatusClass) StatusClass groups HTTP statuses the way a delivery report reads them.

Name	Number	Description
STATUS_CLASS_UNSPECIFIED	0	none
STATUS_CLASS_SUCCESS	2	2xx — accepted. The only class that counts as delivered.
STATUS_CLASS_REDIRECT	3	3xx. Redirects are not followed: a delivery carries credentials scoped to one host, so a destination answering with one is treated as not having accepted the payload.
STATUS_CLASS_CLIENT_ERROR	4	4xx — the destination rejected the request.
STATUS_CLASS_SERVER_ERROR	5	5xx — the destination failed to handle it.
STATUS_CLASS_NO_RESPONSE	6	No response arrived at all: a connection failure, a TLS error, a timeout.

SkipReason

(synq.deliveries.v1.SkipReason) SkipReason says why a delivery sent nothing. Every code path that declines to send names one, so an integration that appears silent can be explained rather than guessed at. It is an enum rather than a message we wrote once, so a caller can act on the reason: a not-subscribed event is fixed in the integration’s settings, a disabled integration is fixed by enabling it, and an unsupported event type is not fixable at all.

Name	Number	Description
SKIP_REASON_UNSPECIFIED	0	none
SKIP_REASON_EVENT_TYPE_NOT_SUBSCRIBED	1	The event type is not among the ones the integration subscribes to.
SKIP_REASON_EVENT_TYPE_UNSUPPORTED_BY_INTEGRATION	2	The destination has no representation for this kind of event.
SKIP_REASON_NO_ACTION_FOR_LIFECYCLE_STATE	3	The change of state maps to no action on the destination.
SKIP_REASON_INTEGRATION_NOT_FOUND	4	The integration the event was addressed to no longer exists.
SKIP_REASON_INTEGRATION_DISABLED	5	The integration exists but is disabled.
SKIP_REASON_EMPTY_EVENT_SUBJECT	6	The event carried no issue or incident to describe.

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.

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.

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

TestAlertKind

(synq.alerts.services.v2.TestAlertKind) The alert kind a test message stands in for. It only selects the wording of the message; the targets receive the same static test regardless.

Name	Number	Description
TEST_ALERT_KIND_UNSPECIFIED	0	Generic wording (“your alerts will be sent here”).
TEST_ALERT_KIND_ISSUE_LIFECYCLE	1	Wording for an alert on issues.
TEST_ALERT_KIND_SCHEMA_CHANGE	2	Wording for an alert on schema changes.
TEST_ALERT_KIND_INCIDENT_LIFECYCLE	3	Wording for an alert on incidents.

FolderRole

(synq.entities.folders.v1.FolderRole) FolderRole describes how a folder placement participates in browsing. It mirrors the placement roles carried by the catalog.

Name	Number	Description
FOLDER_ROLE_UNSPECIFIED	0	Unknown / not reported. Treat as VISIBLE.
FOLDER_ROLE_PRIMARY	1	Browsable and the default display location (breadcrumb) for its members.
FOLDER_ROLE_VISIBLE	2	Browsable, but not the default display location.
FOLDER_ROLE_HIDDEN	3	Match-only: folder filters still match entities through this placement, but it is not shown when browsing. Kept for legacy hierarchies.

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

CategoryDimension

(synq.entities.checks.v2.CategoryDimension) The dimension a category classifies a check along. A check carries at most one category per dimension, and the two resolve independently of each other.

Name	Number	Description
CATEGORY_DIMENSION_UNSPECIFIED	0	none
CATEGORY_DIMENSION_TECHNICAL	1	Technical — what kind of check this is, mechanically. Values such as “nullness”, “uniqueness”, “referential integrity”, “freshness”.
CATEGORY_DIMENSION_GOVERNANCE	2	Governance — what the check is for, in data-quality terms. Values such as “Completeness”, “Accuracy”, “Validity”, “Timeliness”, “Uniqueness”.

CategorySource

(synq.entities.checks.v2.CategorySource) Where a check’s effective category came from. The three sources are a strict precedence: an admin override beats a producer-explicit category, which beats a computed one.

Name	Number	Description
CATEGORY_SOURCE_UNSPECIFIED	0	The check has no category on this dimension — it is uncategorised.
CATEGORY_SOURCE_OVERRIDE	1	Admin override — pinned on the check itself through UpsertCheckCategories. Overrides always win.
CATEGORY_SOURCE_PRODUCER	2	Producer-explicit — declared by the tool that produced the check, either directly or as a `quality.check_category` / `quality.governance_category` annotation carried on the source asset.
CATEGORY_SOURCE_RULE	3	Computed — derived from the workspace’s categorisation rules.

RuleScope

(synq.entities.checks.v2.RuleScope) Whether a categorisation rule belongs to the workspace or is one of the platform-provided defaults.

Name	Number	Description
RULE_SCOPE_UNSPECIFIED	0	none
RULE_SCOPE_GLOBAL	1	Platform-provided rule, shared by every workspace and read-only for workspace users.
RULE_SCOPE_WORKSPACE	2	Rule defined in the caller’s workspace. A workspace rule always wins over a matching global rule.

CategorisationFilter

(synq.entities.checks.v2.CategorisationFilter) Narrows a listing to checks that do — or do not — have an effective category on a dimension.

Name	Number	Description
CATEGORISATION_FILTER_UNSPECIFIED	0	No filter.
CATEGORISATION_FILTER_CATEGORISED	1	Only checks that have an effective category on the dimension.
CATEGORISATION_FILTER_UNCATEGORISED	2	Only checks with no effective category on the dimension.

OverrideFilter

(synq.entities.checks.v2.OverrideFilter) Narrows a listing to checks that do — or do not — carry a category set explicitly on them on a dimension.

Name	Number	Description
OVERRIDE_FILTER_UNSPECIFIED	0	No filter.
OVERRIDE_FILTER_OVERRIDDEN	1	Only checks whose category on the dimension was set explicitly.
OVERRIDE_FILTER_NOT_OVERRIDDEN	2	Only checks whose category on the dimension was not set explicitly.

RecategorisationStatus.State

(synq.entities.checks.v2.RecategorisationStatus.State)

Name	Number	Description
STATE_UNSPECIFIED	0	none
STATE_IDLE	1	No sweep is scheduled or running — the workspace’s checks are up to date with its rules.
STATE_SCHEDULED	2	A sweep is queued but has not started.
STATE_IN_PROGRESS	3	A sweep is running.

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_SIGMA_ORGANIZATION	3203	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

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

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

CodeSource

(synq.entities.v1.CodeSource) CodeSource names one of the places an entity’s code is read from. An entity usually has code in more than one of them — a dbt model has its own source and the warehouse table’s DDL — and each is read independently, so one being unavailable does not hide the others.

Name	Number	Description
CODE_SOURCE_UNSPECIFIED	0	none
CODE_SOURCE_SQL_DEFINITION	1	The compiled SQL definition of a table or view.
CODE_SOURCE_ENTITY_DEFINITION	2	Code carried by the entity itself: a transformation model’s source, a stored routine’s body, an orchestration task’s script.
CODE_SOURCE_REPOSITORY_FILE	3	A file read from a connected repository.
CODE_SOURCE_CUSTOM_ENTITY	4	Code attached to a custom entity.
CODE_SOURCE_SQL_TEST	5	The expression of a SQL test.
CODE_SOURCE_RECONCILIATION	6	The configuration of a deployed reconciliation suite or case.
CODE_SOURCE_MONITOR	7	The query a monitor runs against the warehouse.

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

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

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.

CodeType

(synq.entities.v1.CodeType) CodeType describes how to read the body of a Code — which language or format its content is written in, so a client can highlight, parse or hand it to the right tool. A producer that cannot tell leaves CODE_TYPE_UNSPECIFIED rather than guessing; treat that as plain text.

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
CODE_TYPE_JAVASCRIPT	8	JavaScript, as used for the body of a Snowflake stored procedure or user-defined function declared LANGUAGE JAVASCRIPT.
CODE_TYPE_BASH	9	Shell script, as used by an orchestrator task that shells out instead of running SQL or Python.
CODE_TYPE_DAX	10	DAX, the expression language behind Power BI measures and calculated columns.
CODE_TYPE_JAVA	11	Java source, as used for the body of a Snowflake routine declared LANGUAGE JAVA.
CODE_TYPE_SCALA	12	Scala source, as used for the body of a Snowflake routine declared LANGUAGE SCALA.
CODE_TYPE_TEXT	13	Plain text with no known syntax. Distinct from CODE_TYPE_UNSPECIFIED: this is a producer stating the body has no language, rather than a producer that could not tell.
CODE_TYPE_MARKDOWN	14	Markdown, as used by a notebook cell or a documentation block that ships beside a model.

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

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.

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

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

RelationshipWriteOutcome

(synq.entities.custom.v1.RelationshipWriteOutcome) RelationshipWriteOutcome is the effect one requested write had.

Name	Number	Description
RELATIONSHIP_WRITE_OUTCOME_UNSPECIFIED	0	none
RELATIONSHIP_WRITE_OUTCOME_CREATED	1	Nothing joined these two entities; the relationship was created.
RELATIONSHIP_WRITE_OUTCOME_UPDATED	2	The two entities were already joined; the relationship was replaced.
RELATIONSHIP_WRITE_OUTCOME_DELETED	3	The relationship existed and has been removed.
RELATIONSHIP_WRITE_OUTCOME_NOT_FOUND	4	Nothing joined these two entities, so the delete removed nothing.

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

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

CoverageFilter

(synq.overlays.v1.CoverageFilter) CoverageFilter narrows the candidates to those in a particular coverage state. It never widens them: everything it can return was in the selection.

Name	Number	Description
COVERAGE_FILTER_UNSPECIFIED	0	Every candidate, covered or not. The full coverage table.
COVERAGE_FILTER_WITHOUT_DATAPRODUCT	1	Candidates in no data product.
COVERAGE_FILTER_WITHOUT_OWNER	2	Candidates with no owner.
COVERAGE_FILTER_WITHOUT_ANY	3	Candidates in no data product and with no owner — nothing claims them at all. Narrower than either of the two above, not the union of them.
COVERAGE_FILTER_WITH_DATAPRODUCT	4	Candidates in at least one data product.
COVERAGE_FILTER_WITH_OWNER	5	Candidates with at least one owner.

Freshness

(synq.overlays.v1.Freshness) Freshness chooses what a coverage answer is computed from.

Name	Number	Description
FRESHNESS_UNSPECIFIED	0	Same as `FRESHNESS_CACHED`.
FRESHNESS_CACHED	1	The periodically recomputed membership, as everything else in this service reads it. Which overlays exist and what they are attached to is current; what each one contains is behind by at most one recomputation, and the response says how far in `members_computed_at`. This is what you want for anything that refreshes.
FRESHNESS_LIVE	2	Re-resolve every overlay definition now. Correct as of the call, and far slower and far more expensive than `FRESHNESS_CACHED` — the cost is the whole catalog, not the candidate set. Use it for a one-off audit, or right after a bulk change whose effect you need to see immediately. Responses carry no `members_computed_at`, because nothing was read from an index.

One limit worth knowing before you rely on it. This settles whether an asset is covered as of now; naming which overlays claim it still needs the recomputed membership, and that half can lag. So a row is never inconsistent with the filter that selected it — an asset this call finds uncovered comes back with empty lists whatever the index still says — but an asset that has only just started matching a rule can come back covered with nothing named yet. Counts and filters are exact either way; it is the id lists that catch up on the next recomputation. |

DelayModel

(synq.monitors.v1.DelayModel) How the expected arrival time of new data is modelled, for the delay and volume change delay metrics. Only table stats monitors produce those metrics, so the choice has no effect on any other monitor type.

Name	Number	Description
DELAY_MODEL_UNSPECIFIED	0	Not set — the workspace default applies.
DELAY_MODEL_STANDARD	1	Expects data to keep arriving at the cadence it has been arriving at, regardless of which day it is. The default, and the right choice for a pipeline that runs daily.
DELAY_MODEL_WEEKLY_PATTERN	2	Learns a separate cadence for each day of the week, so a pipeline that deliberately skips weekends is not reported as delayed on Saturday and Sunday. Needs roughly two weeks of history before it has a pattern to compare against.

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

SkipReason

(synq.monitors.automated_monitors.v1.SkipReason) SkipReason is the checkable form of SkippedAsset.reason. Values mirror the SCREAMING_SNAKE tokens documented on that field one-for-one. The set is open by design — a producer may report a reason before this enum has a matching value for it — so a client must treat SKIP_REASON_UNSPECIFIED (and any value this client predates) as “skipped, reason unrecognised” rather than as proof nothing applies.

Name	Number	Description
SKIP_REASON_UNSPECIFIED	0	none
SKIP_REASON_HIGHER_PRIORITY_RULE	1	none
SKIP_REASON_NO_FRESHNESS_COLUMN_MATCH	2	none
SKIP_REASON_NO_FRESHNESS_FIELD_PATTERN	3	none
SKIP_REASON_NO_INTEGRATION	4	none
SKIP_REASON_TEST_PREPARATION_FAILED	5	none
SKIP_REASON_TEST_OWNED_BY_OTHER_RULE	6	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

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).

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
SCOPE_FOLDERS_READ	240	none
SCOPE_FOLDERS_EDIT	241	none
SCOPE_DELIVERY_READ	242	none
SCOPE_DELIVERY_EDIT	243	none

Source

(synq.v1.Source)

Name	Number	Description
SOURCE_APP	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_API	1	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

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

SqlTestDeploymentRuleType

(synq.datachecks.sqltests.v1.SqlTestDeploymentRuleType) SqlTestDeploymentRuleType identifies which kind of selection a deployment rule uses. The value corresponds to the populated config oneof arm on SqlTestDeploymentRule / SqlTestDeploymentRuleView. Use it with ListSqlTestDeploymentRulesRequest.rule_types to return only rules of selected kinds.

Name	Number	Description
SQL_TEST_DEPLOYMENT_RULE_TYPE_UNSPECIFIED	0	No filter — when used in a request, rules of any type are returned.
SQL_TEST_DEPLOYMENT_RULE_TYPE_QUERY	1	Rule with `query_config`: selects tables/views by query and deploys tests on the matches.
SQL_TEST_DEPLOYMENT_RULE_TYPE_EXCLUSIVE_QUERY	2	Rule with `exclusive_query_config`: a query whose matches are exclusively owned by this rule.
SQL_TEST_DEPLOYMENT_RULE_TYPE_STATIC	3	Rule with `static_config`: targets a single fixed table or view.
SQL_TEST_DEPLOYMENT_RULE_TYPE_EXCLUSIVE_STATIC	4	Rule with `exclusive_static_config`: a single fixed table or view, exclusively owned.

SqlTestSkipReason

(synq.datachecks.sqltests.v1.SqlTestSkipReason) SqlTestSkipReason is the checkable form of the reason string carried by SqlTestsDeploymentOverview.SkippedTable and .SkippedTest, mirroring the SCREAMING_SNAKE tokens documented on those fields one-for-one. It also carries the reason a SqlTestDeploymentChange deletes a test, which has no string form. The set is open by design — a producer may report a reason before this enum has a matching value for it — so a client must treat SQL_TEST_SKIP_REASON_UNSPECIFIED (and any value this client predates) as “skipped, reason unrecognised” rather than as proof nothing applies.

Name	Number	Description
SQL_TEST_SKIP_REASON_UNSPECIFIED	0	none
SQL_TEST_SKIP_REASON_HIGHER_PRIORITY_RULE	1	none
SQL_TEST_SKIP_REASON_NO_INTEGRATION	2	none
SQL_TEST_SKIP_REASON_TEST_PREPARATION_FAILED	3	none
SQL_TEST_SKIP_REASON_TEST_OWNED_BY_OTHER_RULE	4	none
SQL_TEST_SKIP_REASON_MISSING_COLUMNS	5	The table’s schema is known and lacks a column the test reads.
SQL_TEST_SKIP_REASON_SCHEMA_UNAVAILABLE	6	No schema is known for the table yet, so column tests cannot be checked.

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).

ClickhouseClusterMode

(synq.integrations.v1.ClickhouseClusterMode)

Name	Number	Description
CLICKHOUSE_CLUSTER_MODE_UNSPECIFIED	0	Treated as CLICKHOUSE_CLUSTER_MODE_ALL_REPLICAS. Reading across a cluster is the behaviour of an integration that has never set this, so single-node reads have to be asked for rather than inherited from an unset field.
CLICKHOUSE_CLUSTER_MODE_ALL_REPLICAS	1	Read system tables across the named cluster, so metadata covers every replica. Requires `GRANT REMOTE ON .`.
CLICKHOUSE_CLUSTER_MODE_SINGLE_NODE	2	Read system tables on the connected node only. The one option that works on a ClickHouse whose remote_servers defines no cluster, and it needs no REMOTE grant — but on a service that does have replicas it reports the metadata of a single node.

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

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

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

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

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

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

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.

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

ClickhouseClusterMode

(synq.agent.dwh.v1.ClickhouseClusterMode)

Name	Number	Description
CLICKHOUSE_CLUSTER_MODE_UNSPECIFIED	0	Treated as CLICKHOUSE_CLUSTER_MODE_ALL_REPLICAS. Reading across a cluster is the behaviour of a connection that has never set this, so single-node reads have to be asked for rather than inherited from an unset field.
CLICKHOUSE_CLUSTER_MODE_ALL_REPLICAS	1	Read system tables across the named cluster, so metadata covers every replica. Requires `GRANT REMOTE ON .`.
CLICKHOUSE_CLUSTER_MODE_SINGLE_NODE	2	Read system tables on the connected node only. The one option that works on a ClickHouse whose remote_servers defines no cluster, and it needs no REMOTE grant — but on a service that does have replicas it reports the metadata of a single node.

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

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.

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
TRIAGE_FAILURE_CATEGORY_NOT_CONFIGURED	8	Scout is not enabled for this workspace, so no triage can run until an administrator configures it

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

CutoffAggregateFunction

(synq.agent.recon.v1.CutoffAggregateFunction) CutoffAggregateFunction defines the aggregate function for watermark derivation.

Name	Number	Description
CUTOFF_AGGREGATE_FUNCTION_UNSPECIFIED	0	Default: MAX.
CUTOFF_AGGREGATE_FUNCTION_MAX	1	none
CUTOFF_AGGREGATE_FUNCTION_MIN	2	none

CutoffCombineStrategy

(synq.agent.recon.v1.CutoffCombineStrategy) CutoffCombineStrategy defines how to combine watermarks from source and target.

Name	Number	Description
CUTOFF_COMBINE_STRATEGY_UNSPECIFIED	0	Default: MIN.
CUTOFF_COMBINE_STRATEGY_MIN	1	Use the smaller of source and target watermarks (safe default).
CUTOFF_COMBINE_STRATEGY_MAX	2	Use the larger of source and target watermarks.
CUTOFF_COMBINE_STRATEGY_SOURCE	3	Use only the source watermark (target must not be configured).
CUTOFF_COMBINE_STRATEGY_TARGET	4	Use only the target watermark (source must not be configured).

CutoffTruncateUnit

(synq.agent.recon.v1.CutoffTruncateUnit) CutoffTruncateUnit defines time truncation for the cutoff value.

Name	Number	Description
CUTOFF_TRUNCATE_UNIT_UNSPECIFIED	0	No truncation (default).
CUTOFF_TRUNCATE_UNIT_HOUR	1	none
CUTOFF_TRUNCATE_UNIT_DAY	2	none
CUTOFF_TRUNCATE_UNIT_WEEK	3	none
CUTOFF_TRUNCATE_UNIT_MONTH	4	none
CUTOFF_TRUNCATE_UNIT_QUARTER	5	none
CUTOFF_TRUNCATE_UNIT_YEAR	6	none

ResumeMode

(synq.agent.recon.v1.ResumeMode) ResumeMode selects which replay a ResumeFromRun performs.

Name	Number	Description
RESUME_MODE_UNSPECIFIED	0	none
RESUME_MODE_RECHECK	1	Re-run the parent’s queries and report what changed: fixed, still mismatched, regressed or unchanged.
RESUME_MODE_DRILL_DEEPER	2	Continue the parent’s drill from where it stopped — the mismatch segments a bisection left open, or the divergent groups an aggregate found — instead of re-drilling the whole dataset from the top.

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_SUBGROUP_MISMATCH	1	The group is present on both sides and its measures diverge, at a level that still has a grouping level beneath it. Where drill_down is populated the divergence is accounted for by the descendants, so this node is a path to the mismatches rather than a mismatch in its own right. Only when drill_down is absent does it stand as the mismatch itself.
AGGREGATE_DIVERGENCE_TYPE_MISSING_IN_SOURCE	2	Group exists in target but not in source.
AGGREGATE_DIVERGENCE_TYPE_MISSING_IN_TARGET	3	Group exists in source but not in target.
AGGREGATE_DIVERGENCE_TYPE_MEASURE_MISMATCH	4	The group is present on both sides and its measures diverge at the deepest grouping level, so it is a mismatch in its own right and carries the investigation queries. Not a synonym for MISMATCH: the two differ by whether anything is grouped below, and only this one is counted directly in the divergent-group totals.

AuditOutcome

(synq.agent.recon.v1.AuditOutcome) AuditOutcome describes the overall outcome of a reconciliation run. Values are ordered by severity: passed < within_threshold < mismatched < failed.

Name	Number	Description
AUDIT_OUTCOME_UNSPECIFIED	0	none
AUDIT_OUTCOME_PASSED	1	All reconciliations completed and matched exactly.
AUDIT_OUTCOME_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_OUTCOME_MISMATCHED	3	At least one reconciliation found data differences exceeding configured thresholds (or no thresholds were configured).
AUDIT_OUTCOME_FAILED	4	At least one reconciliation encountered an infrastructure error (connection failure, query error, setup failure, etc.).

DrillStopReason

(synq.agent.recon.v1.DrillStopReason) DrillStopReason explains why bisection stopped at a particular node.

Name	Number	Description
DRILL_STOP_REASON_UNSPECIFIED	0	none
DRILL_STOP_REASON_THRESHOLD_REACHED	1	The segment narrowed to at most the configured number of rows, so it is reported as-is. Drilling further would still narrow it, which is why this and MAX_DEPTH_REACHED are the two reasons a later run can resume from.
DRILL_STOP_REASON_MAX_DEPTH_REACHED	2	The configured depth limit was hit before the segment got small enough. Resumable: raising the limit and drilling again narrows it further.
DRILL_STOP_REASON_EMPTY_SEGMENT	3	Neither side had any rows in the segment, so there was nothing to compare.
DRILL_STOP_REASON_CANNOT_SPLIT	4	The key range cannot be subdivided any further — every remaining row shares one key value. Unlike the two resumable reasons above, drilling again will not narrow this segment.
DRILL_STOP_REASON_MATCHED	5	Source and target agreed, so the segment needed no further drilling.
DRILL_STOP_REASON_ERROR	6	A query failed while comparing the segment; its result is unknown rather than matched or mismatched. The failure is on the run’s query records.

MeasureVerdictReason

(synq.agent.recon.v1.MeasureVerdictReason) MeasureVerdictReason explains the threshold evaluation outcome. MeasureVerdictReason explains why a measure was or was not treated as diverging. Thresholds are tried in order — absolute first, then percentage — and the first one the difference falls inside decides the verdict.

Name	Number	Description
MEASURE_VERDICT_REASON_UNSPECIFIED	0	none
MEASURE_VERDICT_REASON_EXACT_MATCH	1	Source and target agreed exactly, so no threshold was consulted.
MEASURE_VERDICT_REASON_WITHIN_ABSOLUTE_THRESHOLD	2	The values differ, but by no more than the configured absolute threshold. Not treated as divergent.
MEASURE_VERDICT_REASON_WITHIN_PERCENTAGE_THRESHOLD	3	The values differ by more than the absolute threshold allowed (or none was set), but fall inside the configured percentage threshold. Not treated as divergent. The percentage is computed against whichever side the PercentageBasis selects.
MEASURE_VERDICT_REASON_EXCEEDED_ALL_THRESHOLDS	4	The values differ by more than every configured threshold. Divergent.
MEASURE_VERDICT_REASON_NO_THRESHOLDS_CONFIGURED	5	The values differ and no threshold was configured to tolerate it, so any difference counts. Divergent — distinct from EXCEEDED_ALL_THRESHOLDS, where thresholds existed and were exceeded.

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

ReconciliationOutcome

(synq.agent.recon.v1.ReconciliationOutcome) ReconciliationOutcome 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_OUTCOME_UNSPECIFIED	0	none
RECONCILIATION_OUTCOME_PASSED	1	Reconciliation completed and data matched exactly — no differences found.
RECONCILIATION_OUTCOME_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_OUTCOME_MISMATCHED	3	Reconciliation completed but found data differences that exceed configured thresholds (or no thresholds were configured).
RECONCILIATION_OUTCOME_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. The source/target sense of these values matches SegmentMismatchType and AggregateDivergenceType: source is numbered before target everywhere.

Name	Number	Description
ROW_MISMATCH_TYPE_UNSPECIFIED	0	none
ROW_MISMATCH_TYPE_MISSING_IN_SOURCE	1	The row is present in the target but absent from the source.
ROW_MISMATCH_TYPE_MISSING_IN_TARGET	2	The row is present in the source but absent from the target.
ROW_MISMATCH_TYPE_MODIFIED	3	The row exists on both sides but its contents differ.

SegmentMismatchType

(synq.agent.recon.v1.SegmentMismatchType) SegmentMismatchType categorizes how rows differ between source and target. A mismatch leaf carries every type that applies, so a segment whose two sides differ in both row count and content reports COUNT_MISMATCH and DATA_MISMATCH together.

Name	Number	Description
SEGMENT_MISMATCH_TYPE_UNSPECIFIED	0	none
SEGMENT_MISMATCH_TYPE_MISSING_IN_SOURCE	1	The segment holds rows on the target side but none on the source side.
SEGMENT_MISMATCH_TYPE_MISSING_IN_TARGET	2	The segment holds rows on the source side but none on the target side.
SEGMENT_MISMATCH_TYPE_COUNT_MISMATCH	3	Both sides hold rows, but not the same number of them.
SEGMENT_MISMATCH_TYPE_DATA_MISMATCH	4	Both sides hold rows and their checksums disagree, so at least one row differs in content. Reported independently of the row counts.
SEGMENT_MISMATCH_TYPE_UNKNOWN	5	The segment was reported as mismatched but none of the categories above applied. Distinct from UNSPECIFIED, which means the field was never set.

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.

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.

PercentageBasis

(synq.agent.recon.v1.PercentageBasis) PercentageBasis 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_BASIS_UNSPECIFIED	0	Default: source.
PERCENTAGE_BASIS_SOURCE	1		diff	/	source	— “target is X% off from source.” Best when source is the authoritative baseline.
PERCENTAGE_BASIS_TARGET	2		diff	/	target	— “source is X% off from target.” Best when target is the authoritative baseline.
PERCENTAGE_BASIS_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).

DeploymentAction

(synq.agent.recon.v1.DeploymentAction)

Name	Number	Description
DEPLOYMENT_ACTION_UNSPECIFIED	0	none
DEPLOYMENT_ACTION_PROMOTED	1	The suite reached production for the first time, under a new deployment id. Only PROMOTED and REPROMOTED replace the frozen suite snapshot; every other action carries the previous snapshot forward unchanged.
DEPLOYMENT_ACTION_REPROMOTED	2	A suite already in production was published again, keeping its deployment id and replacing the frozen snapshot with the current configuration.
DEPLOYMENT_ACTION_SCHEDULE_CHANGED	3	The run schedule changed. The suite configuration itself is untouched.
DEPLOYMENT_ACTION_MAPPINGS_CHANGED	4	The bindings from the suite’s connection names to workspace integrations changed.
DEPLOYMENT_ACTION_PAUSED	5	Scheduled runs were suspended. The deployment stays in production.
DEPLOYMENT_ACTION_RESUMED	6	Scheduled runs were re-enabled after a pause.
DEPLOYMENT_ACTION_UNPROMOTED	7	The suite was withdrawn from production. Distinct from PAUSED: this retires the deployment rather than suspending its schedule.
DEPLOYMENT_ACTION_ANNOTATIONS_CHANGED	8	The annotations attached to the deployment changed.
DEPLOYMENT_ACTION_FAILURE_IMPACTS_CHANGED	9	The per-reconciliation failure impact settings changed — which tables a failing reconciliation raises an issue on.
DEPLOYMENT_ACTION_CATEGORIES_CHANGED	10	The categories declared for the deployment’s reconciliation checks changed.

UnresolvedConnectionReason

(synq.agent.recon.v1.UnresolvedConnectionReason) Reason why a single connection could not be resolved.

Name	Number	Description
UNRESOLVED_CONNECTION_REASON_UNSPECIFIED	0	none
UNRESOLVED_CONNECTION_REASON_NOT_PROVIDED	1	No mapping was supplied and no workspace integration matches the connection name.
UNRESOLVED_CONNECTION_REASON_INTEGRATION_NOT_FOUND	2	Mapping references an integration that does not exist or the caller cannot see it.
UNRESOLVED_CONNECTION_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).
UNRESOLVED_CONNECTION_REASON_CAPABILITY_DISABLED	4	Integration exists but the allow_reconciliation_adhoc / allow_reconciliation_deploy capability gate is disabled for it.

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.

MismatchDetailLevel

(synq.agent.recon.v1.MismatchDetailLevel) MismatchDetailLevel controls how much detail is included in results for mismatched rows. Levels are ordered by increasing data exposure.

Name	Number	Description
MISMATCH_DETAIL_LEVEL_UNSPECIFIED	0	Default: COUNT_ONLY.
MISMATCH_DETAIL_LEVEL_COUNT_ONLY	1	Only report mismatch counts per segment. No row-level information is exposed. Privacy-safe.
MISMATCH_DETAIL_LEVEL_WITH_KEYS	2	Include primary key values of mismatched rows. Reveals which rows differ, but not the actual data values.
MISMATCH_DETAIL_LEVEL_DETAILED	3	Include full column values for mismatched rows. Requires consent_acknowledged = true. Warning: may expose sensitive data in the audit log.

ReconciliationFailureImpact

(synq.agent.recon.v1.ReconciliationFailureImpact) ReconciliationFailureImpact 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
RECONCILIATION_FAILURE_IMPACT_UNSPECIFIED	0	Defaults to RAISE_ISSUE_ON_TABLES.
RECONCILIATION_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.
RECONCILIATION_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.

ReconciliationMode

(synq.agent.recon.v1.ReconciliationMode) ReconciliationMode defines the comparison strategy for a reconciliation. Modes are ordered by depth of comparison: ROW_COUNT < ROW_CHECKSUM < AGGREGATE.

Name	Number	Description
RECONCILIATION_MODE_UNSPECIFIED	0	none
RECONCILIATION_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.
RECONCILIATION_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.
RECONCILIATION_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.

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.

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.

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

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

Domain.Source

(synq.domains.v1.Domain.Source)

Name	Number	Description
SOURCE_SYNQ	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_ATLAN	1	none

Domain.Source

(synq.domains.v2.Domain.Source) Where this domain is managed. Domains from an external source are read-only in the app.

Name	Number	Description
SOURCE_SYNQ	0	buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
SOURCE_ATLAN	1	none

Status

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

Name	Number	Description
STATUS_UNSPECIFIED	0	none
STATUS_OK	1	none
STATUS_FAILED	2	none

​Services

​DeliveriesService

​ListDeliveries

​BatchGetDeliveries

​GetDelivery

​ListAttempts

​SummariseDeliveries

​Redeliver

​SendTestDelivery

​SqlMeshService

​IngestMetadata

​IngestExecution

​CloudwatchService

​IngestCloudwatchLogsData

​DwhService

​IngestObjectInformation

​IngestSqlDefinitions

​IngestSchemas

​IngestObjectMetrics

​IngestTaskResults

​IngestQueryLogs

​IngestTableConstraints

​IngestLineage

​OpenlineageService

​Ingest

​DbtService

​IngestInvocation

​AirflowLogsService

​IngestLog

​IngestDatahubAspects

​AlertsService

​Create

​List

​BatchGet

​Update

​Delete

​ToggleEnabled

​AlertsService

​Create

​List

​BatchGet

​Rename

​UpdateTargets

​UpdateSettings

​UpdateTemplate

​Delete

​ToggleEnabled

​ToggleIncidentOwnerAlert

​SendTestAlert

​FoldersService

​Browse

​GetFolderOf

​ListMembers

​TypeDefsService

​ListEntityTypeDefs

​ListPlatformDefs

​ListEntityTraitDefs

​ListExecutionTypeDefs

​EntitiesService

​GetEntity

​BatchGetEntities

​ListEntities

​SearchEntities

​ChecksCoverageService

​GetCoverage

​ChecksCategoriesService

​UpsertCheckCategories

​DeleteCheckCategories

​ListCheckCategories

​ChecksCategorisationRulesService

​UpsertRule

​DeleteRule

​ListRules

​BatchGetRules

​PreviewRule

​ListRuleMatches

​GetRecategorisationStatus

​ChecksCategoriesService

​UpsertCheckCategories

​DeleteCheckCategories

Services

DeliveriesService

ListDeliveries

BatchGetDeliveries

GetDelivery

ListAttempts

SummariseDeliveries

Redeliver

SendTestDelivery

SqlMeshService

IngestMetadata

IngestExecution

CloudwatchService

IngestCloudwatchLogsData

DwhService

IngestObjectInformation

IngestSqlDefinitions

IngestSchemas

IngestObjectMetrics

IngestTaskResults

IngestQueryLogs

IngestTableConstraints

IngestLineage

OpenlineageService

Ingest

DbtService

IngestInvocation

AirflowLogsService

IngestLog

IngestDatahubAspects

AlertsService

Create

List

BatchGet

Update

Delete

ToggleEnabled

AlertsService

Create

List

BatchGet

Rename

UpdateTargets

UpdateSettings

UpdateTemplate

Delete

ToggleEnabled

ToggleIncidentOwnerAlert

SendTestAlert

FoldersService

Browse

GetFolderOf

ListMembers

TypeDefsService

ListEntityTypeDefs

ListPlatformDefs

ListEntityTraitDefs

ListExecutionTypeDefs

EntitiesService

GetEntity

BatchGetEntities

ListEntities

SearchEntities

ChecksCoverageService

GetCoverage

ChecksCategoriesService

UpsertCheckCategories

DeleteCheckCategories

ListCheckCategories

ChecksCategorisationRulesService

UpsertRule

DeleteRule

ListRules

BatchGetRules

PreviewRule

ListRuleMatches

GetRecategorisationStatus

ChecksCategoriesService

UpsertCheckCategories

DeleteCheckCategories