Skip to main content

CustomDashboard

A dashboard the requesting user can open

type CustomDashboard {
accessRole: CustomDashboardAccessRole!
capabilities: CustomDashboardCapabilities!
createdAt: ISO8601DateTime!
definition: JSON!
definitionVersion: Int!
description: String!
id: ID!
lockVersion: Int!
name: String!
origin: CustomDashboardOrigin!
originAt: ISO8601DateTime
owner: CustomDashboardPerson!
ownerActive: Boolean!
sharingSummary: CustomDashboardSharingSummary!
timezone: String!
updatedAt: ISO8601DateTime!
widgetCount: Int!
}

Fields​

CustomDashboard.accessRole ● CustomDashboardAccessRole! non-null enum​

CustomDashboard.capabilities ● CustomDashboardCapabilities! non-null object​

CustomDashboard.createdAt ● ISO8601DateTime! non-null scalar​

CustomDashboard.definition ● JSON! non-null scalar​

Canonical DefinitionV1 of this revision

CustomDashboard.definitionVersion ● Int! non-null scalar​

CustomDashboard.description ● String! non-null scalar​

CustomDashboard.id ● ID! non-null scalar​

CustomDashboard.lockVersion ● Int! non-null scalar​

Revision; pass back as expectedVersion

CustomDashboard.name ● String! non-null scalar​

CustomDashboard.origin ● CustomDashboardOrigin! non-null enum​

CustomDashboard.originAt ● ISO8601DateTime scalar​

CustomDashboard.owner ● CustomDashboardPerson! non-null object​

CustomDashboard.ownerActive ● Boolean! non-null scalar​

False = orphaned: nobody but a super user can share, configure, transfer or delete it

CustomDashboard.sharingSummary ● CustomDashboardSharingSummary! non-null object​

CustomDashboard.timezone ● String! non-null scalar​

CustomDashboard.updatedAt ● ISO8601DateTime! non-null scalar​

CustomDashboard.widgetCount ● Int! non-null scalar​

Returned By​

customDashboard query

Member Of​

CreateCustomDashboardPayload object ● CustomDashboardPaginatedCollection object ● DuplicateCustomDashboardPayload object ● ImportCustomDashboardsPayload object ● InstallCustomDashboardPackPayload object ● TransferCustomDashboardOwnershipPayload object ● UpdateCustomDashboardPayload object

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute