​

Services

​

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.

​

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.

​

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:

1. group has entities A, B, C at time t1
2. client sends group with entities B, C, D at time t2
3. 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.

​

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.

​

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 Synq. Entities are identified by a unique identifier and can be created, updated, read and deleted.

​

UpsertEntity

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

​

DeleteEntity

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

​

ListEntities

ListEntities (ListEntitiesRequest) ListEntitiesResponse List all entities.

​

FeaturesService

(synq.entities.custom.v1.FeaturesService)

​

UpsertEntityFeature

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

​

DeleteEntityFeature

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

​

ListEntityFeatures

ListEntityFeatures (ListEntityFeaturesRequest) ListEntityFeaturesResponse List all entities.

​

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 Synq native entity.enum There is no option to create relationships between 2 Synq native entities (dbt model, BI dashboard, etc.).

​

UpsertRelationships

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

​

DeleteRelationships

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

​

ListRelationships

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

​

ChecksRelationshipsService

(synq.entities.custom.v1.ChecksRelationshipsService)

​

UpsertCheckRelationships

UpsertCheckRelationships (UpsertCheckRelationshipsRequest) UpsertCheckRelationshipsResponse

​

DeleteCheckRelationships

DeleteCheckRelationships (DeleteCheckRelationshipsRequest) DeleteCheckRelationshipsResponse

​

ImpactService

(synq.entities.impact.v1.ImpactService)

​

GetImpact

GetImpact (GetImpactRequest) GetImpactResponse

​

EntityExecutionsService

