← API reference
CANONICAL TYPE REFERENCE

DashboardState

A simple monitoring board: cards showing metrics, charts, tables or text. Built by a technical team for its own use. A dashboard only displays — it has no actions and runs no mutations. For a surface an end user works in, with one-tap actions, use a Workspace instead.

Unique identifier

Tenant ID

Owner user ID

nameString!

Dashboard name

Optional description

Visibility level (personal or shared)

isDefaultBoolean!

Whether this is the default dashboard for the owner

Cards within this dashboard

createdAtString!

Creation timestamp (ISO8601)

updatedAtString!

Last update timestamp (ISO8601)

View exact SDL
"""
A simple monitoring board: cards showing metrics, charts, tables or text. Built by a technical team for its own use. A dashboard only displays — it has no actions and runs no mutations. For a surface an end user works in, with one-tap actions, use a Workspace instead.
"""
type DashboardState @iac_resource(name: "dashboard") @iac_ops(create: "createDashboard", read: "getDashboard", update: "updateDashboard", delete: "deleteDashboard") {
  """Unique identifier"""
  id: DashboardID! @iac_identity(assignedBy: SERVER) @iac_computed
  """Tenant ID"""
  tenantId: TenantID! @iac_computed
  """Owner user ID"""
  ownerId: UserID! @iac_ref(resource: "service_account") @iac_computed
  """Dashboard name"""
  name: String!
  """Optional description"""
  description: String
  """Visibility level (personal or shared)"""
  visibility: DashboardVisibility!
  """Whether this is the default dashboard for the owner"""
  isDefault: Boolean!
  """Cards within this dashboard"""
  cards: [DashboardCardState!]! @iac_computed
  """Creation timestamp (ISO8601)"""
  createdAt: String! @iac_computed
  """Last update timestamp (ISO8601)"""
  updatedAt: String! @iac_computed
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.