Magidoc

Dashboard
Object

A named, org-wide analytics dashboard built from Metabase charts on a 4 column grid.

Fields

#

cells

Non-null

The chart cells on this dashboard.

createdAt

Non-null

The date and time this entity was created.

description

An optional description of the dashboard.

displayName

Non-null

The name of the dashboard.

id

Non-null

A unique internal GlobalId for this entity.

isDefault

Non-null

If true, this is a Cloudshelf-managed default dashboard shared with every organisation. Default dashboards have no owning organisation and are editable only by Cloudshelf admins.

owningOrganisation

The organisation which owns this entity. Null for Cloudshelf-managed default dashboards.

paramLayout

Non-null

The arranged layout of the param bar: an ordered list of lines within each of the two fixed sections (FILTER / DISPLAY). On a default dashboard this is the acting organisation's own arrangement, falling back to the shared base layout until the organisation saves. An empty list means the default one-line-per-section layout (reconciled from requiredParams).

paramValues

Non-null

The last-selected dashboard-level param values, fed into the charts that need them. On a default dashboard these are the acting organisation's own saved values, falling back to the shared base values until the organisation saves for the first time.

requiredParams

Non-null

The distinct Metabase params required across this dashboard's charts (one per param slug), used to build the single form at the top of the dashboard.

updatedAt

Non-null

The date and time this entity was last updated.

Usages

#

References

#