CustomDashboard

No description

type CustomDashboard {
  id: ID!
  uuid: String!
  name: String!
  description: String
  folder_id: ID
  archived: Boolean!
  source: CustomDashboardSource!
  chat_conversation_id: ID
  share_token: String
  is_saved: Boolean!
  expires_at: DateTime
  revision: CustomDashboardRevisionSummary
  window: DatasetReportWindowResolved!
  compare: DatasetCompare!
  dashlets: [CustomDashboardDashlet!]!
  layout: [CustomDashboardLayoutSlot!]!
  rows: [CustomDashboardRow!]!
  filters: [CustomDashboardFilter!]!
  colors: [CustomDashboardColor!]!
  content: [CustomDashboardContent!]!
  path: [PathPart!]
  data_mode: CustomDashboardDataMode!
  compile_settings: CustomDashboardCompileSettings
  current_compile: CustomDashboardCompile
  pending_compile: CustomDashboardCompile
  refresh_available_at: DateTime
  compile_state: CustomDashboardCompileState
  live_load_health: CustomDashboardLiveLoadHealth
  created_at: DateTime!
  created_by: User
  updated_at: DateTime!
  updated_by: User
}

Fields

CustomDashboard.id ● ID! non-null scalar

CustomDashboard.uuid ● String! non-null scalar

CustomDashboard.name ● String! non-null scalar

CustomDashboard.description ● String scalar

CustomDashboard.folder_id ● ID scalar

CustomDashboard.archived ● Boolean! non-null scalar

CustomDashboard.source ● CustomDashboardSource! non-null enum

CustomDashboard.chat_conversation_id ● ID scalar

The Paminga IQ conversation that built the dashboard, when one did.

CustomDashboard.share_token ● String scalar

Set once the dashboard has been shared. Null until then.

CustomDashboard.is_saved ● Boolean! non-null scalar

False until the dashboard is first saved. An unsaved dashboard is deleted at expires_at.

CustomDashboard.expires_at ● DateTime scalar

When an unsaved dashboard will be deleted, 30 days after it was created. Null once saved.

CustomDashboard.revision ● CustomDashboardRevisionSummary object

The revision shown below: the draft when there is one (what Save would publish), otherwise the published revision. Null only for a dashboard with no live revision at all.

CustomDashboard.window ● DatasetReportWindowResolved! non-null object

CustomDashboard.compare ● DatasetCompare! non-null enum

What a dashlet whose compare switch is on is compared with: PRIOR_YEAR on a dashboard saved comparing with the previous year, which it keeps; anything else means the previous period. Whether a dashlet compares is its own switch.

CustomDashboard.dashlets ● [CustomDashboardDashlet!]! non-null object

CustomDashboard.layout ● [CustomDashboardLayoutSlot!]! non-null object

CustomDashboard.rows ● [CustomDashboardRow!]! non-null object

One per row of the layout, top to bottom.

CustomDashboard.filters ● [CustomDashboardFilter!]! non-null object

Filters bound to URL parameters; see CustomDashboardFilter.

CustomDashboard.colors ● [CustomDashboardColor!]! non-null object

Series values locked to a palette slot. Empty when none is.

CustomDashboard.content ● [CustomDashboardContent!]! non-null object

Its SECTION and TEXT cards. The layout places them by id.

CustomDashboard.path ● [PathPart!] list object

The folders the dashboard sits in, outermost first. Empty when it is in none.

CustomDashboard.data_mode ● CustomDashboardDataMode! non-null enum

LIVE or COMPILED.

CustomDashboard.compile_settings ● CustomDashboardCompileSettings object

The compile's window and zone. Null while the dashboard has never been compiled.

CustomDashboard.current_compile ● CustomDashboardCompile object

The compile viewers are shown. Null on a live dashboard, and before the first compile lands.

CustomDashboard.pending_compile ● CustomDashboardCompile object

The newest compile when it is newer than the one shown: QUEUED or RUNNING while the dashboard is being prepared or updated, FAILED when the latest attempt failed. Null otherwise.

CustomDashboard.refresh_available_at ● DateTime scalar

When Refresh now can next be used (once an hour per dashboard). Null when it can be now.

CustomDashboard.compile_state ● CustomDashboardCompileState enum

What a compiled dashboard's viewers are being served. Null on a live dashboard.

CustomDashboard.live_load_health ● CustomDashboardLiveLoadHealth object

How it has actually run live over the last 7 days. Null on a compiled dashboard, or for someone who cannot edit it.

CustomDashboard.created_at ● DateTime! non-null scalar

CustomDashboard.created_by ● User object

CustomDashboard.updated_at ● DateTime! non-null scalar

CustomDashboard.updated_by ● User object

Returned By

archiveCustomDashboards mutation ● createCustomDashboard mutation ● createCustomDashboardFromTemplate mutation ● customDashboard query ● customDashboardByShareToken query ● customDashboards query ● deleteCustomDashboard mutation ● saveCustomDashboard mutation ● saveCustomDashboardLayout mutation ● shareCustomDashboard mutation ● unarchiveCustomDashboards mutation

Member Of

CustomDashboardsResponse object