> ## 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. # GetActorSummary > Read what one actor read, built and wrote over the window, what its queries cost per compute and platform, and when it works. The actor is asked for by name, so nothing is left out for being Coalesce Quality's own access, a writer's own read or a policy. Without the platform users scope only an issuer entity, a job or step, may be asked for, and the answer names no login. ## OpenAPI ````yaml /api-reference/openapi.yaml post /api/entities/activity/v1alpha/actor-summary 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.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.git.commits.v1.CommitsService - name: synq.recommendations.v1.RecommendationsService description: |- RecommendationsService lists the changes Coalesce Quality recommends you make, and records what you decided about them. See `Recommendation` for what a recommendation is. Recommendations are created and removed by Coalesce Quality itself: one appears when something only you can change is found, and disappears once it no longer holds. What you can do is decide whether a recommendation stays in front of you: - Dismiss hides it until something new is found about it: an object it did not list before, or a different remediation. - Ignore hides it for good. - Restore undoes either. Decisions are kept by recommendation id, so they keep applying when a recommendation disappears and comes back. A recommendation about an integration is also governed by that integration's permissions: reading it needs a credential that can read integrations, and deciding about it one that can edit them. One that cannot does not see it listed. Related services: `synq.integrations.v1.IntegrationsService` manages the integrations recommendations can be about. - name: synq.monitors.custom_monitors.v1.CustomMonitorsService - name: synq.monitors.info.v1.MonitorInfoService - name: synq.monitors.automated_monitors.v1.DeploymentRulesService - 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.monitors.history.v1.HistoryService - name: synq.monitors.predictions.v1.MonitorPredictionsService description: Access to anomaly detection model predictions and raw metric timeseries. - name: synq.schedule.v1.ScheduleService description: ScheduleService provides schedule evaluation utilities. - name: synq.extensions.atlan.integrations.v1.AtlanIntegrationService - name: synq.extensions.atlan.provider.v1.AtlanProviderService - name: synq.extensions.atlan.workflows.v1.AtlanWorkflowService - 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.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.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.domains.v1.DomainsService description: DomainsService can be used to manage domains. - 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.queries.v1.NLQueryService description: >- NLQueryService generates structured Query protos from natural language descriptions using an LLM. - name: synq.incidents.v1.IncidentsService description: IncidentsService is a service for managing Incidents. - 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.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.platforms.v1.PlatformsService description: PlatformsService is a service for managing Platforms and Integrations. - 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.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.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.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.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.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.EntityExecutionsService - name: synq.entities.custom.v1.TypesService description: TypesService is a service for managing custom entity types. - name: synq.entities.custom.v1.FeaturesService - 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.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.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.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.impact.v1.ImpactService - name: synq.entities.coordinates.v1.DatabaseCoordinatesService description: >- DatabaseCoordinatesService is a service for getting database coordinates of Entities. - name: synq.entities.activity.v1alpha.ActivityService description: >- ActivityService reads the query history of a workspace's data platforms: how popular an entity is, who reads and writes it, what one login, tool, job or person touched and what it cost, and where a workspace's compute goes. Every read covers a window of whole UTC hours, by default the 30 days before the current hour. A login's reads count toward popularity as its service account's popularity policy says (see synq.entities.platformusers.v1alpha.ServiceAccountsService), and Coalesce Quality's own queries never count. Weights are per query, in each platform's own figures. bytes_scanned is never a cost, and no platform reports cost per table, so an entity's share of a query is an equal split. Nothing here is credits or currency. - name: synq.entities.orchestration.v1.OrchestrationService description: >- OrchestrationService tells which jobs, job steps and tasks run an entity, and which entities a job, job step or task runs, from the runs of the last 31 days. It covers Airflow tasks and DAGs, dbt Cloud job steps and Coalesce jobs. - 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.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.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.platformusers.v1alpha.PlatformUsersService description: >- PlatformUsersService reads the logins of a workspace's data platforms, as its integrations declare them and as their queries show them: how each login reads, why, how much it does and what it costs. Logins, their emails and what they read are often personal data, so every read here needs the platform users scope, which a Developer and an Admin have. - name: synq.entities.platformusers.v1alpha.ServiceAccountsService description: >- ServiceAccountsService maintains a workspace's service accounts, person links and popularity policies: which logins act for a tool, which belong to a person, and whose reads count toward an entity's popularity. Every change goes through a plan first. A typical loop is: ListPlatformUsers with unclassified_only to see the logins nothing classifies, ListServiceAccountSuggestions for the accounts their evidence points at, PlanServiceAccountChanges to see what a change set moves, then ApplyServiceAccountChanges with the plan's token. A change takes effect on the next read. Exact matchers, suggestion evidence and plans name logins, which are often personal data. A caller without the platform users scope gets them with every platform user id, login and person identity cleared, and the counts kept. A suggestion's account name and login patterns come from the logins it saw, so that caller gets those cleared too, and a suggestion named after its one login is named "Service login". - 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", "what SQL constructs does this specific entity use" and "which columns does building this entity join on", without requiring the caller to re-parse any SQL. - name: synq.entities.entities.v1.EntitiesService description: EntitiesService is a service for retriving any entity. - name: synq.entities.resolve.v1.IdentifierResolveService description: >- IdentifierResolveService resolves identifiers to their Coalesce Quality paths and identities. - 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.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.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.executions.v1.EntityExecutionsService description: 'Deprecated: Use [synq.entities.custom.v1.EntityExecutionsService] instead' - name: synq.entities.lineage.folds.v1alpha.LineageFoldsService description: >- LineageFoldsService manages the lineage folds of a workspace: rules that show many similar entities, a table or a storage path written anew on every run, as one node in lineage. See `LineageFold`. A change to a fold reaches lineage shortly after the call returns, not within it. Fold ids are UUIDs chosen by the caller, so a retried create converges on the same fold instead of making a second one. Pass the `etag` you last read on a change to guard against overwriting a concurrent edit. This API is in alpha: its shape may change without notice. - 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.users.v1.UsersService - 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.knowledge.v1alpha.KnowledgeService description: >- KnowledgeService reads the knowledge a team keeps about its data: knowledge pages written or imported by the team, and the descriptions people write for entities. Knowledge pages form a tree, and pages and entities are pinned to each other. Nothing here is the description an entity's own source reports, which `synq.entities.entities.v1.EntitiesService` reads. This API is in alpha: its shape may change without notice. - 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.dataproducts.v1.DataproductsService description: DataproductsService can be used to manage data products. - 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.services.v2.AlertsService` (how the configured alerts are reported), and `synq.users.v1.UsersService` (resolve the users behind `UserContact` and Slack/Teams mentions). - name: synq.ingest.cloudwatch.v1.CloudwatchService - name: synq.ingest.dwh.v1.DwhService - name: synq.ingest.airflow.v1.AirflowLogsService - name: synq.ingest.openlineage.v1.OpenlineageService - 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 paths: /api/entities/activity/v1alpha/actor-summary: post: tags: - synq.entities.activity.v1alpha.ActivityService summary: GetActorSummary description: >- Read what one actor read, built and wrote over the window, what its queries cost per compute and platform, and when it works. The actor is asked for by name, so nothing is left out for being Coalesce Quality's own access, a writer's own read or a policy. Without the platform users scope only an issuer entity, a job or step, may be asked for, and the answer names no login. operationId: synq.entities.activity.v1alpha.ActivityService.GetActorSummary requestBody: content: application/json: schema: $ref: >- #/components/schemas/synq.entities.activity.v1alpha.GetActorSummaryRequest required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/synq.entities.activity.v1alpha.GetActorSummaryResponse components: schemas: synq.entities.activity.v1alpha.GetActorSummaryRequest: type: object properties: actor: $ref: '#/components/schemas/synq.entities.activity.v1alpha.ActorRef' until: $ref: '#/components/schemas/google.protobuf.Timestamp' description: >- The window ends at the start of this hour, exclusive. Unset is the current hour. windowDays: type: integer maximum: 92 description: The window's length in days, back from until. Unset is 30. timeZone: type: string maxLength: 64 description: The IANA time zone days and grid cells are in. Unset is UTC. topK: type: integer maximum: 1000 description: At most this many entities per direction. Unset is 20. title: GetActorSummaryRequest required: - actor additionalProperties: false synq.entities.activity.v1alpha.GetActorSummaryResponse: type: object properties: from: $ref: '#/components/schemas/google.protobuf.Timestamp' to: $ref: '#/components/schemas/google.protobuf.Timestamp' timeZone: type: string description: The time zone used, "UTC" when none was asked. platformUserIds: type: array items: type: string description: >- The logins the actor resolved to, sorted. Empty without the platform users scope. totals: $ref: '#/components/schemas/synq.entities.activity.v1alpha.ActorTotals' computes: type: array items: $ref: >- #/components/schemas/synq.entities.activity.v1alpha.ActorComputeTotals description: Ordered by platform instance, then compute. entities: type: array items: $ref: >- #/components/schemas/synq.entities.activity.v1alpha.ActorEntityActivity description: >- At most top_k per direction, READ, INPUT, then WRITE, each by count. For a job, a WRITE row of measure RUNS counts the runs of what it builds, never write queries. hourly: type: array items: $ref: '#/components/schemas/synq.entities.activity.v1alpha.SeriesPoint' description: The actor's queries per UTC hour, split by issuer. daily: type: array items: $ref: '#/components/schemas/synq.entities.activity.v1alpha.SeriesPoint' grid: $ref: '#/components/schemas/synq.entities.activity.v1alpha.WeekGrid' title: GetActorSummaryResponse additionalProperties: false synq.entities.activity.v1alpha.ActorRef: type: object oneOf: - properties: coalesce: type: boolean title: coalesce description: >- Coalesce Quality and Coalesce Catalog: every query that carried Coalesce Quality's tag, on any login, and every query of a login either connects as. What the overview's COALESCE group counts. const: 'true' title: coalesce required: - coalesce - properties: group: $ref: >- #/components/schemas/synq.entities.activity.v1alpha.ActorGroupRef title: group description: >- One group of GetActivityOverview, exactly the logins the overview lands in it: what ActorGroup.actor names for a service account or a tool. title: group required: - group - properties: issuer: $ref: '#/components/schemas/synq.platforms.v1.DataPlatformType' not: enum: - 0 title: issuer description: A tool, from the tag its queries carry. title: issuer required: - issuer - properties: issuerEntityId: type: string title: issuer_entity_id maxLength: 2048 minLength: 1 description: >- A job, task or step that issues queries or runs what builds an entity: what it maintains. title: issuer_entity_id required: - issuerEntityId - properties: personIdentity: type: string title: person_identity maxLength: 2048 minLength: 1 description: >- The logins linked to this person, such as "synq:" or "email:
". title: person_identity required: - personIdentity - properties: platformUserId: type: string title: platform_user_id maxLength: 2048 minLength: 1 description: One login, on every tool that issued its queries. title: platform_user_id required: - platformUserId - properties: serviceAccountId: type: string title: service_account_id maxLength: 128 minLength: 1 description: >- The logins a service account holds, a built-in one included, such as `built_in.fivetran`. `built_in.coalesce-quality` is the same actor as coalesce. title: service_account_id required: - serviceAccountId additionalProperties: false description: ActorRef names who an actor summary is about. google.protobuf.Timestamp: type: string examples: - '2023-01-15T01:30:15.01Z' - '2024-12-25T12:00:00Z' format: date-time description: >- A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format. synq.entities.activity.v1alpha.ActorTotals: type: object properties: queries: type: - integer - string format: int64 description: Its queries, whatever they touched. weights: type: array items: $ref: >- #/components/schemas/synq.entities.activity.v1alpha.PlatformWeights description: The whole weights of its queries, per platform, by platform. reads: type: - integer - string format: int64 description: Access to entities, per direction. inputs: type: - integer - string format: int64 writes: type: - integer - string format: int64 description: Write queries. Runs are never part of it. runs: type: - integer - string format: int64 description: The runs of what a job builds. entitiesRead: type: integer description: The distinct entities it read, and wrote or built. entitiesWritten: type: integer activeDays: type: integer description: The distinct UTC days with any access. outsideEntities: $ref: '#/components/schemas/synq.entities.activity.v1alpha.QueryShares' description: >- The whole weight less the entity shares, never below 0: what the queries spent outside entities, such as on a pipeline's staging tables. Each figure is a sum across platforms. title: ActorTotals additionalProperties: false description: ActorTotals is an actor's whole window. synq.entities.activity.v1alpha.ActorComputeTotals: type: object properties: platformRootId: type: string computeId: type: string platform: $ref: '#/components/schemas/synq.platforms.v1.DataPlatformType' description: >- DATA_PLATFORM_TYPE_UNSPECIFIED when the instance's platform is not known. computeUnit: $ref: '#/components/schemas/synq.entities.activity.v1alpha.ComputeUnit' queries: type: - integer - string format: int64 weights: $ref: '#/components/schemas/synq.entities.activity.v1alpha.QueryWeights' title: ActorComputeTotals additionalProperties: false description: >- ActorComputeTotals is an actor's queries on one compute of one platform instance. synq.entities.activity.v1alpha.ActorEntityActivity: type: object properties: entityId: type: string direction: $ref: >- #/components/schemas/synq.entities.activity.v1alpha.ActivityDirection measure: $ref: '#/components/schemas/synq.entities.activity.v1alpha.ActivityMeasure' count: type: - integer - string format: int64 shares: $ref: '#/components/schemas/synq.entities.activity.v1alpha.QueryShares' lastSeenAt: $ref: '#/components/schemas/google.protobuf.Timestamp' activeDays: type: integer title: ActorEntityActivity additionalProperties: false description: >- ActorEntityActivity is what an actor did to one entity in one direction and measure. synq.entities.activity.v1alpha.SeriesPoint: type: object properties: start: $ref: '#/components/schemas/google.protobuf.Timestamp' count: type: - integer - string format: int64 byIssuer: type: array items: $ref: '#/components/schemas/synq.entities.activity.v1alpha.IssuerCount' description: >- With SERIES_SPLIT_ISSUER only: each tool's count, highest first, then by issuer. covered: type: boolean description: 'On an hourly point: whether the hour''s query history was read.' coveredHours: type: integer description: >- On a daily point: how many of the day's hours were read. A day has 23 or 25 hours when the time zone changes its offset. partial: type: boolean description: 'On a daily point: the day is not wholly inside the window.' title: SeriesPoint additionalProperties: false description: >- SeriesPoint is one step of a series. A series is dense: a step with nothing counted is a point with count 0, and covered or covered_hours say whether it was seen at all. synq.entities.activity.v1alpha.WeekGrid: type: object properties: days: type: array items: $ref: '#/components/schemas/synq.entities.activity.v1alpha.GridDay' title: WeekGrid additionalProperties: false description: 'WeekGrid is when access happens in the week: seven days, Monday first.' synq.entities.activity.v1alpha.ActorGroupRef: type: object allOf: - properties: builtIn: type: boolean title: built_in description: 'Output only: service_account_id names a built-in account.' - oneOf: - properties: issuer: $ref: '#/components/schemas/synq.platforms.v1.DataPlatformType' not: enum: - 0 title: issuer description: The TOOL group of this tool. title: issuer required: - issuer - properties: serviceAccountId: type: string title: service_account_id maxLength: 128 minLength: 1 description: >- The SERVICE_ACCOUNT group of this service account, a built-in one included. title: service_account_id required: - serviceAccountId title: ActorGroupRef additionalProperties: false description: >- ActorGroupRef names one group of GetActivityOverview. Its summary has exactly the group's queries, so it can be narrower than the actor of the same name: a login a service account holds can land with another account first, and Coalesce Quality's queries land in the COALESCE group. 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_FIVETRAN - DATA_PLATFORM_TYPE_DAGSTER - DATA_PLATFORM_TYPE_AIRBYTE - DATA_PLATFORM_TYPE_STITCH - DATA_PLATFORM_TYPE_SNOWPLOW - 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_LOOKER_STUDIO - DATA_PLATFORM_TYPE_HEX - DATA_PLATFORM_TYPE_OMNI - DATA_PLATFORM_TYPE_METABASE - DATA_PLATFORM_TYPE_GOOGLE_SHEETS - DATA_PLATFORM_TYPE_GRAFANA - DATA_PLATFORM_TYPE_STREAMLIT - DATA_PLATFORM_TYPE_ASTRATO - DATA_PLATFORM_TYPE_SNOWFLAKE_CORTEX - DATA_PLATFORM_TYPE_SNOWFLAKE_INTELLIGENCE - DATA_PLATFORM_TYPE_CUBE - DATA_PLATFORM_TYPE_CENSUS - DATA_PLATFORM_TYPE_HIGHTOUCH - DATA_PLATFORM_TYPE_WORKATO - DATA_PLATFORM_TYPE_ESTUARY - DATA_PLATFORM_TYPE_DLT - DATA_PLATFORM_TYPE_TERRAFORM - DATA_PLATFORM_TYPE_HEVO - DATA_PLATFORM_TYPE_DATASTREAM - DATA_PLATFORM_TYPE_SYNQ synq.entities.activity.v1alpha.PlatformWeights: type: object properties: platform: $ref: '#/components/schemas/synq.platforms.v1.DataPlatformType' description: >- DATA_PLATFORM_TYPE_UNSPECIFIED is the queries whose platform is not known. computeUnit: $ref: '#/components/schemas/synq.entities.activity.v1alpha.ComputeUnit' description: What weights.compute_ms counts. weights: $ref: '#/components/schemas/synq.entities.activity.v1alpha.QueryWeights' title: PlatformWeights additionalProperties: false description: PlatformWeights are the weights of the queries on one platform. synq.entities.activity.v1alpha.QueryShares: type: object properties: executionMs: type: number format: double nullable: true computeMs: type: number format: double nullable: true bytesScanned: type: number format: double nullable: true bytesBilled: type: number format: double nullable: true title: QueryShares additionalProperties: false description: >- QueryShares are the weights of each query split equally over the entities it touched, so they add up across entities. Equal is a convention, as no platform reports cost per table. An unset figure is one no query reported. synq.entities.activity.v1alpha.ComputeUnit: type: string title: ComputeUnit enum: - COMPUTE_UNIT_UNSPECIFIED - COMPUTE_UNIT_SNOWFLAKE_XSMALL_WAREHOUSE_MS - COMPUTE_UNIT_BIGQUERY_SLOT_MS - COMPUTE_UNIT_DATABRICKS_TASK_MS description: >- ComputeUnit is what compute_ms counts on one platform. Each platform reports its own unit, so compute is never summed across platforms. synq.entities.activity.v1alpha.QueryWeights: type: object properties: executionMs: type: - integer - string format: int64 nullable: true computeMs: type: - integer - string format: int64 description: In the unit of the platform the weights are for. nullable: true bytesScanned: type: - integer - string format: int64 description: >- What the queries scanned. Never a cost: a platform can bill differently from what it scanned. nullable: true bytesBilled: type: - integer - string format: int64 description: Set only where the platform bills by bytes read. nullable: true title: QueryWeights additionalProperties: false description: >- QueryWeights are whole weights summed over queries. An unset figure is one no query reported, and zero is a value. Nothing here is a credit or a price. synq.entities.activity.v1alpha.ActivityDirection: type: string title: ActivityDirection enum: - ACTIVITY_DIRECTION_UNSPECIFIED - ACTIVITY_DIRECTION_READ - ACTIVITY_DIRECTION_INPUT - ACTIVITY_DIRECTION_WRITE description: ActivityDirection is how a query touched an entity. synq.entities.activity.v1alpha.ActivityMeasure: type: string title: ActivityMeasure enum: - ACTIVITY_MEASURE_UNSPECIFIED - ACTIVITY_MEASURE_QUERIES - ACTIVITY_MEASURE_VIEWS - ACTIVITY_MEASURE_RUNS description: >- ActivityMeasure is what a count counts. Counts are compared only within one measure. synq.entities.activity.v1alpha.IssuerCount: type: object properties: issuer: $ref: '#/components/schemas/synq.platforms.v1.DataPlatformType' description: >- DATA_PLATFORM_TYPE_UNSPECIFIED is access whose query carried no tool's tag. count: type: - integer - string format: int64 title: IssuerCount additionalProperties: false description: IssuerCount is one issuing tool's part of a point. synq.entities.activity.v1alpha.GridDay: type: object properties: isoWeekday: type: integer description: 1 is Monday, 7 is Sunday. hours: type: array items: type: - integer - string format: int64 description: 24 counts, one per local hour. occurrences: type: integer description: >- How many local dates with this weekday overlap the window, to average by. title: GridDay additionalProperties: false description: GridDay is one weekday of a weekday and hour grid. securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.