Databricks SDK for JavaScript
    Preparing search index...

    Interface DashboardTask

    Configures the Lakeview Dashboard job task type.

    interface DashboardTask {
        dashboardId?: string;
        filters?: Record<string, string>;
        subscription?: Subscription;
        warehouseId?: string;
    }
    Index

    Properties

    dashboardId? filters? subscription? warehouseId?

    Properties

    dashboardId?: string

    The identifier of the dashboard to refresh.

    filters?: Record<string, string>

    Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key. The parameter value format is dependent on the filter type:

    • For text and single-select filters, provide a single value (e.g. "value")
    • For date and datetime filters, provide the value in ISO 8601 format (e.g. "2000-01-01T00:00:00")
    • For multi-select filters, provide a JSON array of values (e.g. "[\"value1\",\"value2\"]")
    • For range and date range filters, provide a JSON object with start and end (e.g. "{\"start\":\"1\",\"end\":\"10\"}")
    subscription?: Subscription

    Optional: subscription configuration for sending the dashboard snapshot.

    warehouseId?: string

    Optional: The warehouse id to execute the dashboard with for the schedule. If not specified, the default warehouse of the dashboard will be used.

    Settings

    Member Visibility

    On This Page

    Properties