The metadata object associated with how a dashboard has been/will be shared.

Hierarchy

  • SharedDashboard

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

User who shared the dashboard.

createdAt?: Date

Date the dashboard was shared.

dashboardId: string

ID of the dashboard to share.

dashboardType: v1.DashboardType

The type of the associated private dashboard.

globalTime?: DashboardGlobalTime

Object containing the live span selection for the dashboard.

globalTimeSelectableEnabled?: boolean

Whether to allow viewers to select a different global time setting for the shared dashboard.

publicUrl?: string

URL of the shared dashboard.

selectableTemplateVars?: SelectableTemplateVariableItems[]

List of objects representing template variables on the shared dashboard which can have selectable values.

shareList?: string[]

List of email addresses that can receive an invitation to access to the shared dashboard.

shareType?: DashboardShareType

Type of sharing access (either open to anyone who has the public URL or invite-only).

token?: string

A unique token assigned to the shared dashboard.

Generated using TypeDoc