(synq.entities.executions.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

​

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

​

ChangesService

(synq.entities.changes.v1.ChangesService) ChangesService provides functionality to track and retrieve changes made to entities in the system. It supports various types of changes including git commits, schema changes, and SQL definition changes. The service is designed to help track the history and evolution of entities over time. The service supports multiple types of changes:

• Git commits: Changes made through version control
• Schema changes: Modifications to database schemas
• SQL definition changes: Updates to SQL queries and definitions

​

List

List (ListRequest) ListResponse List retrieves the history of changes for a specific entity identified by its path. Changes are returned in chronological order (newest first) and include details about the type of change, when it occurred, and who made it.

​

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.

​

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.

​

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.

​

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

​

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

​

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

​

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.

​

DwhAgentService

(synq.agent.dwh.v1.DwhAgentService)

​

Connect

Connect (ConnectRequest) ConnectResponse buf:lint:ignore RPC_NO_CLIENT_STREAMING

​

SreAgentService

(synq.agent.sre.v1.SreAgentService)

​

Connect

Connect (ConnectRequest) ConnectResponse buf:lint:ignore RPC_NO_CLIENT_STREAMING

​

GetConfig

GetConfig (GetConfigRequest) GetConfigResponse

​

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

​

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.

​

PostComment

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

​

IssuesService

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

​

BatchGetIssues

BatchGetIssues (BatchGetIssuesRequest) BatchGetIssuesResponse

​

ListIssues

ListIssues (ListIssuesRequest) ListIssuesResponse

​

MarkInvestigating

MarkInvestigating (MarkInvestigatingRequest) MarkInvestigatingResponse Mark issue as being investigated.

​

MarkFixed

MarkFixed (MarkFixedRequest) MarkFixedResponse Mark issue as fixed.

​

MarkExpected

MarkExpected (MarkExpectedRequest) MarkExpectedResponse Mark issue as expected.

​

MarkNoActionNeeded

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

​

PostComment

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

​

IncidentsService

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

​

CreateIncident

CreateIncident (CreateIncidentRequest) CreateIncidentResponse

​

RenameIncident

RenameIncident (RenameIncidentRequest) RenameIncidentResponse

​

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

​

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

​

CustomMonitorsService

(synq.monitors.custom_monitors.v1.CustomMonitorsService)

​

BatchCreateMonitor

BatchCreateMonitor (BatchCreateMonitorRequest) BatchCreateMonitorResponse

​

BatchDeleteMonitor

BatchDeleteMonitor (BatchDeleteMonitorRequest) BatchDeleteMonitorResponse

​

BatchUpdateMonitorMode

BatchUpdateMonitorMode (BatchUpdateMonitorModeRequest) BatchUpdateMonitorModeResponse

​

BatchUpdateMonitorSeverity

BatchUpdateMonitorSeverity (BatchUpdateMonitorSeverityRequest) BatchUpdateMonitorSeverityResponse

​

HistoryService

(synq.monitors.history.v1.HistoryService)

​

History

History (HistoryRequest) HistoryResponse

​

MonitorInfoService

(synq.monitors.info.v1.MonitorInfoService)

​

MonitorInfo

MonitorInfo (MonitorInfoRequest) MonitorInfoResponse

​

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.

​

TestSuggestionsService

(synq.datachecks.testsuggestions.v1.TestSuggestionsService)

​

BatchCreateTestSuggestions

BatchCreateTestSuggestions (BatchCreateTestSuggestionsRequest) BatchCreateTestSuggestionsResponse

​

BatchGetTestSuggestionsForEntities

BatchGetTestSuggestionsForEntities (BatchGetTestSuggestionsForEntitiesRequest) BatchGetTestSuggestionsForEntitiesResponse

​

BatchAcceptTestSuggestions

BatchAcceptTestSuggestions (BatchAcceptTestSuggestionsRequest) BatchAcceptTestSuggestionsResponse

​

BatchRejectTestSuggestions

BatchRejectTestSuggestions (BatchRejectTestSuggestionsRequest) BatchRejectTestSuggestionsResponse

​

SqlTestsService

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

​

BatchUpsertSqlTests

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

​

ListSqlTests

ListSqlTests (ListSqlTestsRequest) ListSqlTestsResponse List SqlTests for given annotations.

​

BatchGetSqlTests

BatchGetSqlTests (BatchGetSqlTestsRequest) BatchGetSqlTestsResponse Get SqlTests by their IDs.

​

BatchDeleteSqlTests

BatchDeleteSqlTests (BatchDeleteSqlTestsRequest) BatchDeleteSqlTestsResponse Delete SqlTests by their IDs.

​

GetSqlTestAudit

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

​

PlatformsService

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

​

SetPlatformAuthentication

SetPlatformAuthentication (SetPlatformAuthenticationRequest) SetPlatformAuthenticationResponse

​

DbtService

(synq.ingest.dbt.v1.DbtService)

​

IngestInvocation

IngestInvocation (IngestInvocationRequest) IngestInvocationResponse

​

SqlMeshService

(synq.ingest.sqlmesh.v1.SqlMeshService)

​

IngestMetadata

IngestMetadata (IngestMetadataRequest) IngestMetadataResponse

​

IngestExecution

IngestExecution (IngestExecutionRequest) IngestExecutionResponse

​

DwhService

(synq.ingest.dwh.v1.DwhService)

​

IngestObjectInformation

IngestObjectInformation (IngestObjectInformationRequest) IngestObjectInformationResponse

​

IngestSqlDefinitions

IngestSqlDefinitions (IngestSqlDefinitionsRequest) IngestSqlDefinitionsResponse

​

IngestSchemas

IngestSchemas (IngestSchemasRequest) IngestSchemasResponse

​

IngestObjectMetrics

IngestObjectMetrics (IngestObjectMetricsRequest) IngestObjectMetricsResponse

​

IngestTaskResults

IngestTaskResults (IngestTaskResultsRequest) IngestTaskResultsResponse

​

CommitsService

(synq.git.commits.v1.CommitsService)

​

GetDiffByChangeId

GetDiffByChangeId (GetDiffByChangeIdRequest) GetDiffByChangeIdResponse

​

GetDiffByCommit

GetDiffByCommit (GetDiffByCommitRequest) GetDiffByCommitResponse

​

AtlanProviderService

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

​

GetAtlanConnections

GetAtlanConnections (GetAtlanConnectionsRequest) GetAtlanConnectionsResponse

​

GetAtlanDataProducts

GetAtlanDataProducts (GetAtlanDataProductsRequest) GetAtlanDataProductsResponse

​

GetAtlanDomains

GetAtlanDomains (GetAtlanDomainsRequest) GetAtlanDomainsResponse

​

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

​

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.

​

Get

Get (GetRequest) GetResponse

​

Remove

Remove (RemoveRequest) RemoveResponse

​

Activate

Activate (ActivateRequest) ActivateResponse Activate or deactivate the integration.

​

Messages

​

ScopeAuthorization

(synq.v1.ScopeAuthorization)

Field	Type	Description
scopes	repeated Scope	none

​

PageInfo

(synq.v1.PageInfo)

Field	Type	Description
total_count	int32	Total number of items matching the request.
count	int32	Number of items returned in this response.
last_id	string	ID of the last item in the response. Used for pagination.

​

Pagination

(synq.v1.Pagination)

Field	Type	Description
oneof _cursor.cursor	optional string	Cursor for the next page of results. If not provided, returns the first page.
oneof _page_size.page_size	optional int32	Maximum number of items to return in a single page. If not provided, defaults vary per API.

​

Type

(synq.entities.v1.Type) Custom entity type that is used to categorize custom entities.

Field	Type	Description
workspace	string	Immutable workspace identifier that this custom entity type belongs to.
type_id	int32	none
name	string	Name of the custom entity type that is displayed to the user.
svg_icon	bytes	SVG icon of the custom entity type that is displayed to the user.
svg_icon_id	string	SYNQ 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.

​

Code

(synq.entities.v1.Code) Code represents a piece of code or configuration that can be processed by SYNQ. 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	Synq Path to the entity. This is a unique path that can be used to access the entity in the Synq’s UI.
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 SYNQ 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 SYNQ 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

​

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	SYNQ 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	SYNQ 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 SYNQ.
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 changed file paths in the Commit
related_changed_file_paths	repeated string	File paths which are related with the entities for which changes are requested. When no paths are present it means that is impossible to determine most relevant file changes. This field will be empty when retrieving change by id.
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

​

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

(synq.entities.v1.GitCommitChange.FileChangeStatsEntry)

Field	Type	Description
key	string	none
value	ChangeStats	none

​

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.

​

SchemaChange

(synq.entities.v1.SchemaChange) SchemaChange represents a change detected in a database schema.

Field	Type	Description
column_changes	repeated SchemaColumnChange	List of changes made to individual columns in the schema.

​

SchemaColumnChange

(synq.entities.v1.SchemaColumnChange) SchemaColumnChange represents a specific change to a column in the schema.

Field	Type	Description
oneof column_change.column_addition	ColumnAdditionChangeType	none
oneof column_change.column_native_type	ColumnNativeTypeChangeType	none
oneof column_change.column_removal	ColumnRemovalChangeType	none

​

SchemaColumnChange.ColumnAdditionChangeType

(synq.entities.v1.SchemaColumnChange.ColumnAdditionChangeType) ColumnAdditionChangeType represents the addition of a new column to the schema.

Field	Type	Description
column_id	string	Identifier of the new column.
native_type	string	Data type of the new column.
ordinal_position	int32	Position where the column was added in the schema.

​

SchemaColumnChange.ColumnNativeTypeChangeType

(synq.entities.v1.SchemaColumnChange.ColumnNativeTypeChangeType) ColumnNativeTypeChangeType represents a change in a column’s data type.

Field	Type	Description
column_id	string	Identifier of the modified column.
previous_native_type	string	Previous data type of the column.
current_native_type	string	New data type of the column.

​

SchemaColumnChange.ColumnRemovalChangeType

(synq.entities.v1.SchemaColumnChange.ColumnRemovalChangeType) ColumnRemovalChangeType represents the removal of a column from the schema.

Field	Type	Description
column_id	string	Identifier of the removed column.
native_type	string	Native data type of the removed column.
ordinal_position	int32	Original position of the column in the schema.

​

SqlDefinitionChange

(synq.entities.v1.SqlDefinitionChange) SqlDefinitionChange represents a change detected in a SQL definition.

Field	Type	Description
previous_sql	string	Previous version of the SQL definition.
previous_sql_state_at	Timestamp	Timestamp when the previous SQL state was valid.
current_sql	string	Current version of the SQL definition.
current_sql_state_at	Timestamp	Timestamp when the current SQL state became valid.
sql_diff	string	Diff showing the changes between previous and current SQL.

​

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
name	string	Name of the entity that is displayed to the user.
description	string	Description of the entity that is displayed in relevant contexts. Can contain Markdown.
created_at	Timestamp	Timestamp when the entity was created.
updated_at	Timestamp	Timestamp when the entity was last updated.
deleted_at	Timestamp	Timestamp when the entity was deleted. If this is set, the entity is considered deleted.
synq_path	string	Return only value. Synq Path to the entity. This is a unique path that can be used to access the entity in the Synq’s UI.
synq_catalog_url	string	Return only value. Synq URL to the entity. This is a unique URL that can be used to access the entity in the Synq’s UI.
annotations	repeated Annotation	Annotations attached to the entity. Annotations are key-value pairs that can be used to store metadata about the entity.

​

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.

​

AirflowDagIdentifier

(synq.entities.v1.AirflowDagIdentifier)

Field	Type	Description
integration_id	string	SYNQ 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	SYNQ 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

​

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	SYNQ integration_id that identifies the dbt Core project
node_id	string	Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​

Identifier

(synq.entities.v1.Identifier) Identifier is a unique reference to an entity in SYNQ system. Entity identifiers are designed to closely mimic identifiers used by data platforms and tools. To construct an identifier, you need to know the kind of the entity and the ids that you would normally use to identify it in the data platform or tool. For example, to identify a table in BigQuery, you would need to know the project, dataset, and table names.

Field	Type	Description
oneof id.dbt_core_node	DbtCoreNodeIdentifier	Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Core project
oneof id.dbt_cloud_node	DbtCloudNodeIdentifier	Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Cloud project
oneof id.bigquery_table	BigqueryTableIdentifier	BigQuery table identifier
oneof id.snowflake_table	SnowflakeTableIdentifier	Snowflake table identifier
oneof id.redshift_table	RedshiftTableIdentifier	Redshift table identifier
oneof id.postgres_table	PostgresTableIdentifier	Postgres table identifier
oneof id.mysql_table	MysqlTableIdentifier	Mysql table identifier
oneof id.clickhouse_table	ClickhouseTableIdentifier	Clickhouse table identifier
oneof id.airflow_dag	AirflowDagIdentifier	Airflow DAG identifier
oneof id.airflow_task	AirflowTaskIdentifier	Airflow task identifier within a given DAG
oneof id.custom	CustomIdentifier	Custom identifier to be used with all custom created entities
oneof id.dataproduct	DataproductIdentifier	Dataproduct identifier
oneof id.synq_path	SynqPathIdentifier	SynqPath identifier
oneof id.databricks_table	DatabricksTableIdentifier	Databricks table identifier
oneof id.trino_table	TrinoTableIdentifier	Trino table identifier
oneof id.sql_mesh_model	SqlMeshModelIdentifier	SQLMesh Model identifier
oneof id.sql_mesh_audit	SqlMeshAuditIdentifier	SQLMesh Audit identifier
oneof id.monitor	MonitorIdentifier	Monitor identifier

​

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	SYNQ integration_id of the monitored identifier

​

MysqlTableIdentifier

(synq.entities.v1.MysqlTableIdentifier)

Field	Type	Description
host	string	Mysql hostname without port
schema	string	Mysql database
table	string	Mysql table

​

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

​

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	SYNQ 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	SYNQ 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	SYNQ path that identifies the SYNQ 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

​

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

​

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.

​

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.

​

DeleteEntitiesGroupRequest

(synq.entities.custom.v1.DeleteEntitiesGroupRequest)

Field	Type	Description
group_id	string	none

​

DeleteEntitiesGroupResponse

(synq.entities.custom.v1.DeleteEntitiesGroupResponse)

​

Group

(synq.entities.custom.v1.Group) Group is a collection of entities.

Field	Type	Description
group_id	string	Identifier of the group.
entity_ids	repeated Identifier	Identifiers of entities that belong to the group.
created_at	Timestamp	Timestamp when the group was created.
updated_at	Timestamp	Timestamp when the group was last updated.

​

ListEntityGroupsRequest

(synq.entities.custom.v1.ListEntityGroupsRequest)

​

ListEntityGroupsResponse

(synq.entities.custom.v1.ListEntityGroupsResponse)

Field	Type	Description
entities_groups	repeated Group	none

​

UpsertEntitiesGroupRequest

(synq.entities.custom.v1.UpsertEntitiesGroupRequest)

Field	Type	Description
group	Group	none

​

UpsertEntitiesGroupResponse

(synq.entities.custom.v1.UpsertEntitiesGroupResponse)

Field	Type	Description
deleted_ids	repeated Identifier	none

​

DeleteTypeRequest

(synq.entities.custom.v1.DeleteTypeRequest)

Field	Type	Description
type_id	int32	Identifier of the custom entity type to delete.

​

DeleteTypeResponse

(synq.entities.custom.v1.DeleteTypeResponse)

​

ListTypesRequest

(synq.entities.custom.v1.ListTypesRequest)

​

ListTypesResponse

(synq.entities.custom.v1.ListTypesResponse)

Field	Type	Description
types	repeated Type	List of entities.

​

UpsertTypeRequest

(synq.entities.custom.v1.UpsertTypeRequest)

Field	Type	Description
type	Type	Entity to create or update.

​

UpsertTypeResponse

(synq.entities.custom.v1.UpsertTypeResponse)

​

DeleteEntityRequest

(synq.entities.custom.v1.DeleteEntityRequest) DeleteEntityRequest is the request message for the DeleteEntity method.

Field	Type	Description
id	Identifier	Identifier of the entity to delete.

​

DeleteEntityResponse

(synq.entities.custom.v1.DeleteEntityResponse) DeleteEntityResponse is the response message for the DeleteEntity method.

​

ListEntitiesRequest

(synq.entities.custom.v1.ListEntitiesRequest)

​

ListEntitiesResponse

(synq.entities.custom.v1.ListEntitiesResponse)

Field	Type	Description
entities	repeated Entity	none

​

UpsertEntityRequest

(synq.entities.custom.v1.UpsertEntityRequest) UpsertEntityRequest is the request message for the UpsertEntity method.

Field	Type	Description
entity	Entity	The entity to create or update.

​

UpsertEntityResponse

(synq.entities.custom.v1.UpsertEntityResponse) UpsertEntityResponse is the response message for the UpsertEntity method.

​

DeleteEntityFeatureRequest

(synq.entities.custom.v1.DeleteEntityFeatureRequest)

Field	Type	Description
entity_id	Identifier	Identifier of the entity to delete feature from.
feature_id	string	Identifier of the feature to delete.

​

DeleteEntityFeatureResponse

(synq.entities.custom.v1.DeleteEntityFeatureResponse)

​

Feature

(synq.entities.custom.v1.Feature)

Field	Type	Description
workspace	string	Immutable workspace identifier that this entity belongs to.
entity_id	Identifier	The identifier of the entity to create or update feature for.
feature_id	string	Identifier of the feature. Can be any string, e.g. “sql” for SQL feature. Use same identifier to update the feature. Do not use random identifier as it will create a new feature on every update.
oneof feature.sql_definition	SqlDefinition	Only one feature per entity.
oneof feature.git_file_reference	GitFileReference	Multiple features per entity.
oneof feature.code	Code	Multiple features per entity.
oneof feature.schema	Schema	Only one feature per entity.
oneof feature.check_category	CheckCategory	Only one feature per entity.
created_at	Timestamp	Timestamp when the entity was created.
updated_at	Timestamp	Timestamp when the entity was last updated.
deleted_at	Timestamp	Timestamp when the entity was deleted. If this is set, the entity is considered deleted.

​

ListEntityFeaturesRequest

(synq.entities.custom.v1.ListEntityFeaturesRequest)

Field	Type	Description
entity_id	Identifier	Identifier of the entity to get features for.

​

ListEntityFeaturesResponse

(synq.entities.custom.v1.ListEntityFeaturesResponse)

Field	Type	Description
features	repeated Feature	List of features for the entity.

​

UpsertEntityFeatureRequest

(synq.entities.custom.v1.UpsertEntityFeatureRequest)

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

​

UpsertEntityFeatureResponse

(synq.entities.custom.v1.UpsertEntityFeatureResponse)

​

DeleteRelationshipsRequest

(synq.entities.custom.v1.DeleteRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

​

DeleteRelationshipsResponse

(synq.entities.custom.v1.DeleteRelationshipsResponse)

​

ListRelationshipsRequest

(synq.entities.custom.v1.ListRelationshipsRequest)

Field	Type	Description
ids	repeated Identifier	Return relationships for the given entity_id. Either upstream or downstream.

​

ListRelationshipsResponse

(synq.entities.custom.v1.ListRelationshipsResponse)

Field	Type	Description
relationships	repeated Relationship	none

​

Relationship

(synq.entities.custom.v1.Relationship)

Field	Type	Description
upstream	Identifier	none
downstream	Identifier	none

​

UpsertRelationshipsRequest

(synq.entities.custom.v1.UpsertRelationshipsRequest)

Field	Type	Description
relationships	repeated Relationship	none

​

UpsertRelationshipsResponse

(synq.entities.custom.v1.UpsertRelationshipsResponse)

​

CheckRelationship

(synq.entities.custom.v1.CheckRelationship)

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

​

DeleteCheckRelationshipsRequest

(synq.entities.custom.v1.DeleteCheckRelationshipsRequest)

Field	Type	Description
check_relationships	repeated CheckRelationship	none

​

DeleteCheckRelationshipsResponse

(synq.entities.custom.v1.DeleteCheckRelationshipsResponse)

​

UpsertCheckRelationshipsRequest

(synq.entities.custom.v1.UpsertCheckRelationshipsRequest)

Field	Type	Description
check_relationships	repeated CheckRelationship	none

​

UpsertCheckRelationshipsResponse

(synq.entities.custom.v1.UpsertCheckRelationshipsResponse)

​

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.

​

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 name of the Check category. If it is not defined categorisation rules are applied based on package + kind.

​

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.

​

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.

​

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)

​

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”
is_platform_native	bool	Whether the check is platform native
oneof _category.category	optional string	Explicit name of the category to use for this check

​

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.

​

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.

​

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.

​

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

​

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

​

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

​

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.

​

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.

​

EntitiesStartPoint

(synq.entities.lineage.v1.EntitiesStartPoint)

Field	Type	Description
entities	repeated Identifier	none

​

EntityColumnsStartPoint

(synq.entities.lineage.v1.EntityColumnsStartPoint)

Field	Type	Description
id	Identifier	none
column_names	repeated string	none

​

GetLineageRequest

(synq.entities.lineage.v1.GetLineageRequest)

Field	Type	Description
lineage_direction	LineageDirection	none
start_point	GetLineageStartPoint	none
oneof _max_depth.max_depth	optional int32	none

​

GetLineageResponse

(synq.entities.lineage.v1.GetLineageResponse)

Field	Type	Description
lineage	Lineage	none

​

GetLineageStartPoint

(synq.entities.lineage.v1.GetLineageStartPoint) Possible starting points to get lineage from.

Field	Type	Description
oneof from.entities	EntitiesStartPoint	none
oneof from.entity_columns	EntityColumnsStartPoint	none

​

CllDetails

(synq.entities.lineage.v1.CllDetails)

Field	Type	Description
columns	repeated Column	Column details for CLL.
cll_state	CllState	State of the CLL parse. UNSPECIFIED if CLL was not requested.
cll_messages	repeated string	Messages related to CLL. e.g. Description of parse errors, etc.

​

Column

(synq.entities.lineage.v1.Column) Column in a table-like asset (used in CLL mode).

Field	Type	Description
column_id	string	ID string for the column. This is the parsed column name.
oneof _name.name	optional string	Original column name as fetched from the table.
oneof _native_type.native_type	optional string	Column type as fetched from the table.

​

ColumnDependency

(synq.entities.lineage.v1.ColumnDependency) Indicates data flow between columns. Source columns are used to compute value of target columns.

Field	Type	Description
source_node_idx	uint32	Index of source node in the lineage nodes list.
source_node_column_id	string	none
target_node_idx	uint32	Index of target node in the lineage nodes list.
target_node_column_id	string	none

​

Lineage

(synq.entities.lineage.v1.Lineage) Lineage defines the lineage of table-like entities.

Field	Type	Description
nodes	repeated LineageNode	Nodes in the lineage with their identities and columns.
node_dependencies	repeated NodeDependency	All edges in the lineage between nodes. This can be parsed to create a graph of all the nodes.
is_cll	bool	Indicates whether the lineage was filtered for column level lineage (CLL).
column_dependencies	repeated ColumnDependency	Dependencies between columns. Populated only for CLL.

​

LineageNode

(synq.entities.lineage.v1.LineageNode) Node in a lineage graph representing one or more entities (e.g. database table).

Field	Type	Description
ids	repeated Identifier	All entities which have the same identity as this node. Must be at least one item. These are sorted by closeness to the type of the start point entities. e.g. if requesting lineage of a DBT source, first entity should be from DBT, similarly when viewing table it will be other tables.
position	NodePosition	Position of the node in the lineage.
oneof _cll_details.cll_details	optional CllDetails	Populated only for Column Level Lineage (CLL).

​

NodeDependency

(synq.entities.lineage.v1.NodeDependency) Indicates data flow between nodes. Source nodes are used to compute value of target nodes.

Field	Type	Description
source_node_idx	uint32	Index of source node in the lineage nodes list.
target_node_idx	uint32	Index of target node in the lineage nodes list.

​

AssetSelectionQuery

(synq.domains.v1.AssetSelectionQuery)

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	none

​

AssetSelectionQuery.QueryPart

(synq.domains.v1.AssetSelectionQuery.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_data_platform	InDataPlatform	none
oneof part.in_folder	InFolder	none
oneof part.with_data_platform_type	WithDataPlatformType	none
oneof part.query	AssetSelectionQuery	none
oneof part.unsupported	Unsupported	none

​

DomainDefinition

(synq.domains.v1.DomainDefinition)

Field	Type	Description
parts	repeated Part	none

​

DomainDefinition.Part

(synq.domains.v1.DomainDefinition.Part)

Field	Type	Description
id	string	part identifier
oneof part.identifier	Identifier	none
oneof part.dataproduct	DataproductIdentifier	none
oneof part.query	AssetSelectionQuery	none

​

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

​

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

​

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)

​

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.

​

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)

​

SYNQ

(synq.agent.v1.SYNQ) SYNQ contains authentication and connection details for the SYNQ platform

Field	Type	Description
client_id	string	Client ID for OAuth authentication
client_secret	string	Client secret for OAuth authentication
endpoint	string	SYNQ API agent endpoint (host:port)
ingest_endpoint	string	SYNQ API ingest endpoint (host:port)
oauth_url	string	OAuth authentication URL

​

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

​

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

​

Config

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

Field	Type	Description
agent	Agent	Agent configuration
synq	SYNQ	SYNQ 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

​

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

​

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

​

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	none
oneof value.time_value	Timestamp	none

​

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

​

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

​

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

​

ClickhouseConf

(synq.agent.dwh.v1.ClickhouseConf)

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

​

DatabricksConf

(synq.agent.dwh.v1.DatabricksConf)

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

​

MySQLConf

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

Field	Type	Description
host	string	Host address
port	int32	Port number
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

​

PostgresConf

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

Field	Type	Description
host	string	Host address
port	int32	Port number
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
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
databases	repeated string	Database to connect to
use_get_ddl	bool	Use GET_DDL to determine queries used for table/view creation

​

TrinoConf

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

Field	Type	Description
host	string	Snowflake account identifier
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

​

Config

(synq.agent.sre.v1.Config) Config represents the main configuration for the SRE agent

