Class Dashboard<S>

constructor

• new Dashboard<S extends Schema>(conn: Connection<S>, id: string): Dashboard<S>

  Type Parameters

  • S extends Schema

  Parameters

  • conn: Connection<S>
  • id: string

  Returns Dashboard<S>

_conn

del

delete

id

clone

• clone(
      config: string | { folderId?: string; name: string },
      folderId?: string,
  ): Promise<DashboardMetadata>

  Clone a dashboard

  Parameters

  • config: string | { folderId?: string; name: string }
  • OptionalfolderId: string

  Returns Promise<DashboardMetadata>

components

• components(componentIds?: string | string[]): Promise<DashboardResult>

  Get details about dashboard components

  Parameters

  • OptionalcomponentIds: string | string[]

  Returns Promise<DashboardResult>

describe

• describe(): Promise<DashboardMetadata>

  Describe dashboard metadata

  Returns Promise<DashboardMetadata>

  Method

  Analytics~Dashboard#describe

destroy

• destroy(): Promise<void>

  Destroy a dashboard

  Returns Promise<void>

refresh

• refresh(): Promise<DashboardRefreshResult>

  Refresh a dashboard

  Returns Promise<DashboardRefreshResult>

status

• status(): Promise<DashboardStatusResult>

  Get dashboard status

  Returns Promise<DashboardStatusResult>