---
title: "Preview data timezone"
method: POST
path: "/api/v1/projects/preview-data-timezone"
tags: ["Projects"]
---

# Preview data timezone

`POST /api/v1/projects/preview-data-timezone`

Preview how the warehouse disambiguates "now" under a data timezone

## Request body

- union
  - object
    - `credentials` union, required
      - CreateRedshiftCredentials
        - `sshTunnelPrivateKey` string
        - `sshTunnelPublicKey` string
        - `sshTunnelUser` string
        - `sshTunnelPort` number, double
        - `sshTunnelHost` string
        - `useSshTunnel` boolean
        - `awsSsoRoleName` string
        - `awsSsoAccountId` string
        - `awsSsoRegion` string
        - `awsSsoStartUrl` string
        - `assumeRoleExternalId` string
        - `assumeRoleArn` string
        - `sessionToken` string
        - `secretAccessKey` string
        - `accessKeyId` string
        - `dbGroups` string[]
        - `autoCreate` boolean
        - `workgroupName` string
        - `clusterIdentifier` string
        - `isServerless` boolean
        - `region` string
        - `authenticationType` 'password' | 'iam' | 'iam_browser'
        - `timeoutSeconds` number, double
        - `dataTimezone` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `ra3Node` boolean
        - `sslmode` string
        - `keepalivesIdle` number, double
        - `threads` number, double
        - `schema` string, required
        - `dbname` string, required
        - `port` number, double, required
        - `requireUserCredentials` boolean
        - `password` string
        - `user` string, required
        - `host` string, required
        - `type` 'redshift', required
      - CreateBigqueryCredentials
        - `accessUrl` string
        - `executionProject` string
        - `dataTimezone` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `maximumBytesBilled` number, double
        - `location` string
        - `retries` number, double
        - `requireUserCredentials` boolean
        - `keyfileContents` object, required
        - `authenticationType` 'sso' | 'private_key' | 'adc'
        - `priority` 'interactive' | 'batch'
        - `timeoutSeconds` number, double
        - `threads` number, double
        - `dataset` string, required
        - `project` string, required
        - `type` 'bigquery', required
      - CreatePostgresCredentials
        - `sshTunnelPrivateKey` string
        - `sshTunnelPublicKey` string
        - `sshTunnelUser` string
        - `sshTunnelPort` number, double
        - `sshTunnelHost` string
        - `useSshTunnel` boolean
        - `sslrootcert` string, nullable
        - `sslrootcertFileName` string
        - `sslkey` string, nullable
        - `sslkeyFileName` string
        - `sslcert` string, nullable
        - `sslcertFileName` string
        - `sslmode` string
        - `timeoutSeconds` number, double
        - `dataTimezone` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `role` string
        - `searchPath` string
        - `keepalivesIdle` number, double
        - `threads` number, double
        - `schema` string, required
        - `dbname` string, required
        - `port` number, double, required
        - `requireUserCredentials` boolean
        - `password` string, required
        - `user` string, required
        - `host` string, required
        - `type` 'postgres', required
      - CreateSnowflakeCredentials
        - `organizationWarehouseCredentialsUuid` string
        - `override` boolean
        - `timeoutSeconds` number, double
        - `disableTimestampConversion` boolean
        - `quotedIdentifiersIgnoreCase` boolean
        - `dataTimezone` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `accessUrl` string
        - `queryTag` string
        - `clientSessionKeepAlive` boolean
        - `threads` number, double
        - `schema` string, required
        - `warehouse` string, required
        - `database` string, required
        - `role` string
        - `token` string
        - `refreshToken` string
        - `authenticationType` 'password' | 'private_key' | 'sso' | 'external_browser' | 'oauth_authorization_code' | 'none'
        - `privateKeyPass` string
        - `privateKey` string
        - `requireUserCredentials` boolean
        - `password` string
        - `user` string, required
        - `account` string, required
        - `type` 'snowflake', required
      - CreateDatabricksCredentials
        - `compute` object[]
          - `httpPath` string, required
          - `name` string, required
        - `dataTimezone` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `requireUserCredentials` boolean
        - `oauthClientSecret` string
        - `oauthClientId` string
        - `token` string
        - `refreshToken` string
        - `personalAccessToken` string
        - `authenticationType` 'personal_access_token' | 'oauth_m2m' | 'oauth_u2m'
        - `httpPath` string, required
        - `serverHostName` string, required
        - `database` string, required
        - `catalog` string
        - `type` 'databricks', required
      - CreateTrinoCredentials
        - `dataTimezone` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `source` string
        - `http_scheme` string, required
        - `schema` string, required
        - `dbname` string, required
        - `port` number, double, required
        - `requireUserCredentials` boolean
        - `password` string, required
        - `user` string, required
        - `host` string, required
        - `type` 'trino', required
      - CreateClickhouseCredentials
        - `timeoutSeconds` number, double
        - `dataTimezone` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `secure` boolean
        - `schema` string, required
        - `port` number, double, required
        - `requireUserCredentials` boolean
        - `password` string, required
        - `user` string, required
        - `host` string, required
        - `type` 'clickhouse', required
      - CreateAthenaCredentials
        - `dataTimezone` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `requireUserCredentials` boolean
        - `numRetries` number, double
        - `threads` number, double
        - `workGroup` string
        - `assumeRoleExternalId` string
        - `assumeRoleArn` string
        - `sessionToken` string
        - `secretAccessKey` string
        - `accessKeyId` string
        - `authenticationType` 'access_key' | 'iam_role'
        - `s3DataDir` string
        - `s3StagingDir` string, required
        - `schema` string, required
        - `database` string, required
        - `region` string, required
        - `type` 'athena', required
      - union
        - CreateDuckdbMotherduckCredentials
          - `dataTimezone` string
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `requireUserCredentials` boolean
          - `threads` number, double
          - `token` string, required
          - `schema` string, required
          - `database` string, required
          - `connectionType` 'motherduck', required
          - `type` 'duckdb', required
        - CreateDuckdbDucklakeCredentials
          - `dataTimezone` string
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `requireUserCredentials` boolean
          - `threads` number, double
          - `catalogAlias` string
          - `schema` string, required
          - `dataPath` union, required
            - CreateDucklakeDataPathS3
              - …
            - CreateDucklakeDataPathGcs
              - …
            - CreateDucklakeDataPathAzure
              - …
            - CreateDucklakeDataPathLocal
              - …
          - `catalog` union, required
            - CreateDucklakeCatalogPostgres
              - …
            - CreateDucklakeCatalogSqlite
              - …
            - CreateDucklakeCatalogDuckdb
              - …
          - `connectionType` 'ducklake', required
          - `type` 'duckdb', required
        - CreateDuckdbEmbeddedCredentials
          - `schema` string
          - `startOfWeek` number, double
          - `dataTimezone` string
          - `requireUserCredentials` boolean
          - `dataset` string, required
          - `connectionType` 'embedded', required
          - `type` 'duckdb', required
    - `mode` 'create', required
  - object
    - `dataTimezone` string, nullable, required
    - `warehouseType` 'bigquery' | 'postgres' | 'redshift' | 'snowflake' | 'databricks' | 'trino' | 'clickhouse' | 'athena' | 'duckdb', required
    - `projectUuid` string, required
    - `mode` 'edit', required

## Response `200`

Success

- ApiDataTimezonePreview
  - `results` ApiDataTimezonePreviewResults, required
    - `aware` DataTimezonePreviewAware, required
      - `rendered` string, required
      - `raw` string, required
    - `naive` DataTimezonePreviewNaive, required
      - `rendered` string, required
      - `readAs` string, required
      - `raw` string, required
      - `interpretedAs` string, required
    - `dataTimezoneApplies` boolean, required
    - `projectTimezone` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)