Field	Type	Description
synq	SYNQ	SYNQ 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

​

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

​

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

​

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

​

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.

​

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.

​

AgentTask

(synq.agent.sre.v1.AgentTask)

Field	Type	Description
task_id	string	none
created_at	Timestamp	none
oneof task.triage	TriageTask	none
oneof task.suggest_tests	SuggestTestsTask	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

​

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

​

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 SYNQ managed agent can access this connection

​

DwhConnection.ParametersEntry

(synq.agent.sre.v1.DwhConnection.ParametersEntry)

Field	Type	Description
key	string	none
value	string	none

​

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

​

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

​

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

​

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.

​

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

​

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)

​

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 Synq’s 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	Unique identifier for the query. This ID can be used to retrieve the actual SQL query from the session store.
data_analysis	string	Analysis specific to this query’s results and their implications. This is the analysis of the results from executing the query identified by query_id.

​

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
issue_id	string	ID of the issue that is believed to be the root cause of the current issue.

​

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

​

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

​

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

​

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

​

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

​

Actor

(synq.issues.actor.v1.Actor)

Field	Type	Description
name	string	none
oneof user.slack	SlackUser	none
oneof user.email	EmailUser	none
oneof user.pagerduty	PagerdutyUser	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

​

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

​

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

​

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)

