Explore Dashboard YAML

Explore dashboards provide an interactive way to explore data with predefined measures and dimensions.

Properties

`type`

[string] - Refers to the resource type and must be explore (required)

`display_name`

[string] - Refers to the display name for the explore dashboard (required)

`metrics_view`

[string] - Refers to the metrics view resource (required)

`description`

[string] - Refers to the description of the explore dashboard

`banner`

[string] - Refers to the custom banner displayed at the header of an explore dashboard

`dimensions`

[oneOf] - List of dimension names. Use '*' to select all dimensions (default)

option 1 - [string] - Wildcard(*) selector that includes all available fields in the selection
option 2 - [array of string] - Explicit list of fields to include in the selection
option 3 - [object] - Advanced matching using regex, DuckDB expression, or exclusion
- regex - [string] - Select fields using a regular expression
- expr - [string] - DuckDB SQL expression to select fields based on custom logic
- exclude - [object] - Select all fields except those listed here

# Example: Select a dimension
dimensions:
    - country

# Example: Select all dimensions except one
dimensions:
    exclude:
        - country

# Example: Select all dimensions that match a regex
dimensions:
    expr: "^public_.*$"

`measures`

[oneOf] - List of measure names. Use '*' to select all measures (default)

option 1 - [string] - Wildcard(*) selector that includes all available fields in the selection
option 2 - [array of string] - Explicit list of fields to include in the selection
option 3 - [object] - Advanced matching using regex, DuckDB expression, or exclusion
- regex - [string] - Select fields using a regular expression
- expr - [string] - DuckDB SQL expression to select fields based on custom logic
- exclude - [object] - Select all fields except those listed here

# Example: Select a measure
measures:
    - sum_of_total

# Example: Select all measures except one
measures:
    exclude:
        - sum_of_total

# Example: Select all measures that match a regex
measures:
    expr: "^public_.*$"

`theme`

[oneOf] - Name of the theme to use. Only one of theme and embedded_theme can be set.

option 1 - [string] - Name of an existing theme to apply to the dashboard
option 2 - [object] - Inline theme configuration.
- colors - [object] - Used to override the dashboard colors. Either primary or secondary color must be provided.
  - primary - [string] - Overrides the primary blue color in the dashboard. Can have any hex (without the '#' character), named colors or hsl() formats. Note that the hue of the input colors is used for variants but the saturation and lightness is copied over from the blue color palette.
  - secondary - [string] - Overrides the secondary color in the dashboard. Applies to the loading spinner only as of now. Can have any hex (without the '#' character), named colors or hsl() formats.

`time_ranges`

[array of oneOf] - Overrides the list of default time range selections available in the dropdown. It can be string or an object with a 'range' and optional 'comparison_offsets'

time_ranges:
  - PT15M // Simplified syntax to specify only the range
  - PT1H
  - PT6H
  - P7D
  - range: P5D // Advanced syntax to specify comparison_offsets as well
  - P4W
  - rill-TD // Today
  - rill-WTD // Week-To-date

option 1 - [string] - a valid ISO 8601 duration or one of the Rill ISO 8601 extensions extensions for the selection
option 2 - [object] - Object containing time range and comparison configuration
- range - [string] - a valid ISO 8601 duration or one of the Rill ISO 8601 extensions extensions for the selection (required)
- comparison_offsets - [array of oneOf] - list of time comparison options for this time range selection (optional). Must be one of the Rill ISO 8601 extensions
  - option 1 - [string] - Offset string only (range is inferred)
  - option 2 - [object] - Object containing offset and range configuration for time comparison
    - offset - [string] - Time offset for comparison (e.g., 'P1D' for one day ago)
    - range - [string] - Custom time range for comparison period

`time_zones`

[array of string] - Refers to the time zones that should be pinned to the top of the time zone selector. It should be a list of IANA time zone identifiers

`lock_time_zone`

[boolean] - When true, the dashboard will be locked to the first time provided in the time_zones list. When no time_zones are provided, the dashboard will be locked to UTC

`allow_custom_time_range`

[boolean] - Defaults to true, when set to false it will hide the ability to set a custom time range for the user.

`defaults`

[object] - defines the defaults YAML struct

defaults: #define all the defaults within here
  dimensions:
    - dim_1
    - dim_2
  measures:
    - measure_1
    - measure_2
  time_range: P1M
  comparison_mode: dimension #time, none
  comparison_dimension: filename

dimensions - [oneOf] - Provides the default dimensions to load on viewing the dashboard
- option 1 - [string] - Wildcard(*) selector that includes all available fields in the selection
- option 2 - [array of string] - Explicit list of fields to include in the selection
- option 3 - [object] - Advanced matching using regex, DuckDB expression, or exclusion
  - regex - [string] - Select fields using a regular expression
  - expr - [string] - DuckDB SQL expression to select fields based on custom logic
  - exclude - [object] - Select all fields except those listed here
measures - [oneOf] - Provides the default measures to load on viewing the dashboard
- option 1 - [string] - Wildcard(*) selector that includes all available fields in the selection
- option 2 - [array of string] - Explicit list of fields to include in the selection
- option 3 - [object] - Advanced matching using regex, DuckDB expression, or exclusion
  - regex - [string] - Select fields using a regular expression
  - expr - [string] - DuckDB SQL expression to select fields based on custom logic
  - exclude - [object] - Select all fields except those listed here
time_range - [string] - Refers to the default time range shown when a user initially loads the dashboard. The value must be either a valid ISO 8601 duration (for example, PT12H for 12 hours, P1M for 1 month, or P26W for 26 weeks) or one of the Rill ISO 8601 extensions
comparison_mode - [string] - Controls how to compare current data with historical or categorical baselines. Options: none (no comparison), time (compares with past based on default_time_range), dimension (compares based on comparison_dimension values)
comparison_dimension - [string] - for dimension mode, specify the comparison dimension by name

`embeds`

[object] - Configuration options for embedded dashboard views

hide_pivot - [boolean] - When true, hides the pivot table view in embedded mode

`security`

[object] - Defines security rules and access control policies for dashboards (without row filtering)

access - [oneOf] - Expression indicating if the user should be granted access to the dashboard. If not defined, it will resolve to false and the dashboard won't be accessible to anyone. Needs to be a valid SQL expression that evaluates to a boolean.
- option 1 - [string] - SQL expression that evaluates to a boolean to determine access
- option 2 - [boolean] - Direct boolean value to allow or deny access

Common Properties

`name`

[string] - Name is usually inferred from the filename, but can be specified manually.

`refs`

[array of string] - List of resource references

`dev`

[object] - Overrides any properties in development environment.

`prod`

[object] - Overrides any properties in production environment.

Properties​

type​

display_name​

metrics_view​

description​

banner​

dimensions​

measures​

theme​

time_ranges​

time_zones​

lock_time_zone​

allow_custom_time_range​

defaults​

embeds​

security​

Common Properties​

name​

refs​

dev​

prod​