Skip to main content

# Dashboard

The dashboard type.

    type Dashboard {
      id: ID!
      name: String
      description: String
      type: DashboardType!
      shared: Boolean
      owner: User!
      ownerId: ID
      autoLoginUser: User
      autoLoginUserId: ID
      custId: Int @deprecated
      customer: Customer
      definition: String
      timestamp: DateTime
      sharing: [DashboardSharing!]!
      creator: DashboardCreator!
    }

### Fields​

#### `Dashboard.id` ● `ID!` non-null scalar​

The unique ID of a dashboard.

#### `Dashboard.name` ● `String` scalar​

#### `Dashboard.description` ● `String` scalar​

#### `Dashboard.type` ● `DashboardType!` non-null enum​

#### `Dashboard.shared` ● `Boolean` scalar​

#### `Dashboard.owner` ● `User!` non-null object​

#### `Dashboard.ownerId` ● `ID` scalar​

#### `Dashboard.autoLoginUser` ● `User` object​

#### `Dashboard.autoLoginUserId` ● `ID` scalar​

#### `Dashboard.custId` ● `Int` deprecated scalar​

DEPRECATED

Will be removed in a later version.

#### `Dashboard.customer` ● `Customer` object​

The associated customer.

#### `Dashboard.definition` ● `String` scalar​

The definition is Json, which describes the dashboard.

#### `Dashboard.timestamp` ● `DateTime` scalar​

#### `Dashboard.sharing` ● `[DashboardSharing!]!` non-null object​

The list of dashboard sharing configurations for this dashboards.

#### `Dashboard.creator` ● `DashboardCreator!` non-null enum​

The creator application for this dashboard.

### Returned By​

`copyDashboard` mutation ● `createDashboard` mutation ● `dashboard` query ● `updateDashboard` mutation

### Member Of​

`DashboardPage` object ● `DashboardSharing` object