​

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

​

CreateIncidentResponse

(synq.incidents.v1.CreateIncidentResponse)

Field	Type	Description
incident	Incident	none

​

ListIncidentsRequest

(synq.incidents.v1.ListIncidentsRequest)

Field	Type	Description
oneof _time.time	optional Time	Time range filter
oneof _sort.sort	optional Sort	Sort options
oneof _pagination.pagination	optional Pagination	Pagination
states	repeated State	Filter by states
affected_entities	repeated Identifier	Filter by affected entities

​

ListIncidentsRequest.Sort

(synq.incidents.v1.ListIncidentsRequest.Sort)

Field	Type	Description
sort_by	Field	none
order	Order	none

​

ListIncidentsRequest.Time

(synq.incidents.v1.ListIncidentsRequest.Time)

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

​

ListIncidentsResponse

(synq.incidents.v1.ListIncidentsResponse)

Field	Type	Description
incidents	repeated Incident	none

​

MergeIncidentsRequest

(synq.incidents.v1.MergeIncidentsRequest)

Field	Type	Description
incident_id	string	ID of the primary incident to merge into
actor	Actor	Actor performing the merge
at	Timestamp	Time at which the incidents were merged. Defaults to the current time.
other_incident_ids	repeated string	IDs of other incidents to merge into the primary incident

​

MergeIncidentsResponse

(synq.incidents.v1.MergeIncidentsResponse)

​

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

​

Event

(synq.webhooks.v1.Event)

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
callbacks	repeated Callback	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.
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

​

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

​

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

​

Callback

(synq.webhooks.v1.Callback)

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

​

DeleteDeploymentRuleRequest

(synq.monitors.automated_monitors.v1.DeleteDeploymentRuleRequest)

Field	Type	Description
id	string	none

​

DeleteDeploymentRuleResponse

(synq.monitors.automated_monitors.v1.DeleteDeploymentRuleResponse)

​

DeployDeploymentRuleRequest

(synq.monitors.automated_monitors.v1.DeployDeploymentRuleRequest)

Field	Type	Description
deployment_rule	MonitorsDeploymentRule	none

​

DeployDeploymentRuleResponse

(synq.monitors.automated_monitors.v1.DeployDeploymentRuleResponse)

​

GetDeployDeleteOverviewRequest

(synq.monitors.automated_monitors.v1.GetDeployDeleteOverviewRequest)

Field	Type	Description
id	string	none

​

GetDeployDeleteOverviewResponse

(synq.monitors.automated_monitors.v1.GetDeployDeleteOverviewResponse)

Field	Type	Description
overview	MonitorsDeploymentOverview	none

​

GetDeployOverviewRequest

(synq.monitors.automated_monitors.v1.GetDeployOverviewRequest)

Field	Type	Description
deployment_rule	MonitorsDeploymentRule	none

​

GetDeployOverviewResponse

(synq.monitors.automated_monitors.v1.GetDeployOverviewResponse)

Field	Type	Description
overview	MonitorsDeploymentOverview	none

​

ListDeploymentRulesForAssetRequest

(synq.monitors.automated_monitors.v1.ListDeploymentRulesForAssetRequest)

Field	Type	Description
asset_path	string	none

​

ListDeploymentRulesForAssetResponse

(synq.monitors.automated_monitors.v1.ListDeploymentRulesForAssetResponse)

Field	Type	Description
deployment_rules	repeated MonitorsDeploymentRuleView	none

​

ListDeploymentRulesRequest

(synq.monitors.automated_monitors.v1.ListDeploymentRulesRequest)

​

ListDeploymentRulesResponse

(synq.monitors.automated_monitors.v1.ListDeploymentRulesResponse)

Field	Type	Description
deployment_rules	repeated MonitorsDeploymentRuleView	none

​

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	none
metric_ids	repeated MetricId	none

​

EntitySelectionQuery

(synq.monitors.automated_monitors.v1.EntitySelectionQuery)

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	none

​

EntitySelectionQuery.QueryPart

(synq.monitors.automated_monitors.v1.EntitySelectionQuery.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_folder	InFolder	synq.queries.v1.InDataPlatform in_data_platform = 5;
oneof part.query	EntitySelectionQuery	none
oneof part.unsupported	Unsupported	none

​

ExclusiveQueryConfig

(synq.monitors.automated_monitors.v1.ExclusiveQueryConfig)

Field	Type	Description
query	EntitySelectionQuery	none

​

ExclusiveStaticConfig

(synq.monitors.automated_monitors.v1.ExclusiveStaticConfig)

Field	Type	Description
path	string	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

​

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

​

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

​

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

​

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

​

StaticConfig

(synq.monitors.automated_monitors.v1.StaticConfig)

Field	Type	Description
path	string	none
severity	Severity	none
sensitivity	Sensitivity	none
metric_ids	repeated MetricId	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

​

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

​

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

​

ModeAnomalyEngine

(synq.monitors.custom_monitors.v1.ModeAnomalyEngine)

Field	Type	Description
sensitivity	int32	none

​

ModeFixedThresholds

(synq.monitors.custom_monitors.v1.ModeFixedThresholds)

Field	Type	Description
min	DoubleValue	none
max	DoubleValue	none

​

MonitorCustomNumeric

(synq.monitors.custom_monitors.v1.MonitorCustomNumeric)

Field	Type	Description
metric_aggregation	string	none

​

MonitorDefinition

(synq.monitors.custom_monitors.v1.MonitorDefinition)

Field	Type	Description
id	string	none
monitored_id	Identifier	none
time_partitioning	TimePartitioning	none
oneof _segmentation.segmentation	optional Segmentation	none
oneof _filter.filter	optional string	none
severity	Severity	none
oneof monitor.freshness	MonitorFreshness	none
oneof monitor.volume	MonitorVolume	none
oneof monitor.custom_numeric	MonitorCustomNumeric	none
oneof monitor.field_stats	MonitorFieldStats	none
oneof mode.anomaly_engine	ModeAnomalyEngine	none
oneof mode.fixed_thresholds	ModeFixedThresholds	none
oneof schedule.daily	ScheduleDaily	none
oneof schedule.hourly	ScheduleHourly	none

​

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’]“)

​

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)

​

ScheduleHourly

(synq.monitors.custom_monitors.v1.ScheduleHourly)

Field	Type	Description
minutes_since_midnight	int32	Minutes since midnight (0-59)

​

Segmentation

(synq.monitors.custom_monitors.v1.Segmentation)

Field	Type	Description
expression	string	The expression to segment on (eg. “country”, “meta[‘country’]“)

​

TimePartitioning

(synq.monitors.custom_monitors.v1.TimePartitioning)

Field	Type	Description
expression	string	The expression to partition on (eg. “created_at”, “meta[‘created_at’]“)

​

HistoryRequest

(synq.monitors.history.v1.HistoryRequest)

Field	Type	Description
monitor_path	string	Experimental: Will be replaced with identifier
metrics_version	int32	none
segments	repeated string	none
from	Timestamp	none
to	Timestamp	none

​

HistoryResponse

(synq.monitors.history.v1.HistoryResponse)

Field	Type	Description
predictions	repeated Prediction	none

​

Prediction

(synq.monitors.history.v1.Prediction)

Field	Type	Description
f	string	Field
s	string	Segment
m	string	Metric
v	double	Value
vu	DoubleValue	Upper bound
vl	DoubleValue	Lower bound
p	string	Pattern
e	double	Expected value
st	double	Standard deviation
t	Timestamp	Timestamp

​

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

​

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
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
oneof _monitored.monitored	optional Monitored	Entity which is monitored

​

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

​

MonitorInfoRequest

(synq.monitors.info.v1.MonitorInfoRequest)

Field	Type	Description
id	Identifier	none

​

MonitorInfoResponse

(synq.monitors.info.v1.MonitorInfoResponse)

Field	Type	Description
oneof _monitor_info.monitor_info	optional MonitorInfo	none

​

IdentifierList

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

Field	Type	Description
identifiers	repeated Identifier	none

​

InDataPlatform

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

Field	Type	Description
identifier	DataPlatformIdentifier	none

​

InDataproduct

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

Field	Type	Description
identifier	DataproductIdentifier	none

​

InDomain

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

Field	Type	Description
domain_id	string	none

​

InFolder

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

Field	Type	Description
path	repeated string	none

​

Unsupported

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

Field	Type	Description
query_json	string	none

​

WithAnnotation

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

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

​

WithDataPlatformType

(synq.queries.v1.WithDataPlatformType)

Field	Type	Description
types	repeated DataPlatformType	none

​

WithNameSearch

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

Field	Type	Description
search_query	string	none

​

WithType

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

Field	Type	Description
type	Type	none
types	repeated Type	none

​

WithType.Type

(synq.queries.v1.WithType.Type)

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

​

Query

