Magidoc

Dashboard
Object

Represents a dashboard and its configuration

Fields

#

_id

ID !
Non-null

Unique identifier for the dashboard

workspaceId

ID !
Non-null

Workspace the dashboard belongs to

deleted

Boolean !
Non-null

Whether the dashboard has been deleted

isReadOnly

Boolean

Whether the dashboard is read-only (deprecated)

title

String !
Non-null

Dashboard title

widgetIds

[ID !]!
Non-null

List of widget IDs contained in the dashboard

layout

[DashboardLayout !]!
Non-null

Layout configuration for dashboard widgets

createdBy

ID !
Non-null

User ID who created the dashboard

createdAt

Date !
Non-null

Creation timestamp

modifiedBy

ID !
Non-null

User ID who last modified the dashboard

modifiedAt

Date !
Non-null

Last modification timestamp

privacy

DashboardPrivacy !
Non-null

Dashboard privacy setting

projectIds

[ID ]!
Non-null

used for access control for table widget. Ignored by chart widgets

filter

JSONObject

Unfortunately, we can't use GQL type here because fields of IUserFilter is not compatible with UserFilter

sharingWith

[ID !]!
Non-null

User IDs the dashboard is shared with

teams

[ID !]!
Non-null

Team IDs the dashboard is shared with

sharingType

DashboardSharingType

Dashboard sharing visibility type

shareToken

String

Token for sharing the dashboard

shareOnBehalfOfCreator

Boolean

Whether to share on behalf of dashboard creator

visibleFor

[ID !]!
Non-null

User IDs who have pinned this dashboard

color

String

Dashboard color

allowedEmailDomains

[String !]!
Non-null

Allowed email domains for sharing

allowAccessToWhitelistedDomains

Boolean

Whether to allow access to whitelisted domains

backgroundImageUrl

String

URL of dashboard background image

backgroundImageCropType

DashboardBackgroundImageCropType

How the background image should be cropped

headerTextColor

DashboardHeaderTextColor

Header text color

type

DashboardType

Dashboard type

backgroundColor

DashboardBackgroundColor

Dashboard background color

displayTipsAndTricksFooter

Boolean

Whether to display tips and tricks footer

archived

Boolean

Whether the dashboard is archived

folderId

ID

Folder ID this dashboard belongs to (null = root/unfiled)

projectId

ID

Resolved project ID for project-type dashboards (via tab → actionView). Not stored in DB.

Usages

#

References

#