Observe
5 methods on the Observe resource.
5 methods · 2 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";5 of 5
getObserveOverview
Get the observer-backed home overview
compozy.observe.getObserveOverview({ query }) → Promise<ObserveOverviewResponse>
Options
- all_workspacesbooleanquery
- Read every project and User within the profile lens; conflicts with workspace
- receipt_profilestringquery
- Profile owning acknowledgement receipts, including aggregate reads
- workspacestringquery
- Scope aggregates to one workspace; empty selects the global home scope
- usage_window"7" | "30" | "90"query
- Usage window in days (default 30)
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
GET /api/observe/overviewapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.observe.getObserveOverview();getPermissionRollup
Read daily permission totals by agent and decision
compozy.observe.getPermissionRollup({ query }) → Promise<PermissionRollupResponse>
Options
- daysstringquery
- UTC calendar days including today, 1 through 90 (default 30)
- agentstringquery
- Filter by agent name
- unattendedbooleanquery
- Include only automation, daemon and extension initiators
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
GET /api/permissions/rollupapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.observe.getPermissionRollup();getTaskDashboard
Get the observer-backed task dashboard
compozy.observe.getTaskDashboard({ query }) → Promise<TaskDashboardResponse>
Options
- all_workspacesbooleanquery
- Read every project and User within the profile lens; conflicts with workspace
- workspace_idsstring[]query
- Repeatable project IDs; @user selects User; requires all_workspaces=true
- scope"global" | "workspace" | "user" | "@user"query
- Filter by task scope
- workspacestringquery
- Filter by workspace path, name, or ID
- worktreestringquery
- Filter by active run worktree ID
- owner_kind"human" | "agent_session" | "automation" | "extension" | "pool"query
- Filter by owner kind
- owner_refstringquery
- Filter by owner reference
- origin_kind"cli" | "web" | "uds" | "http" | "automation" | "extension" | "agent_session" | "daemon"query
- Filter by task origin kind
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
GET /api/observe/tasks/dashboardapp tokens allowed
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.observe.getTaskDashboard();getTaskInbox
Get the observer-backed task inbox
compozy.observe.getTaskInbox({ query }) → Promise<TaskInboxResponse>
Options
- scope"global" | "workspace" | "user" | "@user"query
- Filter by task scope
- workspacestringquery
- Filter by workspace path, name, or ID
- all_workspacesbooleanquery
- Read all projects and User rows
- workspace_idsstring[]query
- Repeatable project IDs or @user; requires all_workspaces=true
- worktreestringquery
- Filter by active run worktree ID
- owner_kind"human" | "agent_session" | "automation" | "extension" | "pool"query
- Filter by owner kind
- owner_refstringquery
- Filter by owner reference
- lane"my_work" | "approvals" | "failed_runs" | "blocked" | "archived"query
- Filter by inbox lane
- status"draft" | "pending" | "blocked" | "needs_attention" | "ready" | "in_progress" | "completed" | "failed" | "canceled"query
- Filter by canonical task status
- priority"low" | "medium" | "high" | "urgent"query
- Filter by task priority
- unreadbooleanquery
- Filter by unread state; false selects read items
- querystringquery
- Filter by task title or identifier
- cursorstringquery
- Opaque actor- and query-bound continuation cursor
- limitintegerquery
- Page size from 1 to 200 (default 50)
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
GET /api/observe/tasks/inboxapp tokens allowed
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.observe.getTaskInbox({ query: { "status": "draft" } });listPermissionEntries
List the newest permission decisions with their initiators
compozy.observe.listPermissionEntries({ query }) → Promise<PermissionEntriesResponse>
Options
- daysstringquery
- UTC calendar days including today, 1 through 90 (default 30)
- agentstringquery
- Filter by agent name
- unattendedbooleanquery
- Include only automation, daemon and extension initiators
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
GET /api/permissionsapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.observe.listPermissionEntries();