(synq.queries.v1.Query) Query is a structured query that can be used to find entities in the system. It consists of multiple parts, each representing a different aspect of the query. The parts can be combined using the operand to form a complete query.

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

​

Query.QueryPart

(synq.queries.v1.Query.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_dataproduct	InDataproduct	none
oneof part.in_data_platform	InDataPlatform	none
oneof part.with_data_platform_type	WithDataPlatformType	none
oneof part.in_folder	InFolder	none
oneof part.in_domain	InDomain	none
oneof part.query	Query	none
oneof part.unsupported	Unsupported	none

​

Dataproduct

(synq.dataproducts.v1.Dataproduct)

Field	Type	Description
identifier	DataproductIdentifier	none
definition	DataproductDefinition	none
title	string	none
description	string	none
folder	string	none
priority	Priority	none
created_at	Timestamp	none
oneof _deleted_at.deleted_at	optional Timestamp	none
source	Source	Source for creation and management of dataproduct.

​

DeleteRequest

(synq.dataproducts.v1.DeleteRequest)

Field	Type	Description
identifier	DataproductIdentifier	none

​

DeleteResponse

(synq.dataproducts.v1.DeleteResponse)

​

GetRequest

(synq.dataproducts.v1.GetRequest)

Field	Type	Description
identifiers	repeated DataproductIdentifier	none

​

GetResponse

(synq.dataproducts.v1.GetResponse)

Field	Type	Description
products	repeated Dataproduct	none

​

ListRequest

(synq.dataproducts.v1.ListRequest)

Field	Type	Description
include_deleted	bool	none

​

ListResponse

(synq.dataproducts.v1.ListResponse)

Field	Type	Description
products	repeated Dataproduct	none

​

RemoveDefinitionPartRequest

(synq.dataproducts.v1.RemoveDefinitionPartRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
part_id	string	none

​

RemoveDefinitionPartResponse

(synq.dataproducts.v1.RemoveDefinitionPartResponse)

​

SetDefinitionRequest

(synq.dataproducts.v1.SetDefinitionRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
definition	DataproductDefinition	none

​

SetDefinitionResponse

(synq.dataproducts.v1.SetDefinitionResponse)

​

UpsertDefinitionPartRequest

(synq.dataproducts.v1.UpsertDefinitionPartRequest)

Field	Type	Description
product_identifier	DataproductIdentifier	none
part	Part	none

​

UpsertDefinitionPartResponse

(synq.dataproducts.v1.UpsertDefinitionPartResponse)

​

UpsertRequest

(synq.dataproducts.v1.UpsertRequest)

Field	Type	Description
oneof _identifier.identifier	optional DataproductIdentifier	none
title	string	none
description	string	none
folder	string	none
priority	Priority	none
source	Source	none

​

UpsertResponse

(synq.dataproducts.v1.UpsertResponse)

Field	Type	Description
identifier	DataproductIdentifier	identifier of the updated or created dataproduct

​

AssetSelectionQuery

(synq.dataproducts.v1.AssetSelectionQuery)

Field	Type	Description
parts	repeated QueryPart	none
operand	QueryOperand	none

​

AssetSelectionQuery.QueryPart

(synq.dataproducts.v1.AssetSelectionQuery.QueryPart)

Field	Type	Description
oneof part.identifier_list	IdentifierList	none
oneof part.with_name_search	WithNameSearch	none
oneof part.with_type	WithType	none
oneof part.with_annotation	WithAnnotation	none
oneof part.in_data_platform	InDataPlatform	none
oneof part.in_folder	InFolder	none
oneof part.with_data_platform_type	WithDataPlatformType	none
oneof part.query	AssetSelectionQuery	none
oneof part.unsupported	Unsupported	none

​

DataproductDefinition

(synq.dataproducts.v1.DataproductDefinition)

Field	Type	Description
parts	repeated Part	none

​

DataproductDefinition.Part

(synq.dataproducts.v1.DataproductDefinition.Part)

Field	Type	Description
id	string	part identifier
oneof part.identifier	Identifier	none
oneof part.query	AssetSelectionQuery	none

​

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)

​

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)

​

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)

​

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 Synq’s UI.
oneof _id.id	optional string	Read-only Synq ID of matched entity. This is a unique ID that can be used to access the entity in the Synq’s 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	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)

​

BatchDeleteSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsRequest)

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

​

BatchDeleteSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchDeleteSqlTestsResponse)

​

BatchGetSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchGetSqlTestsRequest)

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

​

BatchGetSqlTestsResponse

(synq.datachecks.sqltests.v1.BatchGetSqlTestsResponse)

Field	Type	Description
sql_tests	map SqlTestsEntry	none

​

BatchGetSqlTestsResponse.SqlTestsEntry

(synq.datachecks.sqltests.v1.BatchGetSqlTestsResponse.SqlTestsEntry)

Field	Type	Description
key	string	none
value	SqlTest	none

​

BatchUpsertSqlTestsRequest

(synq.datachecks.sqltests.v1.BatchUpsertSqlTestsRequest)

Field	Type	Description
sql_tests	repeated SqlTest	List of SqlTests to upsert. The upsert is performed based on the unique path provided for each SqlTest.

​

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

​

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.

​

ListSqlTestsResponse

(synq.datachecks.sqltests.v1.ListSqlTestsResponse)

Field	Type	Description
sql_tests	repeated SqlTest	none

​

SqlTest

(synq.datachecks.sqltests.v1.SqlTest) The SqlTest is a SQL test that is executed on a synq 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.
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.

​

SqlTestAudit

(synq.datachecks.sqltests.v1.SqlTestAudit)

Field	Type	Description
execution_id	string	none
rows_count	int32	none
result	string	none
created_at	Timestamp	none

​

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

​

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.

​

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

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.synq_integration_id	string	SYNQ integration ID maps to the created integration on the SYNQ 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

​

MysqlIdentifier

(synq.platforms.v1.MysqlIdentifier)

Field	Type	Description
host	string	Mysql host inclusive of port

​

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)

​

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)

​

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_lineage	map ModelLineageEntry	Data from /api/lineage/
files	bytes	Data from /api/files
file_content	map FileContentEntry	Data from /api/file/
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)

​

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

​

Tag

(synq.ingest.dwh.v1.Tag)

Field	Type	Description
tag_name	string	none
tag_value	string	none

​

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)

​

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)

​

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)

​

GitContext

(synq.ingest.git.v1.GitContext)

Field	Type	Description
clone_url	string	none
branch	string	none
commit_sha	string	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

​

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	none
limit_to_files	repeated string	none

​

GetDiffByCommitResponse

(synq.git.commits.v1.GetDiffByCommitResponse)

Field	Type	Description
oneof _commit_diff.commit_diff	optional CommitDiff	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

​

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

​

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

​

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

​

WorkflowRun

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

Field	Type	Description
workspace	string	none
results	repeated CommandResult	none
status	Status	none
started_at	Timestamp	none
ended_at	Timestamp	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

​

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)

​

SynchronizeRequest

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

​

SynchronizeResponse

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

Field	Type	Description
workflow_run	WorkflowRun	none
has_errors	bool	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

​

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

​

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

​

Enums

​

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_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_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_INTEGRATION_EDIT	80	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_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

​

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_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_REDSHIFT_TABLE	803	none
ENTITY_TYPE_REDSHIFT_VIEW	805	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_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_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_CUSTOM_ENTITY_GENERIC	50000	none
ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN	50001	none
ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX	59999	none

​

EntityChangeType

(synq.entities.v1.EntityChangeType)

Name	Number	Description
ENTITY_CHANGE_TYPE_UNSPECIFIED	0	none
ENTITY_CHANGE_TYPE_GIT_COMMIT	1	none
ENTITY_CHANGE_TYPE_SQL_DEFINITION_CHANGE	2	none
ENTITY_CHANGE_TYPE_SCHEMA_CHANGE	3	none

​

CodeType

(synq.entities.v1.CodeType) CodeType enum represents different types of code that can be processed in the Synq platform

Name	Number	Description
CODE_TYPE_UNSPECIFIED	0	Default unspecified value
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 similiar to SQL code.
CODE_TYPE_LOOKML	7	LookML (Looker Modeling Language) files

​

SqlDialect

(synq.entities.v1.SqlDialect)

Name	Number	Description
SQL_DIALECT_UNSPECIFIED	0	none
SQL_DIALECT_BIGQUERY	1	none
SQL_DIALECT_CLICKHOUSE	2	none
SQL_DIALECT_DATABRICKS	3	none
SQL_DIALECT_MYSQL	4	none
SQL_DIALECT_POSTGRESQL	5	none
SQL_DIALECT_REDSHIFT	6	none
SQL_DIALECT_SNOWFLAKE	7	none
SQL_DIALECT_DUCKDB	8	none
SQL_DIALECT_TRINO	9	none

​

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

​

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

​

LineageDirection

(synq.entities.lineage.v1.LineageDirection) Direction of the lineage to query.

Name	Number	Description
LINEAGE_DIRECTION_UNSPECIFIED	0	none
LINEAGE_DIRECTION_UPSTREAM	1	none
LINEAGE_DIRECTION_DOWNSTREAM	2	none
LINEAGE_DIRECTION_UPSTREAM_DOWNSTREAM	3	none

​

CllState

(synq.entities.lineage.v1.CllState)

Name	Number	Description
CLL_STATE_UNSPECIFIED	0	Unspecified state.
CLL_STATE_PARSE_FAILED	1	Parsing of the asset SQL failed. No upstream dependencies can be found.
CLL_STATE_EXTRACTION_FAILED	2	Extraction of the asset SQL failed. Some unsupported SQL features may be used. Some details might be missing.
CLL_STATE_RESOLUTION_FAILED	3	Not all columns or tables were found upstream, lineage is not complete.
CLL_STATE_OK	10	No known issues present.

​

NodePosition

(synq.entities.lineage.v1.NodePosition)

Name	Number	Description
NODE_POSITION_UNSPECIFIED	0	none
NODE_POSITION_START_NODE	1	Node is one of the requested start point.
NODE_POSITION_UPSTREAM	2	Node is upstream of the requested start point.
NODE_POSITION_DOWNSTREAM	3	Node is downstream of the requested start point.

​

Domain.Source

(synq.domains.v1.Domain.Source)

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

​

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

​

TestSuggestionStatus

(synq.agent.sre.v1.TestSuggestionStatus)

Name	Number	Description
TEST_SUGGESTION_STATUS_UNSPECIFIED	0	none
TEST_SUGGESTION_STATUS_SCHEDULED	1	none
TEST_SUGGESTION_STATUS_RUNNING	2	none
TEST_SUGGESTION_STATUS_COMPLETED	3	none
TEST_SUGGESTION_STATUS_FAILED	4	none
TEST_SUGGESTION_STATUS_CANCELLED	5	none

​

IssueTriageStatus

(synq.agent.sre.v1.IssueTriageStatus) IssueTriageStatus represents the current stage of an issue in the SRE agent’s investigation workflow. The status progresses as the agent collects evidence and reaches conclusions about the issue.

Name	Number	Description
ISSUE_TRIAGE_STATUS_UNSPECIFIED	0	Default value, should not be used
ISSUE_TRIAGE_STATUS_SCHEDULED	1	Issue has been queued for investigation but the SRE agent has not started processing it yet
ISSUE_TRIAGE_STATUS_IN_PROGRESS	2	SRE agent is actively investigating the issue, collecting evidence and analyzing the situation
ISSUE_TRIAGE_STATUS_CANCELLED	7	Issue has been scheduled but later cancelled
ISSUE_TRIAGE_STATUS_FAILED	8	Issue wasn’t triaged as such process failed. Scheduling again is possible.
ISSUE_TRIAGE_STATUS_TRIAGED	3	SRE agent has generated conclusion for the issue
ISSUE_TRIAGE_STATUS_ACCEPTED	4	User accepted the issue conclusion SRE agent has determined
ISSUE_TRIAGE_STATUS_IGNORED	5	User Discarded the issue conclusion SRE agent has determined
ISSUE_TRIAGE_STATUS_CLOSED	6	Issue was closed by the system

​

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

​

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. These are all the issues that do not satisfy the following states.
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_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

​

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

​

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

​

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

​

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

​

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

​

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

​

QueryOperand

(synq.queries.v1.QueryOperand)

Name	Number	Description
QUERY_OPERAND_UNSPECIFIED	0	default to AND behaviour
QUERY_OPERAND_AND	1	none
QUERY_OPERAND_OR	2	none
QUERY_OPERAND_EXCEPT	3	none
QUERY_OPERAND_UPSTREAM	4	none
QUERY_OPERAND_DOWNSTREAM	5	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

​

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_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_SYNQ	1000	none

​

Status

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

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