Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. getDashboards
Viewing docs for vantage 0.4.4
published on Monday, Oct 26, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

vantage.getDashboards

vantage
Viewing docs for vantage 0.4.4
published on Monday, Oct 26, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Using getDashboards

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDashboards(args: GetDashboardsArgs, opts?: InvokeOptions): Promise<GetDashboardsResult>
function getDashboardsOutput(args: GetDashboardsOutputArgs, opts?: InvokeOutputOptions): Output<GetDashboardsResult>
    def get_dashboards(q: Optional[str] = None,
                   workspace_token: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDashboardsResult
def get_dashboards_output(q: pulumi.Input[Optional[str]] = None,
                   workspace_token: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetDashboardsResult]
    func GetDashboards(ctx *Context, args *GetDashboardsArgs, opts ...InvokeOption) (*GetDashboardsResult, error)
func GetDashboardsOutput(ctx *Context, args *GetDashboardsOutputArgs, opts ...InvokeOption) GetDashboardsResultOutput

    > Note: This function is named GetDashboards in the Go SDK.

    public static class GetDashboards 
{
    public static Task<GetDashboardsResult> InvokeAsync(GetDashboardsArgs args, InvokeOptions? opts = null)
    public static Output<GetDashboardsResult> Invoke(GetDashboardsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetDashboardsResult> Invoke(GetDashboardsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
public static Output<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
public static Output<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: vantage:index/getDashboards:getDashboards
  arguments:
    # arguments dictionary
    data "vantage_get_dashboards" "name" {
    # arguments
}

    The following arguments are supported:

    Q string
    Search dashboards by title.
    WorkspaceToken string
    The workspace token of the dashboards to return.
    Q string
    Search dashboards by title.
    WorkspaceToken string
    The workspace token of the dashboards to return.
    q string
    Search dashboards by title.
    workspace_token string
    The workspace token of the dashboards to return.
    q String
    Search dashboards by title.
    workspaceToken String
    The workspace token of the dashboards to return.
    q string
    Search dashboards by title.
    workspaceToken string
    The workspace token of the dashboards to return.
    q str
    Search dashboards by title.
    workspace_token str
    The workspace token of the dashboards to return.
    q String
    Search dashboards by title.
    workspaceToken String
    The workspace token of the dashboards to return.

    getDashboards Result

    The following output properties are available:

    Dashboards List<GetDashboardsDashboard>
    Id string
    The provider-assigned unique ID for this managed resource.
    Q string
    Search dashboards by title.
    WorkspaceToken string
    The workspace token of the dashboards to return.
    Dashboards []GetDashboardsDashboard
    Id string
    The provider-assigned unique ID for this managed resource.
    Q string
    Search dashboards by title.
    WorkspaceToken string
    The workspace token of the dashboards to return.
    dashboards list(object)
    id string
    The provider-assigned unique ID for this managed resource.
    q string
    Search dashboards by title.
    workspace_token string
    The workspace token of the dashboards to return.
    dashboards List<GetDashboardsDashboard>
    id String
    The provider-assigned unique ID for this managed resource.
    q String
    Search dashboards by title.
    workspaceToken String
    The workspace token of the dashboards to return.
    dashboards GetDashboardsDashboard[]
    id string
    The provider-assigned unique ID for this managed resource.
    q string
    Search dashboards by title.
    workspaceToken string
    The workspace token of the dashboards to return.
    dashboards Sequence[GetDashboardsDashboard]
    id str
    The provider-assigned unique ID for this managed resource.
    q str
    Search dashboards by title.
    workspace_token str
    The workspace token of the dashboards to return.
    dashboards List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    q String
    Search dashboards by title.
    workspaceToken String
    The workspace token of the dashboards to return.

    Supporting Types

    GetDashboardsDashboard

    CreatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    DateBin string
    Determines how to group costs in the Dashboard.
    DateInterval string
    Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
    EndDate string
    The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    Id string
    The id of the resource
    SavedFilterTokens List<string>
    The tokens of the Saved Filters used in the Dashboard.
    StartDate string
    The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    Title string
    The title of the Dashboard.
    Token string
    UpdatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    Widgets List<GetDashboardsDashboardWidget>
    The widgets displayed in the Dashboard. Report-backed widgets include widgetabletoken and settings. Free text widgets include widgetabletype set to freetext and content, omit widgetabletoken, and include settings when a grid layout is persisted.
    WorkspaceToken string
    The token for the Workspace the Dashboard is a part of.
    CreatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    DateBin string
    Determines how to group costs in the Dashboard.
    DateInterval string
    Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
    EndDate string
    The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    Id string
    The id of the resource
    SavedFilterTokens []string
    The tokens of the Saved Filters used in the Dashboard.
    StartDate string
    The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    Title string
    The title of the Dashboard.
    Token string
    UpdatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    Widgets []GetDashboardsDashboardWidget
    The widgets displayed in the Dashboard. Report-backed widgets include widgetabletoken and settings. Free text widgets include widgetabletype set to freetext and content, omit widgetabletoken, and include settings when a grid layout is persisted.
    WorkspaceToken string
    The token for the Workspace the Dashboard is a part of.
    created_at string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    date_bin string
    Determines how to group costs in the Dashboard.
    date_interval string
    Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
    end_date string
    The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    id string
    The id of the resource
    saved_filter_tokens list(string)
    The tokens of the Saved Filters used in the Dashboard.
    start_date string
    The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    title string
    The title of the Dashboard.
    token string
    updated_at string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    widgets list(object)
    The widgets displayed in the Dashboard. Report-backed widgets include widgetabletoken and settings. Free text widgets include widgetabletype set to freetext and content, omit widgetabletoken, and include settings when a grid layout is persisted.
    workspace_token string
    The token for the Workspace the Dashboard is a part of.
    createdAt String
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    dateBin String
    Determines how to group costs in the Dashboard.
    dateInterval String
    Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
    endDate String
    The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    id String
    The id of the resource
    savedFilterTokens List<String>
    The tokens of the Saved Filters used in the Dashboard.
    startDate String
    The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    title String
    The title of the Dashboard.
    token String
    updatedAt String
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    widgets List<GetDashboardsDashboardWidget>
    The widgets displayed in the Dashboard. Report-backed widgets include widgetabletoken and settings. Free text widgets include widgetabletype set to freetext and content, omit widgetabletoken, and include settings when a grid layout is persisted.
    workspaceToken String
    The token for the Workspace the Dashboard is a part of.
    createdAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    dateBin string
    Determines how to group costs in the Dashboard.
    dateInterval string
    Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
    endDate string
    The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    id string
    The id of the resource
    savedFilterTokens string[]
    The tokens of the Saved Filters used in the Dashboard.
    startDate string
    The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    title string
    The title of the Dashboard.
    token string
    updatedAt string
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    widgets GetDashboardsDashboardWidget[]
    The widgets displayed in the Dashboard. Report-backed widgets include widgetabletoken and settings. Free text widgets include widgetabletype set to freetext and content, omit widgetabletoken, and include settings when a grid layout is persisted.
    workspaceToken string
    The token for the Workspace the Dashboard is a part of.
    created_at str
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    date_bin str
    Determines how to group costs in the Dashboard.
    date_interval str
    Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
    end_date str
    The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    id str
    The id of the resource
    saved_filter_tokens Sequence[str]
    The tokens of the Saved Filters used in the Dashboard.
    start_date str
    The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    title str
    The title of the Dashboard.
    token str
    updated_at str
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    widgets Sequence[GetDashboardsDashboardWidget]
    The widgets displayed in the Dashboard. Report-backed widgets include widgetabletoken and settings. Free text widgets include widgetabletype set to freetext and content, omit widgetabletoken, and include settings when a grid layout is persisted.
    workspace_token str
    The token for the Workspace the Dashboard is a part of.
    createdAt String
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    dateBin String
    Determines how to group costs in the Dashboard.
    dateInterval String
    Determines the date range for Reports in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
    endDate String
    The end date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    id String
    The id of the resource
    savedFilterTokens List<String>
    The tokens of the Saved Filters used in the Dashboard.
    startDate String
    The start date for the date range for Reports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
    title String
    The title of the Dashboard.
    token String
    updatedAt String
    The date and time, in UTC, the Dashboard was created. ISO 8601 Formatted.
    widgets List<Property Map>
    The widgets displayed in the Dashboard. Report-backed widgets include widgetabletoken and settings. Free text widgets include widgetabletype set to freetext and content, omit widgetabletoken, and include settings when a grid layout is persisted.
    workspaceToken String
    The token for the Workspace the Dashboard is a part of.

    GetDashboardsDashboardWidget

    Content string
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    Settings GetDashboardsDashboardWidgetSettings
    Title string
    The title of the Widget.
    Token string
    The token of the Dashboard Widget.
    WidgetableToken string
    The token of the represented Resource.
    WidgetableType string
    The widget type. Present instead of widgetable_token for free text widgets.
    Content string
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    Settings GetDashboardsDashboardWidgetSettings
    Title string
    The title of the Widget.
    Token string
    The token of the Dashboard Widget.
    WidgetableToken string
    The token of the represented Resource.
    WidgetableType string
    The widget type. Present instead of widgetable_token for free text widgets.
    content string
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings object
    title string
    The title of the Widget.
    token string
    The token of the Dashboard Widget.
    widgetable_token string
    The token of the represented Resource.
    widgetable_type string
    The widget type. Present instead of widgetable_token for free text widgets.
    content String
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings GetDashboardsDashboardWidgetSettings
    title String
    The title of the Widget.
    token String
    The token of the Dashboard Widget.
    widgetableToken String
    The token of the represented Resource.
    widgetableType String
    The widget type. Present instead of widgetable_token for free text widgets.
    content string
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings GetDashboardsDashboardWidgetSettings
    title string
    The title of the Widget.
    token string
    The token of the Dashboard Widget.
    widgetableToken string
    The token of the represented Resource.
    widgetableType string
    The widget type. Present instead of widgetable_token for free text widgets.
    content str
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings GetDashboardsDashboardWidgetSettings
    title str
    The title of the Widget.
    token str
    The token of the Dashboard Widget.
    widgetable_token str
    The token of the represented Resource.
    widgetable_type str
    The widget type. Present instead of widgetable_token for free text widgets.
    content String
    JSON-encoded TipTap document for a free text widget. Example: {"type":"doc","content":[...]}
    settings Property Map
    title String
    The title of the Widget.
    token String
    The token of the Dashboard Widget.
    widgetableToken String
    The token of the represented Resource.
    widgetableType String
    The widget type. Present instead of widgetable_token for free text widgets.

    GetDashboardsDashboardWidgetSettings

    DisplayType string
    Grid GetDashboardsDashboardWidgetSettingsGrid
    KpiCalculation string
    The aggregation used when display_type is kpi.
    KpiType string
    The metric represented by the KPI.
    KpiUsageUnit string
    The usage unit represented by the KPI.
    DisplayType string
    Grid GetDashboardsDashboardWidgetSettingsGrid
    KpiCalculation string
    The aggregation used when display_type is kpi.
    KpiType string
    The metric represented by the KPI.
    KpiUsageUnit string
    The usage unit represented by the KPI.
    display_type string
    grid object
    kpi_calculation string
    The aggregation used when display_type is kpi.
    kpi_type string
    The metric represented by the KPI.
    kpi_usage_unit string
    The usage unit represented by the KPI.
    displayType String
    grid GetDashboardsDashboardWidgetSettingsGrid
    kpiCalculation String
    The aggregation used when display_type is kpi.
    kpiType String
    The metric represented by the KPI.
    kpiUsageUnit String
    The usage unit represented by the KPI.
    displayType string
    grid GetDashboardsDashboardWidgetSettingsGrid
    kpiCalculation string
    The aggregation used when display_type is kpi.
    kpiType string
    The metric represented by the KPI.
    kpiUsageUnit string
    The usage unit represented by the KPI.
    display_type str
    grid GetDashboardsDashboardWidgetSettingsGrid
    kpi_calculation str
    The aggregation used when display_type is kpi.
    kpi_type str
    The metric represented by the KPI.
    kpi_usage_unit str
    The usage unit represented by the KPI.
    displayType String
    grid Property Map
    kpiCalculation String
    The aggregation used when display_type is kpi.
    kpiType String
    The metric represented by the KPI.
    kpiUsageUnit String
    The usage unit represented by the KPI.

    GetDashboardsDashboardWidgetSettingsGrid

    H double
    The widget height in grid rows.
    W double
    The widget width in grid columns.
    X double
    The zero-based horizontal position in the 12-column grid.
    Y double
    The zero-based vertical position in the grid.
    H float64
    The widget height in grid rows.
    W float64
    The widget width in grid columns.
    X float64
    The zero-based horizontal position in the 12-column grid.
    Y float64
    The zero-based vertical position in the grid.
    h number
    The widget height in grid rows.
    w number
    The widget width in grid columns.
    x number
    The zero-based horizontal position in the 12-column grid.
    y number
    The zero-based vertical position in the grid.
    h Double
    The widget height in grid rows.
    w Double
    The widget width in grid columns.
    x Double
    The zero-based horizontal position in the 12-column grid.
    y Double
    The zero-based vertical position in the grid.
    h number
    The widget height in grid rows.
    w number
    The widget width in grid columns.
    x number
    The zero-based horizontal position in the 12-column grid.
    y number
    The zero-based vertical position in the grid.
    h float
    The widget height in grid rows.
    w float
    The widget width in grid columns.
    x float
    The zero-based horizontal position in the 12-column grid.
    y float
    The zero-based vertical position in the grid.
    h Number
    The widget height in grid rows.
    w Number
    The widget width in grid columns.
    x Number
    The zero-based horizontal position in the 12-column grid.
    y Number
    The zero-based vertical position in the grid.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage
    Viewing docs for vantage 0.4.4
    published on Monday, Oct 26, 2026 by vantage-sh
    Schema (JSON)
    vantage-sh/terraform-provider-vantage

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial