PublicDashboard

No description

type PublicDashboard {
  title: String!
  definition: PublicDashboardDefinition!
  shared_by_name: String!
  time_zone: String!
  purpose: PublicDashboardPurpose!
  allow_drill: Boolean!
  data_as_of: DateTime!
  export_state: PublicDashboardExportState
  date_restrictions: PublicDashboardDateRestrictions!
  datasets: [PublicDashboardDataset!]!
  data_mode: CustomDashboardDataMode!
  compile_state: CustomDashboardCompileState
}

Fields

PublicDashboard.title ● String! non-null scalar

The dashboard's name.

PublicDashboard.definition ● PublicDashboardDefinition! non-null object

PublicDashboard.shared_by_name ● String! non-null scalar

Who made the link. The dashboard is shown as they see it.

PublicDashboard.time_zone ● String! non-null scalar

The zone every date of the link is read in: its maker's (an export link's, as exported).

PublicDashboard.purpose ● PublicDashboardPurpose! non-null enum

PublicDashboard.allow_drill ● Boolean! non-null scalar

Whether a number opens into the contacts behind it (publicDashletDrilldown). Never for an export link.

PublicDashboard.data_as_of ● DateTime! non-null scalar

When this was read. Dashlet rows may be up to ten minutes older (they are cached per link).

PublicDashboard.export_state ● PublicDashboardExportState object

The fixed view of an export link; null for a public one.

PublicDashboard.date_restrictions ● PublicDashboardDateRestrictions! non-null object

PublicDashboard.datasets ● [PublicDashboardDataset!]! non-null object

Labels and types for every field the dashlets request, per dataset.

PublicDashboard.data_mode ● CustomDashboardDataMode! non-null enum

LIVE, or COMPILED: served from the dashboard's latest compile, read as the link's maker. A compiled dashboard has no date picker (date_restrictions is its compiled window), is dated by its compile (data_as_of), and its dashlets are read with publicCompiledDashletRows.

PublicDashboard.compile_state ● CustomDashboardCompileState enum

What a compiled dashboard's viewers are being served, as the page's banner says it. Null on a live dashboard.

Returned By

publicDashboard query