> ## Documentation Index > Fetch the complete documentation index at: https://docs.synq.io/llms.txt > Use this file to discover all available pages before exploring further. # ListIssues ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/issues/v2 openapi: 3.1.0 info: version: '1.0' title: SYNQ servers: - url: https://developer.synq.io - url: https://api.us.synq.io - url: https://api.au.synq.io security: - bearerAuth: [] tags: - name: synq.deliveries.v1.DeliveriesService description: >- DeliveriesService reports what was sent to your notification integrations — webhooks, PagerDuty, Opsgenie — and what came back. It answers the three questions an integration owner has. "Did this event reach my endpoint": list the deliveries for an event id and read the outcome of each. "Why did my endpoint reject it": read the attempts, which carry the request as it was sent and the response as it came back. "Why did I get nothing at all": every delivery that sent nothing records a reason, so a silent integration can be explained rather than guessed at. Deliveries are kept for 90 days. Credential-bearing header values are never returned, on either side of an attempt — see `Header`. - name: synq.ingest.cloudwatch.v1.CloudwatchService - name: synq.ingest.dwh.v1.DwhService - name: synq.ingest.openlineage.v1.OpenlineageService - name: synq.ingest.airflow.v1.AirflowLogsService - name: synq.alerts.services.v1.AlertsService description: |- AlertsService provides operations for managing alert configurations. Deprecated: use synq.alerts.services.v2.AlertsService. The v2 service selects entities with the canonical synq.queries.v1.Query + resolver_ql trigger; this v1 service, which uses the bespoke EntityGroupQuery selection, is scheduled for removal. Migrate existing integrations to v2. - name: synq.alerts.services.v2.AlertsService description: |- AlertsService provides operations for managing alert configurations. It supersedes synq.alerts.services.v1.AlertsService: entities are selected with the canonical synq.queries.v1.Query + resolver_ql trigger rather than the bespoke EntityGroupQuery. - name: synq.entities.folders.v1.FoldersService description: >- FoldersService discovers and browses the folder / containment hierarchy of the catalog: the roots data hangs from, the sub-folders under any folder, the folders a given entity lives in, and the entities contained in a folder. It is a read / navigation surface, not folder management — there are no create, move, or delete operations. Addressing: every folder has an opaque `folder_entity_id` (round-trip it verbatim) and a structured `FolderRef{root_entity_id, folders[]}` (the human-friendly form). Entities — both folder members and the ids you pass to `GetFolderOf` — are named by their opaque entity id, the same id used across the rest of the entities API. Depth footgun: membership is SHALLOW by default. `Browse` returns only the direct children of a folder, and `ListMembers` returns only the entities placed directly in the folder. Set `deep = true` (or raise `Browse.depth`) to recurse into sub-folders. - name: synq.entities.typedefs.v1.TypeDefsService description: >- TypeDefsService tells you what the type values in every other endpoint mean. Responses across the API describe things by enum — an entity is an `ENTITY_TYPE_BQ_TABLE`, it belongs to `DATA_PLATFORM_TYPE_BIGQUERY`, a run is an `EXECUTION_TYPE_DBT_INVOCATION`. This service turns each of those into a name you can display and a set of facts you can act on: is this a transformation model, does it live in a warehouse, can it be monitored. Read it instead of keeping your own copy of the list. New entity types and new platforms are added as Coalesce Quality supports more tools, and a hard-coded table in your code will label them with whatever its fallback produces and miss that an existing type gained a capability. Everything here comes from the server, so you pick both up without changing your code. A typical integration calls them once at startup, keeps them in a map, and looks types up as responses arrive. It also tells you what a selection query can ask for: ListEntityTraitDefs is the vocabulary behind `traits`, which selects entities by what they are rather than by naming every type. Scoping and freshness: * ListEntityTypeDefs is per workspace, because the types you defined yourself are part of your workspace's vocabulary. It returns the built-in types and your own custom types together. * ListPlatformDefs, ListExecutionTypeDefs and ListEntityTraitDefs are the same for everyone. * The built-in half changes only when Coalesce Quality is upgraded, so caching it for the life of your process is fine. You can add or edit your own custom types at any time, so if a newly created type needs to appear promptly, cache the entity types for minutes rather than hours, or re-read after you change one. The workspace comes from your credentials; there is nothing to pass. Each list is small — hundreds of entries — so every call returns the whole set and none of them page. - name: synq.entities.entities.v1.EntitiesService description: EntitiesService is a service for retriving any entity. - name: synq.entities.checks.v1.ChecksCategoriesService description: |- ChecksCategoriesService lets workspace admins set explicit category overrides on individual checks. An explicit category is the authoritative category for a check — it takes precedence over the categories computed by the workspace's categorisation rules. It is a public API so customers can manage check categories programmatically; the same service is also mounted on the internal API. The workspace and the acting identity are always taken from the request context, never from the payload. - name: synq.entities.checks.v2.ChecksCategorisationRulesService description: |- ChecksCategorisationRulesService manages the rules that categorise a workspace's checks automatically. A rule says "checks matching this predicate get this category on this dimension". Rules are the scalable way to categorise: they apply to checks that already exist and to every check ingested afterwards, so a new dbt package or a new warehouse does not mean a fresh round of manual tagging. A rule-computed category is the lowest-precedence source — a category set explicitly on a check through ChecksCategoriesService, and one the producing tool declared, both win over it. A typical loop is: ListCategorisationFilters to see what the workspace's checks look like, PreviewRule to check the reach of a candidate, UpsertRule to save it, then GetRecategorisationStatus to confirm the existing checks have caught up. Every workspace starts with a set of platform-provided rules covering the common cases. They are visible here, they can be superseded by a workspace rule of any priority, and they cannot be edited from a workspace. - name: synq.entities.checks.v2.ChecksCategoriesService description: |- ChecksCategoriesService reads and edits the categories of the checks in a workspace. Categorising checks is what turns a long list of tests into a picture of data quality: it lets you ask how much of a data product is covered for completeness, or which freshness checks exist across three warehouses that each name the same idea differently. Every check resolves to at most one category per dimension: * technical — what kind of check this is, mechanically ("nullness", "uniqueness", "freshness"); * governance — what the check is for, in data-quality terms ("Completeness", "Accuracy", "Timeliness"). The two are independent, and each resolves from three sources, in descending precedence: a category set explicitly on the check through this service, a category the producing tool declared, and a category one of the workspace's categorisation rules computed. Rules are managed by ChecksCategorisationRulesService and are the right tool for anything that generalises; set a category explicitly only for the checks that are genuine exceptions. The workspace and the acting identity always come from the request credentials, never from the payload. - name: synq.entities.code.v1.CodeService description: >- CodeService is a service for retrieving code associated with entities in the system. It provides functionality to access and manage code artifacts such as SQL queries, Python scripts, dbt models, and other code configurations that are part of Coalesce Quality entities. - name: synq.entities.schemas.v1.SchemaMismatchesService description: >- SchemaMismatchesService provides access to schema drift information between data platform tables and their definitions (e.g., dbt models). - name: synq.entities.schemas.v1.SchemasService description: EntitiesService is a service for retriving any entity. - name: synq.entities.constraints.v1.TableConstraintsService description: >- TableConstraintsService provides access to table constraint and index information. - name: synq.entities.sql_insights.v1.SqlInsightsService description: >- SqlInsightsService exposes analytical information about the SQL used across a workspace's entities. It answers questions such as "which SQL constructs are used in my warehouse, and by how many entities" and "what SQL constructs does this specific entity use", without requiring the caller to re-parse any SQL. - name: synq.entities.orchestration.v1.OrchestrationService description: >- OrchestrationService provides information about orchestration relationships between entities. This includes relationships between Airflow tasks and transformation models (dbt, SQLMesh), as well as task-to-task dependencies. - name: synq.entities.resolve.v1.IdentifierResolveService description: >- IdentifierResolveService resolves identifiers to their Coalesce Quality paths and identities. - name: synq.entities.status.v1.EntityIssuesService description: EntityIssuesService is the service which retrieves entity issues status. - name: synq.entities.status.v1.EntityIncidentsService description: EntityIncidentsService is the service which retrieves entity status. - name: synq.entities.changes.v1.ChangesService description: >- ChangesService provides functionality to track and retrieve all types of changes to data entities. This unified service returns ALL change types for an entity: - Git commits: Changes to code files (dbt models, SQL files) tracked in version control - Schema changes: Database schema modifications (columns added/removed/changed) - SQL definition changes: View/materialized view definition updates detected by Coalesce Quality Changes are returned with structured metadata including: - For git commits: structured statistics (directories, file types, top changes) - For schema changes: detailed column-level diffs - For SQL changes: before/after SQL definitions Use cases: - "What changed in the last week for table X?" → Returns git commits, schema changes, SQL changes - "Show me all commits affecting this dbt model" → Returns git commits with lineage context - "What schema changes happened to this table?" → Returns schema changes detected by Coalesce Quality - name: synq.entities.annotations.v1.AnnotationsService description: >- AnnotationsService provides operations for managing and querying entity annotations. Annotations are key-value pairs that can be attached to entities for categorization and filtering. - name: synq.entities.lineage.v1.LineageService description: |- 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. - name: synq.entities.custom.v1.EntityExecutionsService - name: synq.entities.custom.v1.GroupsService description: >- 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. - name: synq.entities.custom.v1.EntitiesService description: >- custom.EntitiesService is a service for managing custom entities. Entities can represent various data platform concepts such as services, consumers, applications or data pipelines that are not natively available in Coalesce Quality. Entities are identified by a unique identifier and can be created, updated, read and deleted. - name: synq.entities.custom.v1.TypesService description: TypesService is a service for managing custom entity types. - name: synq.entities.custom.v1.RelationshipsService description: >- RelationshipsService allow management of relationships between entities. Relationships can be created, updated, and deleted between 2 custom entities, or between a custom entity and Coalesce Quality native entity.enum There is no option to create relationships between 2 Coalesce Quality native entities (dbt model, BI dashboard, etc.). - name: synq.entities.custom.v1.ChecksRelationshipsService - name: synq.entities.custom.v1.FeaturesService - name: synq.entities.impact.v1.ImpactService - name: synq.entities.executions.v1.EntityExecutionsService description: 'Deprecated: Use [synq.entities.custom.v1.EntityExecutionsService] instead' - name: synq.entities.executions.v2.EntityExecutionsService description: >- EntityExecutionsService provides read-only access to entity execution history. This service allows customers to retrieve information about all executions that happened on their entities, including execution status, timing, and messages. Use cases: - Retrieve execution history for specific entities - Filter executions by time range, status, or execution type - Get aggregated summaries of execution activity - Track execution trends and patterns - name: synq.entities.coordinates.v1.DatabaseCoordinatesService description: >- DatabaseCoordinatesService is a service for getting database coordinates of Entities. - name: synq.overlays.v1.OverlaysService description: |- OverlaysService answers which organizational overlays claim an entity. An overlay is a grouping you lay over your catalog rather than something the warehouse itself knows about. Two kinds exist today: a **data product**, which groups the assets that make up something your organization delivers, and an **owner**, which names the person or team responsible for a set of assets and where alerts about them go. Each is defined by a membership rule, not by an explicit list, so what belongs to one changes as your warehouse does. "Owner" here means stewardship — who is accountable for an asset and who hears about it when something breaks. It is not the structural containment sense the word carries elsewhere in the API, where an asset can be said to own the checks and monitors declared on it. Nothing this service returns describes that relationship. This service reads that membership backwards. The defining services answer "what is in this data product"; this one answers "which data products and owners claim this table" — the question you have when you are looking at one asset and want to know who cares about it and what it feeds. Membership follows identity. Where the same table is represented more than once in your catalog — a transformation model and the warehouse table it builds — an overlay whose rule matches one of them claims the others too. So an alert routed by ownership reaches the responsible party whichever representation raised it, and you do not have to know which one a rule was written against. Two consequences worth planning around. You can ask about whichever representation you happen to hold and get the same answer, so there is no need to resolve an identity group first. And if you do ask about several members of one group in a single call, each comes back with its own entry carrying the same overlays — correct, but redundant, so ask about one member per group when you are near the request limit. Related services: - `synq.dataproducts.v2.DataproductsService` and `synq.owners.v1.OwnersService` define the overlays read here, and turn an id from a response into a name, a description and its contact channels. - `synq.entities.resolve.v1.IdentifierResolveService` turns an identifier you already hold — a warehouse table name, a dbt model — into the `entity_id` these calls take. - name: synq.monitors.history.v1.HistoryService - name: synq.monitors.info.v1.MonitorInfoService - name: synq.monitors.predictions.v1.MonitorPredictionsService description: Access to anomaly detection model predictions and raw metric timeseries. - name: synq.monitors.automated_monitors.v1.DeploymentRulesService - name: synq.monitors.custom_monitors.v1.CustomMonitorsService - name: synq.monitors.segments.v1.MonitorSegmentsService description: |- Reads and names the segments of a segmented custom monitor. A monitor configured with a segmentation expression splits the data it monitors into one time series per distinct value of that expression, and each of those is a segment. The label is what every downstream surface shows for a segment: the name of the check it produces, the search result, the alert. A segment with no label falls back to its raw value, so a monitor segmented on something encoded (an id, a code, a hashed bucket) reads as that raw value everywhere until the segment is named. - name: synq.queries.v1.NLQueryService description: >- NLQueryService generates structured Query protos from natural language descriptions using an LLM. - name: synq.queries.v1.QueriesService description: |- QueriesService compiles and evaluates ResolverQL — the compact text query language used across Coalesce Quality to select entities — over the public API. ResolverQL is a string DSL (for example `with_type("TABLE")` or `in_folder(...)`); a structured `synq.queries.v1.Query` is its parsed, machine-readable form. This service is the bridge between the two and the read-only execution surface for both: - `TranslateResolverQl` compiles a ResolverQL expression into a structured `Query` without evaluating it — inspect it, validate it, or reuse it as a filter on another API (entity listing, folder browsing, ...). - `ResolveQuery` compiles a ResolverQL expression (or takes an already-structured `Query`), evaluates it against the catalog, and returns the matched entity ids. This is the general author -> resolve loop. - `DescribeResolverQl` returns the language itself — every function, every accepted enum value — so you author against what this deployment compiles rather than against a table baked into your client. All three authenticate and resolve your workspace from your credentials. `DescribeResolverQl` additionally needs no permission of its own, so any credential can read it; the other two read the catalog and are scoped. - name: synq.datachecks.v1.TriggerService description: TriggerService provides synchronous execution of datachecks on entities. - name: synq.datachecks.sqltests.v1.SqlTestsService description: SqlTestsService is a service for managing SqlTests. - name: synq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService description: |- SqlTestsDeploymentRulesService manages SqlTestDeploymentRules — rules that dynamically deploy SQL test templates onto every table or view a query matches, resyncing over time as the match set changes. - name: synq.datachecks.testsuggestions.v1.TestSuggestionsService - name: synq.integrations.v1.IntegrationsService description: |- IntegrationsService manages connections from Coalesce Quality to your data systems (warehouses, databases, and transformation tools). Concurrency: every integration carries an opaque `etag`. Read it from `GetIntegration` / `ListIntegrations`, then pass it back on `UpdateIntegration` / `DeleteIntegration` to ensure you modify the version you last saw. A stale etag is rejected with ABORTED (HTTP 409). Omit the etag for last-write-wins. Quota: each workspace has a limit on the number of integrations. Creating beyond the limit is rejected with RESOURCE_EXHAUSTED. Secrets: credential fields (passwords, tokens, keys) are write-only. They are masked (returned empty) on every read. On update, omit a secret to keep it, send a new value to rotate it, or send an explicit empty string to clear it (where the field is `optional`). - name: synq.issues.issues.v1.IssuesService description: IssuesService is a service for managing Issues. - name: synq.issues.v2.IssuesService description: IssuesService is a service for managing Issues. - name: synq.dataproducts.v1.DataproductsService description: DataproductsService can be used to manage data products. - name: synq.dataproducts.v2.DataproductsService description: |- DataproductsService manages data products — named, owned groupings of data assets with a membership definition, a priority and an optional folder. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on Upsert: a field that is set is written, a field that is omitted is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. A data product is a leaf in the reference graph — its definition may not reference another data product or domain — so membership resolution always terminates. - name: synq.schedule.v1.ScheduleService description: ScheduleService provides schedule evaluation utilities. - name: synq.owners.v1.OwnersService description: |- OwnersService manages owners and their ownerships — the "alert routing as code" surface. An owner is a named responsible party with notification channels (contacts); an ownership assigns a set of assets to an owner and configures the alerts routed to it. Owner is the resource, ownership its sub-resource: an ownership is meaningless without its owner, and deleting an owner deletes its ownerships. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on the Upsert calls: a set field is written, an omitted field is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. Related: `synq.dataproducts.v2.DataproductsService` (an ownership can own a whole data product), `synq.alerts.v1.AlertsService` (how the configured alerts are reported), and `synq.users.v1.UsersService` (resolve the users behind `UserContact` and Slack/Teams mentions). - name: synq.agent.sre.v1.LlmService description: Service for evaluating LLM requests and producing structured output. - name: synq.agent.sre.v1.TriageService description: >- Service for managing issue triage operations, allowing LLM agents to conclude investigations and record evidence during the triage process. - name: synq.agent.sre.v1.FeatureRequestService description: >- FeatureRequestService allows MCP clients to submit feature requests when users encounter missing capabilities. This is a last-resort service — it should only be used when no existing tool can fulfill the user's request. - name: synq.agent.recon.v1.YamlService description: >- YamlService provides stateless conversion between YAML config format and proto. This is useful for UI editors that need to display/edit suite configs as YAML. - name: synq.agent.recon.v1.SuiteDeploymentService description: |- SuiteDeploymentService is the platform plane of reconciliation. SuiteConfigService is the developer/authoring sandbox (edit, version, run ad-hoc with your own credentials — preview-only, no Entity, no Run, no Issue). A deployment is what SYNQ actually runs on the workspace's behalf: a frozen snapshot of a suite config, mapped to workspace-level SYNQ integrations, optionally scheduled or triggerable by API. Identity: every deployment has a stable deployment_id (UUIDv7) assigned on first promote. It survives re-promotes, schedule/mapping changes, and pause/resume. Downstream AssetCommand / RunCommand publication keys off deployment_id so Entity identity does not fragment on promote churn. - name: synq.savedviews.v1.SavedViewsService description: >- SavedViewsService manages saved views — named, reusable selections over your entities (and other surfaces) with display configuration, sharing and per-user pinning. A saved view is owned by the user who created it. It can be kept private, shared with the whole workspace, or granted to specific users. Reads return, for the calling user, how each view relates to them (mine / shared / granted) and what they are allowed to do with it. Workspace administrators can manage any view in the workspace. - name: synq.auth.iam.v1.IamService - name: synq.platforms.v1.PlatformsService description: PlatformsService is a service for managing Platforms and Integrations. - name: synq.incidents.v1.IncidentsService description: IncidentsService is a service for managing Incidents. - name: synq.git.commits.v1.CommitsService - name: synq.domains.v1.DomainsService description: DomainsService can be used to manage domains. - name: synq.domains.v2.DomainsService description: >- DomainsService manages data domains — named areas of ownership that group the assets, data products and sub-domains belonging to one part of the business. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on Upsert: a field that is set is written, a field that is omitted is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. A domain may contain other domains and data products, so membership resolution is recursive. Every write that adds such a reference — including a change of `parent_id` — is rejected if it would close a loop, so a definition can always be resolved in finite time. - name: synq.domains.members.v1.DomainMembersService description: DomainMembersService can be used to manage domain memberships. - name: synq.extensions.atlan.integrations.v1.AtlanIntegrationService - name: synq.extensions.atlan.workflows.v1.AtlanWorkflowService - name: synq.extensions.atlan.provider.v1.AtlanProviderService paths: /api/issues/v2: get: tags: - synq.issues.v2.IssuesService summary: ListIssues operationId: synq.issues.v2.IssuesService.ListIssues parameters: - name: entitiesQuery.parts.identifierList.identifiers.entityId in: query description: >- Opaque id of the entity, set on every identifier the API returns. Round-trip it verbatim; the format is not part of this contract and may change, and it is never constructed by hand. OUTPUT ONLY. On a request this field is ignored — the structured variant is what resolves. That is what lets you hand an identifier straight back unchanged, or edit its structured fields, without the two disagreeing about which entity you meant. To name an entity BY opaque id on a request, set the `synq_path` variant to that id: it carries exactly this string, and it is also how an entity whose platform has no structured variant is named. schema: type: string title: entity_id maxLength: 1024 description: >- Opaque id of the entity, set on every identifier the API returns. Round-trip it verbatim; the format is not part of this contract and may change, and it is never constructed by hand. OUTPUT ONLY. On a request this field is ignored — the structured variant is what resolves. That is what lets you hand an identifier straight back unchanged, or edit its structured fields, without the two disagreeing about which entity you meant. To name an entity BY opaque id on a request, set the `synq_path` variant to that id: it carries exactly this string, and it is also how an entity whose platform has no structured variant is named. - name: >- entitiesQuery.parts.identifierList.identifiers.dbtCoreNode.integrationId in: query description: >- Opaque identifier of the dbt Core project. Usually the Coalesce Quality integration id (a UUID), but may also be the dbt project name from manifest.json when the integration is configured to identify assets by project name. Treat it as an opaque string, not a UUID. required: true schema: type: string title: integration_id description: >- Opaque identifier of the dbt Core project. Usually the Coalesce Quality integration id (a UUID), but may also be the dbt project name from manifest.json when the integration is configured to identify assets by project name. Treat it as an opaque string, not a UUID. - name: entitiesQuery.parts.identifierList.identifiers.dbtCoreNode.nodeId in: query description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) required: true schema: type: string title: node_id description: >- Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) - name: >- entitiesQuery.parts.identifierList.identifiers.dbtCloudNode.projectId in: query description: Your dbt Cloud project id required: true schema: type: string title: project_id description: Your dbt Cloud project id - name: >- entitiesQuery.parts.identifierList.identifiers.dbtCloudNode.accountId in: query description: Your dbt Cloud account id schema: type: string title: account_id description: Your dbt Cloud account id - name: entitiesQuery.parts.identifierList.identifiers.dbtCloudNode.nodeId in: query description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) required: true schema: type: string title: node_id description: >- Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) - name: entitiesQuery.parts.identifierList.identifiers.bigqueryTable.project in: query description: BigQuery project required: true schema: type: string title: project description: BigQuery project - name: entitiesQuery.parts.identifierList.identifiers.bigqueryTable.dataset in: query description: BigQuery dataset id required: true schema: type: string title: dataset description: BigQuery dataset id - name: entitiesQuery.parts.identifierList.identifiers.bigqueryTable.table in: query description: BigQuery table name required: true schema: type: string title: table description: BigQuery table name - name: >- entitiesQuery.parts.identifierList.identifiers.snowflakeTable.account in: query description: Snowflake account required: true schema: type: string title: account description: Snowflake account - name: >- entitiesQuery.parts.identifierList.identifiers.snowflakeTable.database in: query description: Snowflake database required: true schema: type: string title: database description: Snowflake database - name: entitiesQuery.parts.identifierList.identifiers.snowflakeTable.schema in: query description: Snowflake schema required: true schema: type: string title: schema description: Snowflake schema - name: entitiesQuery.parts.identifierList.identifiers.snowflakeTable.table in: query description: Snowflake table required: true schema: type: string title: table description: Snowflake table - name: entitiesQuery.parts.identifierList.identifiers.redshiftTable.cluster in: query description: Redshift cluster schema: type: string title: cluster description: Redshift cluster - name: >- entitiesQuery.parts.identifierList.identifiers.redshiftTable.database in: query description: Redshift database required: true schema: type: string title: database description: Redshift database - name: entitiesQuery.parts.identifierList.identifiers.redshiftTable.schema in: query description: Redshift schema required: true schema: type: string title: schema description: Redshift schema - name: entitiesQuery.parts.identifierList.identifiers.redshiftTable.table in: query description: Redshift table required: true schema: type: string title: table description: Redshift table - name: entitiesQuery.parts.identifierList.identifiers.postgresTable.host in: query description: Postgres hostname without port required: true schema: type: string title: host description: Postgres hostname without port - name: >- entitiesQuery.parts.identifierList.identifiers.postgresTable.database in: query description: Postgres database required: true schema: type: string title: database description: Postgres database - name: entitiesQuery.parts.identifierList.identifiers.postgresTable.schema in: query description: Postgres schema required: true schema: type: string title: schema description: Postgres schema - name: entitiesQuery.parts.identifierList.identifiers.postgresTable.table in: query description: Postgres table required: true schema: type: string title: table description: Postgres table - name: entitiesQuery.parts.identifierList.identifiers.mysqlTable.host in: query description: Mysql hostname without port required: true schema: type: string title: host description: Mysql hostname without port - name: entitiesQuery.parts.identifierList.identifiers.mysqlTable.schema in: query description: Mysql database required: true schema: type: string title: schema description: Mysql database - name: entitiesQuery.parts.identifierList.identifiers.mysqlTable.table in: query description: Mysql table required: true schema: type: string title: table description: Mysql table - name: entitiesQuery.parts.identifierList.identifiers.clickhouseTable.host in: query description: Clickhouse hostname without port required: true schema: type: string title: host description: Clickhouse hostname without port - name: >- entitiesQuery.parts.identifierList.identifiers.clickhouseTable.schema in: query description: Clickhouse database required: true schema: type: string title: schema description: Clickhouse database - name: entitiesQuery.parts.identifierList.identifiers.clickhouseTable.table in: query description: Clickhouse table required: true schema: type: string title: table description: Clickhouse table - name: >- entitiesQuery.parts.identifierList.identifiers.airflowDag.integrationId in: query description: Coalesce Quality integration_id that identifies the Airflow instance required: true schema: type: string title: integration_id description: >- Coalesce Quality integration_id that identifies the Airflow instance - name: entitiesQuery.parts.identifierList.identifiers.airflowDag.dagId in: query description: Airflow dag_id that identifies the DAG required: true schema: type: string title: dag_id description: Airflow dag_id that identifies the DAG - name: >- entitiesQuery.parts.identifierList.identifiers.airflowTask.integrationId in: query description: Coalesce Quality integration_id that identifies the Airflow instance required: true schema: type: string title: integration_id description: >- Coalesce Quality integration_id that identifies the Airflow instance - name: entitiesQuery.parts.identifierList.identifiers.airflowTask.dagId in: query description: Airflow dag_id that identifies the DAG required: true schema: type: string title: dag_id description: Airflow dag_id that identifies the DAG - name: entitiesQuery.parts.identifierList.identifiers.airflowTask.taskId in: query description: Airflow task_id that identifies the task within the DAG required: true schema: type: string title: task_id description: Airflow task_id that identifies the task within the DAG - name: entitiesQuery.parts.identifierList.identifiers.custom.id in: query description: |- Id that identifies the custom entity The Id should be unique within the custom entity Identifier. required: true schema: type: string title: id description: |- Id that identifies the custom entity The Id should be unique within the custom entity Identifier. - name: entitiesQuery.parts.identifierList.identifiers.dataproduct.id in: query description: Dataproduct id that identifies the Dataproduct required: true schema: type: string title: id format: uuid description: Dataproduct id that identifies the Dataproduct - name: entitiesQuery.parts.identifierList.identifiers.synqPath.path in: query description: >- Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths required: true schema: type: string title: path description: >- Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths - name: >- entitiesQuery.parts.identifierList.identifiers.databricksTable.workspace in: query description: URL of Databricks workspace required: true schema: type: string title: workspace description: URL of Databricks workspace - name: >- entitiesQuery.parts.identifierList.identifiers.databricksTable.catalog in: query description: Databricks catalog required: true schema: type: string title: catalog description: Databricks catalog - name: >- entitiesQuery.parts.identifierList.identifiers.databricksTable.schema in: query description: Databricks schema required: true schema: type: string title: schema description: Databricks schema - name: entitiesQuery.parts.identifierList.identifiers.databricksTable.table in: query description: Databricks table or view required: true schema: type: string title: table description: Databricks table or view - name: entitiesQuery.parts.identifierList.identifiers.trinoTable.host in: query description: Hostname of the Trino instance required: true schema: type: string title: host description: Hostname of the Trino instance - name: entitiesQuery.parts.identifierList.identifiers.trinoTable.catalog in: query description: Trino catalog required: true schema: type: string title: catalog description: Trino catalog - name: entitiesQuery.parts.identifierList.identifiers.trinoTable.schema in: query description: Trino schema required: true schema: type: string title: schema description: Trino schema - name: entitiesQuery.parts.identifierList.identifiers.trinoTable.table in: query description: Trino table or view required: true schema: type: string title: table description: Trino table or view - name: >- entitiesQuery.parts.identifierList.identifiers.sqlMeshModel.integrationId in: query description: Coalesce Quality integration_id that identifies the dbt Core project required: true schema: type: string title: integration_id format: uuid description: >- Coalesce Quality integration_id that identifies the dbt Core project - name: entitiesQuery.parts.identifierList.identifiers.sqlMeshModel.fqn in: query description: SQLMesh model fully qualified name required: true schema: type: string title: fqn description: SQLMesh model fully qualified name - name: >- entitiesQuery.parts.identifierList.identifiers.sqlMeshAudit.integrationId in: query description: Coalesce Quality integration_id that identifies the dbt Core project required: true schema: type: string title: integration_id format: uuid description: >- Coalesce Quality integration_id that identifies the dbt Core project - name: entitiesQuery.parts.identifierList.identifiers.sqlMeshAudit.fqn in: query description: SQLMesh model fully qualified name required: true schema: type: string title: fqn description: SQLMesh model fully qualified name - name: entitiesQuery.parts.identifierList.identifiers.sqlMeshAudit.auditId in: query description: Identifier of the audit required: true schema: type: string title: audit_id description: Identifier of the audit - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.host in: query description: Hostname of the SQL Server instance required: true schema: type: string title: host description: Hostname of the SQL Server instance - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.database in: query description: SQL Server database required: true schema: type: string title: database description: SQL Server database - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.schema in: query description: SQL Server schema (e.g. "dbo") required: true schema: type: string title: schema description: SQL Server schema (e.g. "dbo") - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.mssqlTable.table in: query description: SQL Server table or view required: true schema: type: string title: table description: SQL Server table or view - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.host in: query description: Hostname of the Oracle instance required: true schema: type: string title: host description: Hostname of the Oracle instance - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.serviceName in: query description: Oracle service name (PDB) required: true schema: type: string title: service_name description: Oracle service name (PDB) - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.schema in: query description: Oracle schema (= owning user) required: true schema: type: string title: schema description: Oracle schema (= owning user) - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.oracleTable.table in: query description: Oracle table or view required: true schema: type: string title: table description: Oracle table or view - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.instance in: query description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time. required: true schema: type: string title: instance description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time. - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.catalog in: query description: |- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. required: true schema: type: string title: catalog description: >- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.database in: query description: Glue database (the namespace users typically filter on). required: true schema: type: string title: database description: Glue database (the namespace users typically filter on). - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.athenaTable.table in: query description: Glue table or view name. required: true schema: type: string title: table description: Glue table or view name. - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.savedView.id in: query description: Saved view id (client-supplied UUID) that identifies the saved view required: true schema: type: string title: id format: uuid description: >- Saved view id (client-supplied UUID) that identifies the saved view - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.instance in: query description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". required: true schema: type: string title: instance description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.database in: query description: Fabric warehouse / lakehouse (database). required: true schema: type: string title: database description: Fabric warehouse / lakehouse (database). - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.schema in: query description: Schema within the database. required: true schema: type: string title: schema description: Schema within the database. - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.table in: query description: Table or view name. required: true schema: type: string title: table description: Table or view name. - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.workspaceId in: query description: |- Fabric workspace GUID, decoded from the endpoint host in `instance`. Optional and informational: the table is addressed by instance/database/schema/table, so leave it empty if you don't have it — it does not affect how the identifier resolves. schema: type: string title: workspace_id description: >- Fabric workspace GUID, decoded from the endpoint host in `instance`. Optional and informational: the table is addressed by instance/database/schema/table, so leave it empty if you don't have it — it does not affect how the identifier resolves. - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.fabricTable.tenantId in: query description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance`. Optional and informational, like workspace_id. schema: type: string title: tenant_id description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance`. Optional and informational, like workspace_id. - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.db2Table.host in: query description: Host name of the Db2 server required: true schema: type: string title: host description: Host name of the Db2 server - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.db2Table.database in: query description: Database name or alias, as in `CONNECT TO ` required: true schema: type: string title: database description: Database name or alias, as in `CONNECT TO ` - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.db2Table.schema in: query description: Db2 schema (e.g. "DB2INST1") required: true schema: type: string title: schema description: Db2 schema (e.g. "DB2INST1") - name: >- entitiesQuery.parts.identifierList.identifiers.monitor.monitoredId.db2Table.table in: query description: Db2 table or view required: true schema: type: string title: table description: Db2 table or view - name: entitiesQuery.parts.identifierList.identifiers.monitor.monitorId in: query description: Identifier of the monitor required: true schema: type: string title: monitor_id description: Identifier of the monitor - name: entitiesQuery.parts.identifierList.identifiers.monitor.segment in: query description: Optional monitor segmentation identifier schema: type: string title: segment description: Optional monitor segmentation identifier - name: entitiesQuery.parts.identifierList.identifiers.monitor.integrationId in: query description: Coalesce Quality integration_id of the monitored identifier schema: type: string title: integration_id description: Coalesce Quality integration_id of the monitored identifier deprecated: true - name: entitiesQuery.parts.withNameSearch.searchQuery in: query schema: type: string title: search_query - name: entitiesQuery.parts.withType.type.default in: query description: Default Coalesce Quality types schema: $ref: '#/components/schemas/synq.entities.v1.EntityType' title: default description: Default Coalesce Quality types - name: entitiesQuery.parts.withType.type.custom in: query description: Custom types as defined through synq.entities.custom.v1.TypesService schema: type: integer title: custom format: int32 description: >- Custom types as defined through synq.entities.custom.v1.TypesService - name: entitiesQuery.parts.withType.traits in: query description: |- Traits to select by, instead of — or alongside — naming types. A trait is a property a type has, so `is_monitorable` means "everything a monitor can run on" without listing the forty-odd types that satisfy it today. The list it stands for is worked out each time the selection runs, so a selection saved this way covers a new platform's tables as soon as we support them, and you never have to revisit it. Entities carrying any of the traits match. When `types` is also set the two narrow each other: the entity must be one of the named types AND carry one of the traits. Accepted values, and what each one means, come from the selection-query grammar the API publishes (`describe_resolver_ql`, or the query editor's reference). A name that is not in it selects nothing rather than being ignored, so a typo narrows the result to empty instead of widening it — check a trait against the grammar before storing a selection. In a query written as text this is `with_type(traits="is_monitorable")`, and there a name outside the grammar is rejected outright. A trait may also be a type alias, spelled `alias:` where `` is one of the aliases the grammar lists among the entity types, e.g. `alias:table`. It selects every type the alias stands for, worked out each time the selection runs like any other trait. A selection written as `with_type("table")` is stored this way and reads back with `traits: ["alias:table"]`; writing that back keeps the same selection. In a query written as text an alias is always `with_type("table")`, never `traits="alias:table"`. schema: type: array items: type: string title: traits description: |- Traits to select by, instead of — or alongside — naming types. A trait is a property a type has, so `is_monitorable` means "everything a monitor can run on" without listing the forty-odd types that satisfy it today. The list it stands for is worked out each time the selection runs, so a selection saved this way covers a new platform's tables as soon as we support them, and you never have to revisit it. Entities carrying any of the traits match. When `types` is also set the two narrow each other: the entity must be one of the named types AND carry one of the traits. Accepted values, and what each one means, come from the selection-query grammar the API publishes (`describe_resolver_ql`, or the query editor's reference). A name that is not in it selects nothing rather than being ignored, so a typo narrows the result to empty instead of widening it — check a trait against the grammar before storing a selection. In a query written as text this is `with_type(traits="is_monitorable")`, and there a name outside the grammar is rejected outright. A trait may also be a type alias, spelled `alias:` where `` is one of the aliases the grammar lists among the entity types, e.g. `alias:table`. It selects every type the alias stands for, worked out each time the selection runs like any other trait. A selection written as `with_type("table")` is stored this way and reads back with `traits: ["alias:table"]`; writing that back keeps the same selection. In a query written as text an alias is always `with_type("table")`, never `traits="alias:table"`. - name: entitiesQuery.parts.withAnnotation.name in: query schema: type: string title: name - name: entitiesQuery.parts.withAnnotation.acceptedValue in: query schema: type: string title: accepted_value deprecated: true - name: entitiesQuery.parts.withAnnotation.acceptedValues in: query schema: type: array items: type: string title: accepted_values - name: entitiesQuery.parts.inDataPlatform.identifier.bigquery.project in: query description: BigQuery project required: true schema: type: string title: project description: BigQuery project - name: entitiesQuery.parts.inDataPlatform.identifier.clickhouse.host in: query description: Clickhouse host inclusive of port required: true schema: type: string title: host description: Clickhouse host inclusive of port - name: entitiesQuery.parts.inDataPlatform.identifier.clickhouse.schema in: query description: Clickhouse database required: true schema: type: string title: schema description: Clickhouse database - name: entitiesQuery.parts.inDataPlatform.identifier.snowflake.account in: query description: Snowflake account required: true schema: type: string title: account description: Snowflake account - name: entitiesQuery.parts.inDataPlatform.identifier.snowflake.database in: query description: Snowflake database required: true schema: type: string title: database description: Snowflake database - name: entitiesQuery.parts.inDataPlatform.identifier.redshift.cluster in: query description: Redshift cluster required: true schema: type: string title: cluster description: Redshift cluster - name: entitiesQuery.parts.inDataPlatform.identifier.redshift.database in: query description: Redshift database required: true schema: type: string title: database description: Redshift database - name: entitiesQuery.parts.inDataPlatform.identifier.postgres.host in: query description: Postgres host inclusive of port required: true schema: type: string title: host description: Postgres host inclusive of port - name: entitiesQuery.parts.inDataPlatform.identifier.postgres.database in: query description: Postgres database required: true schema: type: string title: database description: Postgres database - name: entitiesQuery.parts.inDataPlatform.identifier.mysql.host in: query description: Mysql host inclusive of port required: true schema: type: string title: host description: Mysql host inclusive of port - name: entitiesQuery.parts.inDataPlatform.identifier.databricks.workspace in: query description: URL of the databricks workspace required: true schema: type: string title: workspace description: URL of the databricks workspace - name: entitiesQuery.parts.inDataPlatform.identifier.dbtCloud.apiEndpoint in: query description: API endpoint for Dbt Cloud required: true schema: type: string title: api_endpoint description: API endpoint for Dbt Cloud - name: entitiesQuery.parts.inDataPlatform.identifier.dbtCloud.accountId in: query description: Account ID required: true schema: type: string title: account_id description: Account ID - name: entitiesQuery.parts.inDataPlatform.identifier.dbtCloud.projectId in: query description: Project ID required: true schema: type: string title: project_id description: Project ID - name: >- entitiesQuery.parts.inDataPlatform.identifier.sqlMesh.defaultDatabaseInstance in: query description: Default database instance for SQL Mesh required: true schema: type: string title: default_database_instance description: Default database instance for SQL Mesh - name: >- entitiesQuery.parts.inDataPlatform.identifier.duckdb.motherduckAccount in: query schema: type: string title: motherduck_account - name: entitiesQuery.parts.inDataPlatform.identifier.trino.coordinator in: query schema: type: string title: coordinator - name: entitiesQuery.parts.inDataPlatform.identifier.mssql.host in: query description: SQL Server host required: true schema: type: string title: host description: SQL Server host - name: entitiesQuery.parts.inDataPlatform.identifier.mssql.database in: query description: Database name required: true schema: type: string title: database description: Database name - name: entitiesQuery.parts.inDataPlatform.identifier.oracle.host in: query description: Oracle host required: true schema: type: string title: host description: Oracle host - name: entitiesQuery.parts.inDataPlatform.identifier.oracle.serviceName in: query description: Oracle service name (PDB) required: true schema: type: string title: service_name description: Oracle service name (PDB) - name: entitiesQuery.parts.inDataPlatform.identifier.athena.instance in: query description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived by SYNQ from sts:GetCallerIdentity at integration setup time. required: true schema: type: string title: instance description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived by SYNQ from sts:GetCallerIdentity at integration setup time. - name: entitiesQuery.parts.inDataPlatform.identifier.athena.catalog in: query description: |- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. required: true schema: type: string title: catalog description: >- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. - name: entitiesQuery.parts.inDataPlatform.identifier.fabric.instance in: query description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". Identifies the Fabric workspace the integration connects to. Fabric is workspace-scoped with cross-database queries, so the workspace host alone identifies the platform (like Databricks' workspace URL); a specific warehouse/table is addressed by FabricTableIdentifier. required: true schema: type: string title: instance description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". Identifies the Fabric workspace the integration connects to. Fabric is workspace-scoped with cross-database queries, so the workspace host alone identifies the platform (like Databricks' workspace URL); a specific warehouse/table is addressed by FabricTableIdentifier. - name: entitiesQuery.parts.inDataPlatform.identifier.fabric.workspaceId in: query description: >- Fabric workspace GUID — the identifier used by the Fabric REST API for workspace-scoped resources. The Fabric endpoint host in `instance` encodes the tenant and workspace GUIDs; this is the decoded workspace GUID, provided so you don't have to decode it yourself. `instance` remains the identifying value. Optional: empty when the host isn't a standard Fabric endpoint. schema: type: string title: workspace_id description: >- Fabric workspace GUID — the identifier used by the Fabric REST API for workspace-scoped resources. The Fabric endpoint host in `instance` encodes the tenant and workspace GUIDs; this is the decoded workspace GUID, provided so you don't have to decode it yourself. `instance` remains the identifying value. Optional: empty when the host isn't a standard Fabric endpoint. - name: entitiesQuery.parts.inDataPlatform.identifier.fabric.tenantId in: query description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance` alongside workspace_id. Optional: empty when the host isn't a standard Fabric endpoint. schema: type: string title: tenant_id description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance` alongside workspace_id. Optional: empty when the host isn't a standard Fabric endpoint. - name: entitiesQuery.parts.inDataPlatform.identifier.db2.host in: query description: Host name of the Db2 server required: true schema: type: string title: host description: Host name of the Db2 server - name: entitiesQuery.parts.inDataPlatform.identifier.db2.database in: query description: Database name or alias, as in `CONNECT TO ` required: true schema: type: string title: database description: Database name or alias, as in `CONNECT TO ` - name: entitiesQuery.parts.inDataPlatform.identifier.synqIntegrationId in: query description: >- Coalesce Quality integration ID maps to the created integration on the Coalesce Quality platform. schema: type: string title: synq_integration_id description: >- Coalesce Quality integration ID maps to the created integration on the Coalesce Quality platform. - name: entitiesQuery.parts.withDataPlatformType.types in: query schema: type: array items: $ref: '#/components/schemas/synq.platforms.v1.DataPlatformType' title: types - name: entitiesQuery.parts.inFolder.path in: query description: >- Opaque folder identifiers (a folder's own entity id). `folders` is the structured, human-authorable alternative. When `path` is the only source set and `deep` is unset, `deep` defaults to true for back-compat with queries authored before `deep` existed. schema: type: array items: type: string title: path description: >- Opaque folder identifiers (a folder's own entity id). `folders` is the structured, human-authorable alternative. When `path` is the only source set and `deep` is unset, `deep` defaults to true for back-compat with queries authored before `deep` existed. - name: entitiesQuery.parts.inFolder.folders.rootEntityId in: query description: >- Opaque id of the entity the folder hierarchy hangs under — an integration root or container (for example a warehouse instance, a database, or a transformation project). Take it verbatim from `FolderRef.root_entity_id` of a folder you already read, or from an entity id returned elsewhere. schema: type: string title: root_entity_id description: >- Opaque id of the entity the folder hierarchy hangs under — an integration root or container (for example a warehouse instance, a database, or a transformation project). Take it verbatim from `FolderRef.root_entity_id` of a folder you already read, or from an entity id returned elsewhere. - name: entitiesQuery.parts.inFolder.folders.folders in: query description: >- Ordered folder names from the root down to this folder (root first, leaf last), for example ["staging", "sales"]. Empty means the ref points at the root entity itself. Folder names are kept as separate segments (not joined with "/") because some platforms allow "/" inside a single folder name. schema: type: array items: type: string title: folders description: >- Ordered folder names from the root down to this folder (root first, leaf last), for example ["staging", "sales"]. Empty means the ref points at the root entity itself. Folder names are kept as separate segments (not joined with "/") because some platforms allow "/" inside a single folder name. - name: entitiesQuery.parts.inFolder.folderOf.entityIds in: query description: >- Simplified source: the assets named directly by opaque entity id. Use this for the common "same folder as these specific assets" case; equivalent to an input_query that lists the same ids. schema: type: array items: type: string title: entity_ids description: >- Simplified source: the assets named directly by opaque entity id. Use this for the common "same folder as these specific assets" case; equivalent to an input_query that lists the same ids. - name: entitiesQuery.parts.inFolder.folderOf.inputQuery.operand in: query description: Defaults to AND if not specified. schema: $ref: '#/components/schemas/synq.queries.v1.QueryOperand' title: operand description: Defaults to AND if not specified. - name: entitiesQuery.parts.inFolder.folderOf.includeAllAncestors in: query description: >- When false (default): only each asset's immediate parent folder. When true: every ancestor folder up the hierarchy, so `InFolder` then also matches assets in those ancestor folders. schema: type: boolean title: include_all_ancestors description: >- When false (default): only each asset's immediate parent folder. When true: every ancestor folder up the hierarchy, so `InFolder` then also matches assets in those ancestor folders. - name: entitiesQuery.parts.inFolder.deep in: query description: >- When false or unset, matches only the direct members of the folder(s). When true, matches the entire recursive subtree (members of subfolders too). Exception: when only the legacy `path` source is set and `deep` is unset, it defaults to true (preserves the behaviour of queries authored before this flag existed). With `folders` or `folder_of`, unset means false (shallow). schema: type: boolean title: deep description: >- When false or unset, matches only the direct members of the folder(s). When true, matches the entire recursive subtree (members of subfolders too). Exception: when only the legacy `path` source is set and `deep` is unset, it defaults to true (preserves the behaviour of queries authored before this flag existed). With `folders` or `folder_of`, unset means false (shallow). - name: entitiesQuery.parts.inDomain.domainId in: query schema: type: string title: domain_id format: uuid - name: entitiesQuery.parts.entityIds.entityIds in: query description: |- The entities to select. An id may not be blank. An empty list selects no entities, exactly as an empty `identifier_list` does. Be deliberate about it, because it is not the same as leaving the part out: a part that selects nothing still counts, so it empties an AND, adds nothing to an OR, and removes nothing from an EXCEPT. If what you mean is "do not restrict on specific entities", omit the part instead of sending it empty. Ids may be up to 1024 characters — the same limit as `Identifier.entity_id`, where you read them from, so any id the API returned is accepted here. schema: type: array items: type: string maxLength: 1024 minLength: 1 title: entity_ids description: |- The entities to select. An id may not be blank. An empty list selects no entities, exactly as an empty `identifier_list` does. Be deliberate about it, because it is not the same as leaving the part out: a part that selects nothing still counts, so it empties an AND, adds nothing to an OR, and removes nothing from an EXCEPT. If what you mean is "do not restrict on specific entities", omit the part instead of sending it empty. Ids may be up to 1024 characters — the same limit as `Identifier.entity_id`, where you read them from, so any id the API returned is accepted here. - name: entitiesQuery.parts.unsupported.queryJson in: query schema: type: string title: query_json - name: time.field in: query schema: $ref: '#/components/schemas/synq.issues.v2.ListIssuesRequest.Field' title: field - name: time.from.seconds in: query description: |- Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. schema: type: - integer - string title: seconds format: int64 description: |- Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. - name: time.from.nanos in: query description: >- Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. schema: type: integer title: nanos format: int32 description: >- Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. - name: sort.sortBy in: query schema: $ref: '#/components/schemas/synq.issues.v2.ListIssuesRequest.Field' title: sort_by - name: sort.order in: query schema: $ref: '#/components/schemas/synq.issues.v2.ListIssuesRequest.Sort.Order' title: order - name: pagination.cursor in: query description: >- Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id. schema: type: string title: cursor description: >- Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id. - name: pagination.pageSize in: query description: >- Maximum number of items to return in a single page. If not provided, defaults vary per API. schema: type: integer title: page_size minimum: 0 format: int32 description: >- Maximum number of items to return in a single page. If not provided, defaults vary per API. - name: lifecycleState in: query description: Filter by issue lifecycle state schema: $ref: '#/components/schemas/synq.issues.issues.v1.LifecycleState' title: lifecycle_state description: Filter by issue lifecycle state deprecated: true - name: lifecycleStates in: query description: Filter by issue lifecycle states schema: type: array items: $ref: '#/components/schemas/synq.issues.issues.v1.LifecycleState' title: lifecycle_states description: Filter by issue lifecycle states - name: interactedBy.identities in: query description: >- Identity strings to match against the actor that performed the interaction. The caller is responsible for resolving a user to all their known identities (e.g. via GetUserIdentities or GetUserAliases + actoridentities.FromUserAliases()) before calling this API. Format: "synq:", "email:", "slack:", etc. schema: type: array items: type: string minItems: 1 title: identities minItems: 1 description: >- Identity strings to match against the actor that performed the interaction. The caller is responsible for resolving a user to all their known identities (e.g. via GetUserIdentities or GetUserAliases + actoridentities.FromUserAliases()) before calling this API. Format: "synq:", "email:", "slack:", etc. - name: interactedBy.statusChanges in: query description: >- Match issues where the user set a status (investigating, fixed, expected, etc.). schema: type: boolean title: status_changes description: >- Match issues where the user set a status (investigating, fixed, expected, etc.). - name: interactedBy.comments in: query description: Match issues where the user posted a comment. schema: type: boolean title: comments description: Match issues where the user posted a comment. - name: interactedBy.activities in: query description: Match issues where the user has an activity record. schema: type: boolean title: activities description: Match issues where the user has an activity record. - name: severities in: query description: >- Filter by issue severity. If empty, issues of any severity are returned. schema: type: array items: $ref: '#/components/schemas/synq.issues.issues.v1.Severity' title: severities description: >- Filter by issue severity. If empty, issues of any severity are returned. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/synq.issues.v2.ListIssuesResponse' components: schemas: synq.entities.v1.EntityType: type: string title: EntityType enum: - ENTITY_TYPE_UNSPECIFIED - ENTITY_TYPE_BQ_TABLE - ENTITY_TYPE_BQ_VIEW - ENTITY_TYPE_LOOKER_LOOK - ENTITY_TYPE_LOOKER_EXPLORE - ENTITY_TYPE_LOOKER_VIEW - ENTITY_TYPE_LOOKER_DASHBOARD - ENTITY_TYPE_LOOKER_INSTANCE - ENTITY_TYPE_DBT_MODEL - ENTITY_TYPE_DBT_TEST - ENTITY_TYPE_DBT_SOURCE - ENTITY_TYPE_DBT_PROJECT - ENTITY_TYPE_DBT_METRIC - ENTITY_TYPE_DBT_SNAPSHOT - ENTITY_TYPE_DBT_SEED - ENTITY_TYPE_DBT_ANALYSIS - ENTITY_TYPE_DBT_EXPOSURE - ENTITY_TYPE_DBT_GROUP - ENTITY_TYPE_DBT_SEMANTIC_MODEL - ENTITY_TYPE_DBT_CLOUD_PROJECT - ENTITY_TYPE_DBT_CLOUD_JOB - ENTITY_TYPE_SNOWFLAKE_TABLE - ENTITY_TYPE_SNOWFLAKE_VIEW - ENTITY_TYPE_SNOWFLAKE_STREAM - ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE - ENTITY_TYPE_SNOWFLAKE_TASK - ENTITY_TYPE_SNOWFLAKE_EXTERNAL_TABLE - ENTITY_TYPE_SNOWFLAKE_MATERIALIZED_VIEW - ENTITY_TYPE_SNOWFLAKE_PROCEDURE - ENTITY_TYPE_SNOWFLAKE_FUNCTION - ENTITY_TYPE_SNOWFLAKE_SEMANTIC_VIEW - ENTITY_TYPE_REDSHIFT_TABLE - ENTITY_TYPE_REDSHIFT_VIEW - ENTITY_TYPE_REDSHIFT_PROCEDURE - ENTITY_TYPE_REDSHIFT_FUNCTION - ENTITY_TYPE_TABLEAU_EMBEDDED - ENTITY_TYPE_TABLEAU_PUBLISHED - ENTITY_TYPE_TABLEAU_CUSTOM_SQL - ENTITY_TYPE_TABLEAU_TABLE - ENTITY_TYPE_TABLEAU_SHEET - ENTITY_TYPE_TABLEAU_DASHBOARD - ENTITY_TYPE_TABLEAU_WORKBOOK - ENTITY_TYPE_TABLEAU_SITE - ENTITY_TYPE_AIRFLOW_DAG - ENTITY_TYPE_AIRFLOW_TASK - ENTITY_TYPE_CLICKHOUSE_TABLE - ENTITY_TYPE_CLICKHOUSE_VIEW - ENTITY_TYPE_ANOMALY_MONITOR - ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT - ENTITY_TYPE_SQLTEST_TEST - ENTITY_TYPE_RECON_SUITE - ENTITY_TYPE_RECON_CASE - ENTITY_TYPE_POSTGRES_TABLE - ENTITY_TYPE_POSTGRES_VIEW - ENTITY_TYPE_MYSQL_TABLE - ENTITY_TYPE_MYSQL_VIEW - ENTITY_TYPE_DATABRICKS_WAREHOUSE - ENTITY_TYPE_DATABRICKS_TABLE - ENTITY_TYPE_DATABRICKS_VIEW - ENTITY_TYPE_DATABRICKS_JOB - ENTITY_TYPE_DATABRICKS_JOB_TASK - ENTITY_TYPE_DATABRICKS_NOTEBOOK - ENTITY_TYPE_DATABRICKS_QUERY - ENTITY_TYPE_DATABRICKS_DASHBOARD - ENTITY_TYPE_SQLMESH_PROJECT - ENTITY_TYPE_SQLMESH_SQL_MODEL - ENTITY_TYPE_SQLMESH_PYTHON_MODEL - ENTITY_TYPE_SQLMESH_EXTERNAL - ENTITY_TYPE_SQLMESH_SEED - ENTITY_TYPE_SQLMESH_AUDIT - ENTITY_TYPE_SQLMESH_UNIT_TEST - ENTITY_TYPE_SQLMESH_ENVIRONMENT - ENTITY_TYPE_SQLMESH_SNAPSHOT - ENTITY_TYPE_DUCKDB_TABLE - ENTITY_TYPE_DUCKDB_VIEW - ENTITY_TYPE_TRINO_TABLE - ENTITY_TYPE_TRINO_VIEW - ENTITY_TYPE_ATLAN_ASSET - ENTITY_TYPE_ATLAN_INTEGRATION - ENTITY_TYPE_COALESCE_PROJECT - ENTITY_TYPE_COALESCE_ENVIRONMENT - ENTITY_TYPE_COALESCE_NODE - ENTITY_TYPE_COALESCE_NODE_TEST - ENTITY_TYPE_COALESCE_JOB - ENTITY_TYPE_CASTORDOC_TABLE - ENTITY_TYPE_CASTORDOC_DASHBOARD - ENTITY_TYPE_CASTORDOC_VIEW - ENTITY_TYPE_CASTORDOC_TILE - ENTITY_TYPE_CASTORDOC_VIZ_MODEL - ENTITY_TYPE_POWERBI_REPORT - ENTITY_TYPE_POWERBI_TILE - ENTITY_TYPE_POWERBI_DATASET - ENTITY_TYPE_POWERBI_DASHBOARD - ENTITY_TYPE_POWERBI_TENANT - ENTITY_TYPE_THOUGHTSPOT_LIVEBOARD - ENTITY_TYPE_THOUGHTSPOT_WORKSHEET - ENTITY_TYPE_SIGMA_WORKBOOK - ENTITY_TYPE_SIGMA_DATA_MODEL - ENTITY_TYPE_SIGMA_ORGANIZATION - ENTITY_TYPE_DOMO_PAGE - ENTITY_TYPE_DOMO_DATASET - ENTITY_TYPE_MSSQL_TABLE - ENTITY_TYPE_MSSQL_VIEW - ENTITY_TYPE_ORACLE_TABLE - ENTITY_TYPE_ORACLE_VIEW - ENTITY_TYPE_ATHENA_TABLE - ENTITY_TYPE_ATHENA_VIEW - ENTITY_TYPE_FABRIC_TABLE - ENTITY_TYPE_FABRIC_VIEW - ENTITY_TYPE_DB2_TABLE - ENTITY_TYPE_DB2_VIEW - ENTITY_TYPE_CUSTOM_ENTITY_GENERIC - ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN - ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX synq.platforms.v1.DataPlatformType: type: string title: DataPlatformType enum: - DATA_PLATFORM_TYPE_UNSPECIFIED - DATA_PLATFORM_TYPE_BIGQUERY - DATA_PLATFORM_TYPE_LOOKER - DATA_PLATFORM_TYPE_DBT - DATA_PLATFORM_TYPE_DBT_CLOUD - DATA_PLATFORM_TYPE_DBT_SELF_HOSTED - DATA_PLATFORM_TYPE_SNOWFLAKE - DATA_PLATFORM_TYPE_GCP - DATA_PLATFORM_TYPE_GIT - DATA_PLATFORM_TYPE_GITHUB - DATA_PLATFORM_TYPE_REDSHIFT - DATA_PLATFORM_TYPE_TABLEAU - DATA_PLATFORM_TYPE_AIRFLOW - DATA_PLATFORM_TYPE_CLICKHOUSE - DATA_PLATFORM_TYPE_POSTGRES - DATA_PLATFORM_TYPE_MYSQL - DATA_PLATFORM_TYPE_DATABRICKS - DATA_PLATFORM_TYPE_SQLMESH - DATA_PLATFORM_TYPE_DUCKDB - DATA_PLATFORM_TYPE_TRINO - DATA_PLATFORM_TYPE_ATLAN - DATA_PLATFORM_TYPE_COALESCE - DATA_PLATFORM_TYPE_CASTORDOC - DATA_PLATFORM_TYPE_POWERBI - DATA_PLATFORM_TYPE_THOUGHTSPOT - DATA_PLATFORM_TYPE_SIGMA - DATA_PLATFORM_TYPE_DOMO - DATA_PLATFORM_TYPE_MSSQL - DATA_PLATFORM_TYPE_ORACLE - DATA_PLATFORM_TYPE_ATHENA - DATA_PLATFORM_TYPE_FABRIC - DATA_PLATFORM_TYPE_DB2 - DATA_PLATFORM_TYPE_SYNQ synq.queries.v1.QueryOperand: type: string title: QueryOperand enum: - QUERY_OPERAND_UNSPECIFIED - QUERY_OPERAND_AND - QUERY_OPERAND_OR - QUERY_OPERAND_EXCEPT - QUERY_OPERAND_UPSTREAM - QUERY_OPERAND_DOWNSTREAM description: >- QueryOperand defines how multiple QueryParts within a Query are combined. synq.issues.v2.ListIssuesRequest.Field: type: string title: Field enum: - FIELD_UPDATED_AT - FIELD_STARTED_AT synq.issues.v2.ListIssuesRequest.Sort.Order: type: string title: Order enum: - ORDER_ASC - ORDER_DESC synq.issues.issues.v1.LifecycleState: type: string title: LifecycleState enum: - LIFECYCLE_STATE_UNSPECIFIED - LIFECYCLE_STATE_UNTRIAGED - LIFECYCLE_STATE_CLOSED - LIFECYCLE_STATE_ONGOING_RESOLVED - LIFECYCLE_STATE_ONGOING_DECLARED - LIFECYCLE_STATE_ONGOING_STATUS_SET - LIFECYCLE_STATE_AUTOTRIAGE_QUEUED - LIFECYCLE_STATE_AUTOTRIAGE_ACTION_SUGGESTED description: >- 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. synq.issues.issues.v1.Severity: type: string title: Severity enum: - SEVERITY_UNSPECIFIED - SEVERITY_INFO - SEVERITY_WARN - SEVERITY_ERROR - SEVERITY_FATAL synq.issues.v2.ListIssuesResponse: type: object properties: pageInfo: $ref: '#/components/schemas/synq.v1.PageInfo' description: Paging information. issueIds: type: array items: type: string format: uuid title: ListIssuesResponse required: - pageInfo additionalProperties: false synq.v1.PageInfo: type: object properties: totalCount: type: integer format: int32 description: >- Total number of items matching the request. May not be available for cursor-based pagination where the total is unknown or expensive to compute. Deprecated: most of the APIs which require pagination don't know the total count. deprecated: true count: type: integer format: int32 description: Number of items returned in this response. lastId: type: string description: >- Opaque cursor token for fetching the next page of results. Pass this value as the cursor in the next Pagination request to continue pagination. Empty if there are no more pages. title: PageInfo additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer ````