Class Dashboards

widgets

create

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

• Generates and retrieves a new dashboard from the account

  Parameters

  • dashboardObj: DashboardCreateInfo

    Object data to create new Dashboard

  Returns Promise<{
      dashboard: string;
  }>

delete

• delete(dashboardID): Promise<string>

• Deletes an dashboard from the account

  Parameters

  • dashboardID: string

    Dashboard identification

  Returns Promise<string>

duplicate

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

• Duplicate the dashboard to your own account

  Parameters

  • dashboardID: string

    Dashboard identification
  • Optional dashboardObj: {
        new_label?: string;
        setup?: object;
    }

    Object with data of the duplicate dashboard

    • Optional new_label?: string

    • Optional setup?: object

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

edit

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

• Modify any property of the action

  Parameters

  • dashboardID: string

    Dashboard identification
  • dashboardObj: Partial<DashboardInfo>

    Dashboard Object with data to be replaced

  Returns Promise<string>

getPublicKey

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

• Generate a new public token for the dashboard

  Parameters

  • dashboardID: string

    Dashboard identification
  • expireTime: ExpireTimeOption = "never"

    Time when token will expire

  Returns Promise<PublicKeyResponse>

info

• info(dashboardID): Promise<DashboardInfo>

• Gets information about the dashboard

  Parameters

  • dashboardID: string

    Dashboard identification

  Returns Promise<DashboardInfo>

list

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

• Retrieves a list with all dashboards from the account

  Parameters

  • Optional queryObj: DashboardQuery

    Search query params

  Returns Promise<DashboardInfo[]>

  Default

  queryObj: {
    page: 1,
    fields: ["id", "name"],
    filter: {},
    amount: 20,
    orderBy: "label,asc",
  }
  Copy

listAnalysisRelated

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

• Get list of analysis related with a dashboard

  Parameters

  • dashboardID: string

    Dashboard identification

  Returns Promise<AnalysisRelated[]>

listDevicesRelated

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

• Get list of devices related with dashboard

  Parameters

  • dashboardID: string

    Dashboard identification

  Returns Promise<DevicesRelated[]>

runWidgetHeaderButtonAnalysis

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

• Runs an analysis located in a widget's header button

  Parameters

  • analysisID: string

    The id of the analysis to run
  • dashboardID: string

    The id of the dashboard that contains the widget
  • widgetID: string

    The id of the widget that contains the header button
  • Optional scope: object

    Data to send to the analysis

  Returns Promise<string>

shareDelete

• shareDelete(shareID): Promise<string>

• Remove share of the bucket

  Parameters

  • shareID: string

    Share identification

  Returns Promise<string>

shareEdit

• shareEdit(shareID, targetObj): Promise<string>

• Change permissions of the bucket

  Parameters

  • shareID: string

    Share identification
  • targetObj: Partial<InviteInfo>

    Object with target email and new permission

  Returns Promise<string>

shareList

• shareList(dashboardID): Promise<InviteInfo[]>

• Get share list of the dashboard

  Parameters

  • dashboardID: string

    Dashboard identification

  Returns Promise<InviteInfo[]>

shareSendInvite

• shareSendInvite(dashboardID, inviteObj): Promise<InviteResponse>

• Share the dashboard with another person

  Parameters

  • dashboardID: string

    Dashboard identification
  • inviteObj: InviteInfo

    Object with target and message

  Returns Promise<InviteResponse>