Skip to main content
This page describes the Dashboard object that represents a collection of widgets and visualizations.

​
Dashboard

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

Dashboard Query

Retrieve dashboard by ID

Dashboards Query

Retrieve multiple dashboards

DashboardWidget Object

Widget structure and properties

DashboardScope Object

Access level definitions