This page describes the Dashboard object that represents a collection of widgets and visualizations.

​
Dashboard

​
id
ID!
required
Unique identifier for the dashboard.
​
name
String!
required
Display name of the dashboard.
​
description
String
Optional description explaining the dashboard’s purpose and contents.
​
owner
User
User who created the dashboard. Null for system-generated dashboards.
​
domain
ZSheet
Deprecated: Use domains field instead. Primary domain associated with the dashboard.
​
domains
[ZSheet!]!
required
List of domains associated with this dashboard.
​
widgets
[DashboardWidget!]!
required
Array of widgets contained in this dashboard. See DashboardWidget.
​
filters
[DashboardFilterDefinition!]!
required
Global filter definitions applied to the dashboard. See DashboardFilterDefinition.
​
createdAt
DateTime!
required
Timestamp when the dashboard was created.
​
accessLevel
DashboardScope!
required
Current user’s access level to this dashboard. See DashboardScope.
​
version
String
Version identifier for dashboard snapshots. Null if dashboard hasn’t been modified.
​
roleAssignments
[RoleAssignment!]!
required
List of user and group role assignments for this dashboard.

​
Additional Resources

Dashboard Query

Retrieve dashboard by ID

Dashboards Query

Retrieve multiple dashboards

DashboardWidget Object

Widget structure and properties

DashboardScope Object

Access level definitions