Skip to content

docs(timezones): drop experimental gating from convert_timezone and embed timezone #1241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
almeidabbm merged 1 commit into from
Sep 10, 2026
Merged

docs(timezones): drop experimental gating from convert_timezone and embed timezone #1241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion embed/iframe.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ https://app.lightdash.cloud/embed/abc-123?backgroundColor=1c1c1c#eyJhbGci...
### `timezone`

<Info>
<Badge icon="flask" color="purple" size="sm" shape="pill">Beta</Badge> Contact support to enable the embed `timezone` param for your organization. While it is off, the param is ignored and the session falls back to the chart pin or project default. [What Beta means](/support/feature-maturity-levels).
<Badge icon="flask" color="purple" size="sm" shape="pill">Beta</Badge> The embed `timezone` param is available to all organizations. On self-hosted instances where timezone support is disabled with `LIGHTDASH_ENABLE_TIMEZONE_SUPPORT=false`, the param is ignored and the session falls back to the chart pin or project default. [What Beta means](/support/feature-maturity-levels).
</Info>

Sets a per-session query timezone for the embed. Use it when one embedded dashboard needs to render in different timezones for different viewers (for example, a multi-tenant app where each tenant has its own timezone), without creating separate charts per timezone.
Expand Down
4 changes: 2 additions & 2 deletions semantic-layer/dimensions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ The table below shows all the dimension properties you can customize:
| [case_sensitive](#case-sensitive) | No | boolean | If set to `false`, string filters on this dimension will be case insensitive. Defaults to `true`. Overrides explore-level setting. |
| [filter_autocomplete](#filter-autocomplete) | No | Object | Configure the filter autocomplete suggestions for this dimension. Provide a static list of `values` (with optional display `label`s), point at a `label_dimension` in the same table to label warehouse-fetched values, source values from a dimension in another model with `options_from_dimension`, and/or disable warehouse-based autocomplete by setting `fetch_from_warehouse: false`. |
| [tags](#tags) | No | string[] | An array of string tags for categorizing and filtering dimensions programmatically. Tags can be used by AI agents, API filters, and other backend workflows. |
| [convert_timezone](#convert-timezone) | No | boolean | **[Experimental]** If set to `false`, the dimension opts out of the project query timezone for display, grouping, and extracts - the raw warehouse value is rendered instead. Defaults to `true`. Has no effect unless a project query timezone is set. |
| [convert_timezone](#convert-timezone) | No | boolean | If set to `false`, the dimension opts out of the project query timezone for display, grouping, and extracts - the raw warehouse value is rendered instead. Defaults to `true`. Has no effect unless a project query timezone is set. |
| [timestamp_domain](#timestamp-domain) | No | `aware` or `naive` | Declares whether a `timestamp` column stores an instant (`aware`) or a bare wall clock with no zone (`naive`). Overrides what Lightdash detects from the warehouse catalog. |


Expand Down Expand Up @@ -1156,7 +1156,7 @@ Lightdash dimensions and custom metrics are protected by this feature, however,
## Convert timezone

<Info>
<Badge icon="test-pipe-2" color="orange" size="sm" shape="pill">Experimental</Badge> Contact support to enable the `convert_timezone` dimension override for your organization. It has no effect unless the [project query timezone](/workspace-admin/set-project-timezone#configure-your-project-timezone) is set. [What Experimental means](/support/feature-maturity-levels).
`convert_timezone` has no effect unless the [project query timezone](/workspace-admin/set-project-timezone#configure-your-project-timezone) is set.
</Info>

Set `convert_timezone: false` on a `timestamp` dimension to opt it out of the project query timezone. This is useful for columns that should always render in their raw warehouse value - system timestamps, audit logs, or pre-converted timezone columns.
Expand Down
Loading