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

Non-null

Whether the dashboard has been deleted

isReadOnly

Whether the dashboard is read-only (deprecated)

title

Non-null

Dashboard title

widgetIds

[ID !]!
Non-null

List of widget IDs contained in the dashboard

syncedWidgetsIds

[ID !]

Historical duplicate widget IDs created for tab sync; active membership lives on linked tabs

connectedWidgetIds

[ID !]

Widget IDs preselected as defaults when configuring tab sync for this dashboard

layout

Non-null

Layout configuration for dashboard widgets

createdBy

ID !
Non-null

User ID who created the dashboard

createdAt

Non-null

Creation timestamp

modifiedBy

ID !
Non-null

User ID who last modified the dashboard

modifiedAt

Non-null

Last modification timestamp

privacy

Non-null

Dashboard privacy setting

projectIds

[ID ]!
Non-null

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

filter

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

Dashboard sharing visibility type

shareToken

Token for sharing the dashboard

shareOnBehalfOfCreator

Whether to share on behalf of dashboard creator

visibleFor

[ID !]!
Non-null

User IDs who have pinned this dashboard

color

Dashboard color

allowedEmailDomains

[String !]!
Non-null

Allowed email domains for sharing

allowAccessToWhitelistedDomains

Whether to allow access to whitelisted domains

backgroundImageUrl

URL of dashboard background image

backgroundImageUrlLight

URL of dashboard background image for light theme

backgroundImageUrlDark

URL of dashboard background image for dark theme

backgroundImageCropType

How the background image should be cropped

headerTextColor

Header text color

customHeaderTextColor

Custom header text color

type

Dashboard type

backgroundColor

Dashboard background color

customBackgroundColor

Custom dashboard background color

displayTipsAndTricksFooter

Whether to display tips and tricks footer

archived

Whether the dashboard is archived

folderId

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

projectId

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

projectTabId

Page tab ID on the project that references this dashboard (via tab → actionView). Not stored in DB.

showHeaderOnPublicShare

Show the dashboard header on the public share link. Defaults to true for legacy dashboards.

showHeaderOnExport

Show the dashboard header on PDF exports. Defaults to true for legacy dashboards.

showDateFiltersOnWidgets

Show effective date-filter labels under chart/pivot widget titles. Defaults to false for legacy dashboards.

pdfPaperSize

Default PDF paper size for print preview and export when not overridden by URL.

exportPdfPaperSize

Default PDF paper size for menu export and scheduled email PDFs (not live scaling).

pdfExportLayouts

User-reviewed PDF layouts keyed by dashboard or linked-tab context.

Usages

#

References

#

  • Field getOrCreateGoalMetricSourcesDashboard from Query