Skip to main content
Version: Next

DashboardDatasetSchema

always_filter_main_dttmboolean
cache_timeoutinteger
chart_display_labels object

Display labels keyed by member chart ID, then by the raw column or metric ID that chart uses. Only charts the caller can access and labels configured for their saved dimensions and metrics are included; omitted for semantic views, when there are none, or when the caller has datasource access and already receives verbose_map.

property name* object
property name*string
column_formatsobject
column_namesstring[]
column_typesinteger[]
columnsobject[]
currency_code_columnstring
database object
allow_multi_catalogboolean
allows_cost_estimateboolean
allows_subqueryboolean
allows_virtual_table_exploreboolean
backendstring
disable_data_previewboolean
disable_drill_to_detailboolean
explore_database_idinteger
idinteger
namestring
datasource_namestring
default_endpointstring
edit_urlstring
editors object[]
  • Array [
  • idinteger
    imgstring
    labelstring
    secondary_labelstring
    typeinteger
  • ]
  • fetch_values_predicatestring
    filter_selectboolean
    filter_select_enabledboolean
    granularity_sqlastring[][]
    health_check_messagestring
    idinteger
    is_sqllab_viewboolean
    main_dttm_colstring
    metadata_errorstring

    Validation error for this dataset only.

    metricsobject[]
    namestring
    normalize_columnsboolean
    offsetinteger
    order_by_choicesstring[][]
    paramsstring
    parentobject
    permstring
    schemastring
    select_starstring
    semantic_view_featuresstring[]
    sqlstring
    supports_drill_to_detailboolean
    supports_samplesboolean
    table_namestring
    template_paramsstring
    time_grain_sqlastring[][]
    typestring
    uidstring
    verbose_map object
    property name*string
    DashboardDatasetSchema
    {
    "always_filter_main_dttm": true,
    "cache_timeout": 0,
    "chart_display_labels": {},
    "column_formats": {},
    "column_names": [
    "string"
    ],
    "column_types": [
    0
    ],
    "columns": [
    {}
    ],
    "currency_code_column": "string",
    "database": {
    "allow_multi_catalog": true,
    "allows_cost_estimate": true,
    "allows_subquery": true,
    "allows_virtual_table_explore": true,
    "backend": "string",
    "disable_data_preview": true,
    "disable_drill_to_detail": true,
    "explore_database_id": 0,
    "id": 0,
    "name": "string"
    },
    "datasource_name": "string",
    "default_endpoint": "string",
    "edit_url": "string",
    "editors": [
    {
    "id": 0,
    "img": "string",
    "label": "string",
    "secondary_label": "string",
    "type": 0
    }
    ],
    "fetch_values_predicate": "string",
    "filter_select": true,
    "filter_select_enabled": true,
    "granularity_sqla": [
    "string"
    ],
    "health_check_message": "string",
    "id": 0,
    "is_sqllab_view": true,
    "main_dttm_col": "string",
    "metadata_error": "string",
    "metrics": [
    {}
    ],
    "name": "string",
    "normalize_columns": true,
    "offset": 0,
    "order_by_choices": [
    "string"
    ],
    "params": "string",
    "parent": {},
    "perm": "string",
    "schema": "string",
    "select_star": "string",
    "semantic_view_features": [
    "string"
    ],
    "sql": "string",
    "supports_drill_to_detail": true,
    "supports_samples": true,
    "table_name": "string",
    "template_params": "string",
    "time_grain_sqla": [
    "string"
    ],
    "type": "string",
    "uid": "string",
    "verbose_map": {}
    }