Class Dashboards

constructor

• new Dashboards(params: GenericModuleParams): Dashboards

  Parameters

  • params: GenericModuleParams

  Returns Dashboards

widgets

create

• create(dashboardObj: DashboardCreateInfo): Promise<{ dashboard: string }>

  Parameters

  • dashboardObj: DashboardCreateInfo

  Returns Promise<{ dashboard: string }>

  Description

  Creates a new dashboard in your application.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy Dashboard / Create in Access Management.

  const result = await Resources.dashboards.create({
    label: "My Dashboard",
    tags: [{ key: "type", value: "monitoring" }]
  });
  console.log(result); // { dashboard: 'dashboard-id-123' }
  Copy

delete

• delete(dashboardID: string): Promise<string>

  Parameters

  • dashboardID: string

  Returns Promise<string>

  Description

  Deletes a dashboard from the application.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy Dashboard / Delete in Access Management.

  const result = await Resources.dashboards.delete("dashboard-id-123");
  console.log(result); // Successfully Removed
  Copy

duplicate

• duplicate(
      dashboardID: string,
      dashboardObj?: { new_label?: string; setup?: object },
  ): Promise<{ dashboard_id: string; message: string }>

  Parameters

  • dashboardID: string
  • OptionaldashboardObj: { new_label?: string; setup?: object }

  Returns Promise<{ dashboard_id: string; message: string }>

  Description

  Creates a copy of an existing dashboard.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy Dashboard / Duplicate in Access Management.

  const result = await Resources.dashboards.duplicate("dashboard-id-123", { new_label: "Copy of My Dashboard" });
  console.log(result);
  Copy

edit

• edit(dashboardID: string, dashboardObj: Partial<DashboardInfo>): Promise<string>

  Parameters

  • dashboardID: string
  • dashboardObj: Partial<DashboardInfo>

  Returns Promise<string>

  Description

  Modifies an existing dashboard's properties.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy Dashboard / Edit in Access Management.

  const result = await Resources.dashboards.edit("dashboard-id-123", {
    label: "Updated Dashboard",
    active: false
  });
  console.log(result); // Successfully Updated
  Copy

getPublicKey

• getPublicKey(
      dashboardID: string,
      expireTime?: ExpireTimeOption,
  ): Promise<PublicKeyResponse>

  Parameters

  • dashboardID: string
  • expireTime: ExpireTimeOption = "never"

  Returns Promise<PublicKeyResponse>

  Description

  Generates a new public access token for the dashboard.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy in Access Management.

  const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
  const publicKey = await resources.dashboards.getPublicKey("dashboard-id-123", "1day");
  console.log(publicKey); // { token: 'token-id-123', expire_time: '2025-01-02T00:00:00.000Z' }
  Copy

info

• info(dashboardID: string): Promise<DashboardInfo>

  Parameters

  • dashboardID: string

  Returns Promise<DashboardInfo>

  Description

  Retrieves detailed information about a specific dashboard.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy Dashboard / Access in Access Management.

  const dashboardInfo = await Resources.dashboards.info("dashboard-id-123");
  console.log(dashboardInfo); // { id: 'dashboard-id-123', label: 'My Dashboard', ... }
  Copy

list

• list(queryObj?: DashboardQuery): Promise<DashboardInfo[]>

  Parameters

  • OptionalqueryObj: DashboardQuery

  Returns Promise<DashboardInfo[]>

  Description

  Lists all dashboards from your application with pagination support.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy Dashboard / Access in Access Management.

  const result = await Resources.dashboards.list({
    page: 1,
    fields: ["id", "name"],
    amount: 10,
    orderBy: ["label", "asc"]
  });
  console.log(result); // [ { id: 'dashboard-id-123', label: 'My Dashboard', ...}, ... ]
  Copy

listAnalysisRelated

• listAnalysisRelated(dashboardID: string): Promise<AnalysisRelated[]>

  Parameters

  • dashboardID: string

  Returns Promise<AnalysisRelated[]>

  Description

  Lists all analyses associated with a dashboard.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy Dashboard / Related analysis in Access Management.

  const analyses = await Resources.dashboards.listAnalysisRelated("dashboard-id-123");
  console.log(analyses); // [ { id: 'analysis-id-123', name: 'Analysis #1' }, ... ]
  Copy

listDevicesRelated

• listDevicesRelated(dashboardID: string): Promise<DevicesRelated[]>

  Parameters

  • dashboardID: string

  Returns Promise<DevicesRelated[]>

  Description

  Lists all devices associated with the dashboard.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

  Example

  If receive an error "Authorization Denied", check policy Dashboard / Related devices in Access Management.

  const devices = await Resources.dashboards.listDevicesRelated("dashboard-id-123");
  console.log(devices); // [ { id: 'device-id-123' }, { id: 'device-id-xyz' }, ... ]
  Copy

runWidgetHeaderButtonAnalysis

• runWidgetHeaderButtonAnalysis(
      analysisID: string,
      dashboardID: string,
      widgetID: string,
      scope?: object,
  ): Promise<string>

  Parameters

  • analysisID: string
  • dashboardID: string
  • widgetID: string
  • Optionalscope: object

  Returns Promise<string>

  Description

  Executes an analysis from a widget's header button.

  See

  https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview