# Lightdash

## Docs

- [Acquire tree lock](https://docs.lightdash.com/api-reference/catalog/acquire-tree-lock.md): Acquire an edit lock on a metrics tree
- [Add category to catalog item](https://docs.lightdash.com/api-reference/catalog/add-category-to-catalog-item.md): Add a category to a catalog item
- [Check if metrics exist in catalog](https://docs.lightdash.com/api-reference/catalog/check-if-metrics-exist-in-catalog.md): Check if there are any metrics in catalog
- [Create metrics tree](https://docs.lightdash.com/api-reference/catalog/create-metrics-tree.md): Create a new saved metrics tree with nodes and edges
- [Create metrics tree edge](https://docs.lightdash.com/api-reference/catalog/create-metrics-tree-edge.md): Create an edge in the metrics tree
- [Delete metrics tree](https://docs.lightdash.com/api-reference/catalog/delete-metrics-tree.md): Delete a saved metrics tree and its associated nodes
- [Delete metrics tree edge](https://docs.lightdash.com/api-reference/catalog/delete-metrics-tree-edge.md): Delete an edge from the metrics tree
- [Get all metrics tree edges](https://docs.lightdash.com/api-reference/catalog/get-all-metrics-tree-edges.md): Get all edges in the metrics tree for a project
- [Get catalog](https://docs.lightdash.com/api-reference/catalog/get-catalog.md): Get catalog items
- [Get field analytics](https://docs.lightdash.com/api-reference/catalog/get-field-analytics.md): Get catalog analytics for fields
- [Get filter dimensions](https://docs.lightdash.com/api-reference/catalog/get-filter-dimensions.md): Get dimensions that can be used to filter metrics
- [Get metric](https://docs.lightdash.com/api-reference/catalog/get-metric.md): Get metric by table and metric name
- [Get metrics tree](https://docs.lightdash.com/api-reference/catalog/get-metrics-tree.md): Get the metrics tree structure (deprecated, use POST instead)
- [Get metrics tree](https://docs.lightdash.com/api-reference/catalog/get-metrics-tree-1.md): Get the metrics tree structure
- [Get metrics tree details](https://docs.lightdash.com/api-reference/catalog/get-metrics-tree-details.md): Get details of a saved metrics tree including nodes and edges
- [Get metrics with time dimensions](https://docs.lightdash.com/api-reference/catalog/get-metrics-with-time-dimensions.md): Get metrics with time dimensions
- [Get segment dimensions](https://docs.lightdash.com/api-reference/catalog/get-segment-dimensions.md): Get dimensions that can be used to segment metrics
- [Get table analytics](https://docs.lightdash.com/api-reference/catalog/get-table-analytics.md): Get catalog analytics for tables
- [Get table metadata](https://docs.lightdash.com/api-reference/catalog/get-table-metadata.md): Get catalog metadata for tables
- [List metric owners](https://docs.lightdash.com/api-reference/catalog/list-metric-owners.md): Get distinct metric owners for filter dropdown
- [List metrics in catalog](https://docs.lightdash.com/api-reference/catalog/list-metrics-in-catalog.md): Get metrics catalog
- [List metrics trees](https://docs.lightdash.com/api-reference/catalog/list-metrics-trees.md): List saved metrics trees for a project
- [Refresh tree lock heartbeat](https://docs.lightdash.com/api-reference/catalog/refresh-tree-lock-heartbeat.md): Refresh the heartbeat on an edit lock to keep it alive
- [Release tree lock](https://docs.lightdash.com/api-reference/catalog/release-tree-lock.md): Release an edit lock on a metrics tree
- [Remove category from catalog item](https://docs.lightdash.com/api-reference/catalog/remove-category-from-catalog-item.md): Remove a category from a catalog item
- [Update catalog item icon](https://docs.lightdash.com/api-reference/catalog/update-catalog-item-icon.md): Update the icon for a catalog item
- [Update metrics tree](https://docs.lightdash.com/api-reference/catalog/update-metrics-tree.md): Update a saved metrics tree including nodes and edges
- [Get change](https://docs.lightdash.com/api-reference/changesets/get-change.md): Get a specific change by UUID
- [List changesets](https://docs.lightdash.com/api-reference/changesets/list-changesets.md): Get active changeset for a project
- [Revert all changes](https://docs.lightdash.com/api-reference/changesets/revert-all-changes.md): Revert all changes in the active changeset
- [Revert change](https://docs.lightdash.com/api-reference/changesets/revert-change.md): Revert a specific change
- [Calculate total from saved chart](https://docs.lightdash.com/api-reference/charts/calculate-total-from-saved-chart.md): Calculate metric totals from a saved chart
- [Create saved chart scheduler](https://docs.lightdash.com/api-reference/charts/create-saved-chart-scheduler.md): Create a scheduler for a saved chart
- [Export chart image](https://docs.lightdash.com/api-reference/charts/export-chart-image.md): Export a saved chart as a PNG image
- [Get chart and results](https://docs.lightdash.com/api-reference/charts/get-chart-and-results.md): Get chart and run query with dashboard filters
- [Get chart promotion diff](https://docs.lightdash.com/api-reference/charts/get-chart-promotion-diff.md): Get diff from chart to promote
- [Get chart version](https://docs.lightdash.com/api-reference/charts/get-chart-version.md): Get chart version
- [Get chart version history](https://docs.lightdash.com/api-reference/charts/get-chart-version-history.md): Get chart version history from last 30 days
- [Get chart version results](https://docs.lightdash.com/api-reference/charts/get-chart-version-results.md): Run a query for a chart version
- [List saved chart schedulers](https://docs.lightdash.com/api-reference/charts/list-saved-chart-schedulers.md): Get schedulers for a saved chart
- [Promote chart](https://docs.lightdash.com/api-reference/charts/promote-chart.md): Promote chart to its upstream project
- [Rollback chart to version](https://docs.lightdash.com/api-reference/charts/rollback-chart-to-version.md): Rollback chart to version
- [Run chart query](https://docs.lightdash.com/api-reference/charts/run-chart-query.md): Run a query for a chart
- [Unverify chart](https://docs.lightdash.com/api-reference/charts/unverify-chart.md): Remove verification from a chart
- [Verify chart](https://docs.lightdash.com/api-reference/charts/verify-chart.md): Verify a chart
- [Create comment](https://docs.lightdash.com/api-reference/comments/create-comment.md): Creates a comment on a dashboard tile
- [Delete comment](https://docs.lightdash.com/api-reference/comments/delete-comment.md): Deletes a comment on a dashboard
- [Get comments](https://docs.lightdash.com/api-reference/comments/get-comments.md): Gets all comments for a dashboard
- [Resolve comment](https://docs.lightdash.com/api-reference/comments/resolve-comment.md): Resolves a comment on a dashboard
- [Bulk move content](https://docs.lightdash.com/api-reference/content/bulk-move-content.md): Move multiple items (Charts, Dashboards, Spaces) to another space
- [Get favorites](https://docs.lightdash.com/api-reference/content/get-favorites.md): Get the current user's favorite items in a project
- [Get pinned items](https://docs.lightdash.com/api-reference/content/get-pinned-items.md): Get pinned items
- [Move content](https://docs.lightdash.com/api-reference/content/move-content.md): Move a single item (Chart, Dashboard, Space) to another space
- [Toggle favorite](https://docs.lightdash.com/api-reference/content/toggle-favorite.md): Toggle a favorite item for the current user
- [Update pinned items order](https://docs.lightdash.com/api-reference/content/update-pinned-items-order.md): Update pinned items order
- [Create GitHub repository](https://docs.lightdash.com/api-reference/create-github-repository.md): Create a new GitHub repository via the installed app
- [Create dashboard scheduler](https://docs.lightdash.com/api-reference/dashboards/create-dashboard-scheduler.md): Create a scheduler for a dashboard
- [Get dashboard history](https://docs.lightdash.com/api-reference/dashboards/get-dashboard-history.md): Get dashboard version history
- [Get dashboard promotion diff](https://docs.lightdash.com/api-reference/dashboards/get-dashboard-promotion-diff.md): Get diff from dashboard to promote
- [Get dashboard version](https://docs.lightdash.com/api-reference/dashboards/get-dashboard-version.md): Get specific dashboard version
- [List dashboard schedulers](https://docs.lightdash.com/api-reference/dashboards/list-dashboard-schedulers.md): Get schedulers for a dashboard
- [Promote dashboard](https://docs.lightdash.com/api-reference/dashboards/promote-dashboard.md): Promote dashboard to its upstream project
- [Rollback dashboard version](https://docs.lightdash.com/api-reference/dashboards/rollback-dashboard-version.md): Rollback dashboard to a previous version
- [Unverify dashboard](https://docs.lightdash.com/api-reference/dashboards/unverify-dashboard.md): Remove verification from a dashboard
- [Verify dashboard](https://docs.lightdash.com/api-reference/dashboards/verify-dashboard.md): Verify a dashboard
- [Run metric query](https://docs.lightdash.com/api-reference/exploring/run-metric-query.md): Run a query for explore
- [Run SQL query](https://docs.lightdash.com/api-reference/exploring/run-sql-query.md): Run a raw sql query against the project's warehouse connection
- [Run underlying data query](https://docs.lightdash.com/api-reference/exploring/run-underlying-data-query.md): Run a query for underlying data results
- [Get export status](https://docs.lightdash.com/api-reference/exports/get-export-status.md): Get the status/URL of a Google Sheets export job
- [Get file](https://docs.lightdash.com/api-reference/files/get-file.md): Get a persistent file download. Streams the file body through the backend so self-hosted deployments don't need to expose their internal S3-compatible storage endpoint to browsers.
- [Get event names](https://docs.lightdash.com/api-reference/funnel/get-event-names.md): Get distinct event names from a dimension for funnel step selection. Scans the last 30 days of data to limit query cost.
- [Run funnel query](https://docs.lightdash.com/api-reference/funnel/run-funnel-query.md): Execute a funnel analysis query and return conversion metrics
- [Get AI settings](https://docs.lightdash.com/api-reference/get-ai-settings.md): Get AI organization settings
- [Get GitHub App configuration](https://docs.lightdash.com/api-reference/get-github-app-configuration.md): Get GitHub App configuration for the organization
- [Create branch](https://docs.lightdash.com/api-reference/git-files/create-branch.md): Create a new branch from a source branch
- [Create pull request](https://docs.lightdash.com/api-reference/git-files/create-pull-request.md): Create a pull request from a branch to the default branch
- [Delete file](https://docs.lightdash.com/api-reference/git-files/delete-file.md): Delete a file from the repository
- [Get file or directory](https://docs.lightdash.com/api-reference/git-files/get-file-or-directory.md): Get file content or directory listing. Returns directory entries if path is a directory, file content if path is a file.
- [List branches](https://docs.lightdash.com/api-reference/git-files/list-branches.md): List branches for the connected repository
- [Save file](https://docs.lightdash.com/api-reference/git-files/save-file.md): Create or update a file. Provide sha to update existing file, omit for new file.
- [Create file PR](https://docs.lightdash.com/api-reference/git-integration/create-file-pr.md): Create a pull request with arbitrary file changes
- [Create PR for custom dimensions](https://docs.lightdash.com/api-reference/git-integration/create-pr-for-custom-dimensions.md): Create a pull request for custom dimensions
- [Create PR for custom metrics](https://docs.lightdash.com/api-reference/git-integration/create-pr-for-custom-metrics.md): Create a pull request for custom metrics
- [Get explore file](https://docs.lightdash.com/api-reference/git-integration/get-explore-file.md): Get the YAML file for an explore's base table
- [Get explore file path](https://docs.lightdash.com/api-reference/git-integration/get-explore-file-path.md): Get the file path for an explore's YAML file (without fetching content)
- [GitHub OAuth callback](https://docs.lightdash.com/api-reference/github-oauth-callback.md): Callback URL for GitHub App Authorization also used for GitHub App Installation with combined Authorization
- [GitLab OAuth callback](https://docs.lightdash.com/api-reference/gitlab-oauth-callback.md): GitLab OAuth callback handler
- [Start impersonation](https://docs.lightdash.com/api-reference/impersonation/start-impersonation.md): Start impersonating a user
- [Stop impersonation](https://docs.lightdash.com/api-reference/impersonation/stop-impersonation.md): Stop impersonating a user
- [Install GitHub App](https://docs.lightdash.com/api-reference/install-github-app.md): Install the Lightdash GitHub App and link to an organization
- [Install GitLab integration](https://docs.lightdash.com/api-reference/install-gitlab-integration.md): Initiate GitLab OAuth integration
- [Check Slack OpenID link status](https://docs.lightdash.com/api-reference/integrations/check-slack-openid-link-status.md): Check if the user has an OpenID identity for Slack
- [Delete Slack installation](https://docs.lightdash.com/api-reference/integrations/delete-slack-installation.md): Delete the Slack installation for the organization
- [Get Google Drive access token](https://docs.lightdash.com/api-reference/integrations/get-google-drive-access-token.md): Get access token for google drive
- [Get Slack channels](https://docs.lightdash.com/api-reference/integrations/get-slack-channels.md): Get slack channels
- [Get Slack image](https://docs.lightdash.com/api-reference/integrations/get-slack-image.md): Get a Slack image by nanoId
- [Get Slack installation](https://docs.lightdash.com/api-reference/integrations/get-slack-installation.md): Get Slack installation details for the organization
- [Get Slack preview](https://docs.lightdash.com/api-reference/integrations/get-slack-preview.md): Get a Slack unfurl preview image via redirect to a fresh signed URL. Falls back to a placeholder image if the preview is not found.
- [Install Slack](https://docs.lightdash.com/api-reference/integrations/install-slack.md): Start the Slack installation flow
- [Lookup channel](https://docs.lightdash.com/api-reference/integrations/lookup-channel.md): Look up a single Slack channel by ID. Used for on-demand fetching when user pastes a channel ID not in the cache.
- [Update Slack custom settings](https://docs.lightdash.com/api-reference/integrations/update-slack-custom-settings.md): Update slack notification channel to send notifications to scheduled jobs fail
- [Upload to Google Sheet](https://docs.lightdash.com/api-reference/integrations/upload-to-google-sheet.md): Upload results from query to Google Sheet
- [List AI agent threads](https://docs.lightdash.com/api-reference/list-ai-agent-threads.md): Get all AI agent threads for admin
- [List AI agents](https://docs.lightdash.com/api-reference/list-ai-agents.md): Get all AI agents for admin
- [List GitHub repositories](https://docs.lightdash.com/api-reference/list-github-repositories.md): List GitHub repositories accessible via the installed app
- [List GitLab projects](https://docs.lightdash.com/api-reference/list-gitlab-projects.md): List GitLab projects accessible via the integration
- [Proxy GeoJSON](https://docs.lightdash.com/api-reference/map/proxy-geojson.md): Proxies external GeoJSON files to bypass CORS restrictions
- [Compile metric total query](https://docs.lightdash.com/api-reference/metrics-explorer/compile-metric-total-query.md): Compile the metric total query SQL
- [Run metric total query](https://docs.lightdash.com/api-reference/metrics-explorer/run-metric-total-query.md): Run a metric total query with comparison
- [Create email one-time passcode](https://docs.lightdash.com/api-reference/my-account/create-email-one-time-passcode.md): Create a new one-time passcode for the current user's primary email. The user will receive an email with the passcode.
- [Create personal access token](https://docs.lightdash.com/api-reference/my-account/create-personal-access-token.md): Create personal access token
- [Create warehouse credentials](https://docs.lightdash.com/api-reference/my-account/create-warehouse-credentials.md): Create user warehouse credentials
- [Delete personal access token](https://docs.lightdash.com/api-reference/my-account/delete-personal-access-token.md): Delete personal access token
- [Delete user](https://docs.lightdash.com/api-reference/my-account/delete-user.md): Delete user
- [Delete warehouse credentials](https://docs.lightdash.com/api-reference/my-account/delete-warehouse-credentials.md): Delete user warehouse credentials
- [Get account](https://docs.lightdash.com/api-reference/my-account/get-account.md): Get account information
- [Get authenticated user](https://docs.lightdash.com/api-reference/my-account/get-authenticated-user.md): Get authenticated user
- [Get email verification status](https://docs.lightdash.com/api-reference/my-account/get-email-verification-status.md): Get the verification status for the current user's primary email
- [Get login options](https://docs.lightdash.com/api-reference/my-account/get-login-options.md): Get login options
- [Join organization](https://docs.lightdash.com/api-reference/my-account/join-organization.md): Add the current user to an organization that accepts users with a verified email domain. This will fail if the organization email domain does not match the user's primary email domain.
- [List available organizations](https://docs.lightdash.com/api-reference/my-account/list-available-organizations.md): List the organizations that the current user can join. This is based on the user's primary email domain and the organization's allowed email domains.
- [List personal access tokens](https://docs.lightdash.com/api-reference/my-account/list-personal-access-tokens.md): List personal access tokens
- [List warehouse credentials](https://docs.lightdash.com/api-reference/my-account/list-warehouse-credentials.md): Get user warehouse credentials
- [Register user](https://docs.lightdash.com/api-reference/my-account/register-user.md): Register user
- [Rotate personal access token](https://docs.lightdash.com/api-reference/my-account/rotate-personal-access-token.md): Rotate personal access token
- [Update warehouse credentials](https://docs.lightdash.com/api-reference/my-account/update-warehouse-credentials.md): Update user warehouse credentials
- [Get notifications](https://docs.lightdash.com/api-reference/notifications/get-notifications.md): Gets notifications for a user based on the type
- [Update notification](https://docs.lightdash.com/api-reference/notifications/update-notification.md): Update notification
- [Create warehouse credentials](https://docs.lightdash.com/api-reference/organization-warehouse-credentials/create-warehouse-credentials.md): Create new warehouse credentials for the organization
- [Delete warehouse credentials](https://docs.lightdash.com/api-reference/organization-warehouse-credentials/delete-warehouse-credentials.md): Delete warehouse credentials
- [Get warehouse credential](https://docs.lightdash.com/api-reference/organization-warehouse-credentials/get-warehouse-credential.md): Get a specific warehouse credential by UUID
- [List warehouse credentials](https://docs.lightdash.com/api-reference/organization-warehouse-credentials/list-warehouse-credentials.md): Get all warehouse credentials for the current organization
- [Update warehouse credentials](https://docs.lightdash.com/api-reference/organization-warehouse-credentials/update-warehouse-credentials.md): Update existing warehouse credentials
- [Create color palette](https://docs.lightdash.com/api-reference/organizations/create-color-palette.md): Create a new color palette
- [Create group](https://docs.lightdash.com/api-reference/organizations/create-group.md): Creates a new group in the current user's organization
- [Create organization](https://docs.lightdash.com/api-reference/organizations/create-organization.md): Creates a new organization, the current user becomes the Admin of the new organization. This is only available to users that are not already in an organization.
- [Create project](https://docs.lightdash.com/api-reference/organizations/create-project.md): Create a new project in the organization
- [Delete color palette](https://docs.lightdash.com/api-reference/organizations/delete-color-palette.md): Delete a color palette
- [Delete organization](https://docs.lightdash.com/api-reference/organizations/delete-organization.md): Deletes an organization and all users inside that organization
- [Delete organization member](https://docs.lightdash.com/api-reference/organizations/delete-organization-member.md): Deletes a user from the current user's organization
- [Get current organization](https://docs.lightdash.com/api-reference/organizations/get-current-organization.md): Get the current user's organization
- [Get impersonation settings](https://docs.lightdash.com/api-reference/organizations/get-impersonation-settings.md): Get the impersonation setting for the current organization
- [Get organization member by email](https://docs.lightdash.com/api-reference/organizations/get-organization-member-by-email.md): Get the member profile for a user in the current user's organization by email
- [Get organization member by UUID](https://docs.lightdash.com/api-reference/organizations/get-organization-member-by-uuid.md): Get the member profile for a user in the current user's organization by uuid
- [Get user schedulers](https://docs.lightdash.com/api-reference/organizations/get-user-schedulers.md): Gets a summary of scheduled deliveries owned by a user across all projects
- [List allowed email domains](https://docs.lightdash.com/api-reference/organizations/list-allowed-email-domains.md): Gets the allowed email domains for the current user's organization
- [List color palettes](https://docs.lightdash.com/api-reference/organizations/list-color-palettes.md): List all color palettes in the organization
- [List organization groups](https://docs.lightdash.com/api-reference/organizations/list-organization-groups.md): Gets all the groups in the current user's organization
- [List organization members](https://docs.lightdash.com/api-reference/organizations/list-organization-members.md): Gets all the members of the current user's organization
- [List organization projects](https://docs.lightdash.com/api-reference/organizations/list-organization-projects.md): Gets all projects of the current user's organization
- [Reassign schedulers](https://docs.lightdash.com/api-reference/organizations/reassign-schedulers.md): Reassigns all scheduled deliveries from one user to another
- [Set active color palette](https://docs.lightdash.com/api-reference/organizations/set-active-color-palette.md): Set a color palette as the active palette
- [Update allowed email domains](https://docs.lightdash.com/api-reference/organizations/update-allowed-email-domains.md): Updates the allowed email domains for the current user's organization
- [Update color palette](https://docs.lightdash.com/api-reference/organizations/update-color-palette.md): Update a color palette
- [Update current organization](https://docs.lightdash.com/api-reference/organizations/update-current-organization.md): Update the current user's organization
- [Update impersonation settings](https://docs.lightdash.com/api-reference/organizations/update-impersonation-settings.md): Update the impersonation setting for the current organization
- [Add deploy batch](https://docs.lightdash.com/api-reference/project/add-deploy-batch.md): Add a batch of explores to an existing deploy session
- [Finalize deploy](https://docs.lightdash.com/api-reference/project/finalize-deploy.md): Finalize a deploy session and commit all staged explores to the project
- [Start deploy session](https://docs.lightdash.com/api-reference/project/start-deploy-session.md): Start a new deploy session for batched explore uploads
- [Calculate subtotals from query](https://docs.lightdash.com/api-reference/projects/calculate-subtotals-from-query.md): Calculate subtotals from a metricQuery
- [Calculate total from query](https://docs.lightdash.com/api-reference/projects/calculate-total-from-query.md): Calculate all metric totals from a metricQuery
- [Check BigQuery authentication](https://docs.lightdash.com/api-reference/projects/check-bigquery-authentication.md): Check if user is authenticated with BigQuery
- [Check Databricks OAuth authentication](https://docs.lightdash.com/api-reference/projects/check-databricks-oauth-authentication.md): Check if user is authenticated with Databricks OAuth
- [Check pre-aggregate](https://docs.lightdash.com/api-reference/projects/check-pre-aggregate.md): Check pre-aggregate availability for a metric query
- [Check Snowflake SSO authentication](https://docs.lightdash.com/api-reference/projects/check-snowflake-sso-authentication.md): Check if the user is authenticated with Snowflake SSO
- [Compile query](https://docs.lightdash.com/api-reference/projects/compile-query.md): Compile a metric query for an explore
- [Create dashboard](https://docs.lightdash.com/api-reference/projects/create-dashboard.md): Create a new dashboard in a project
- [Create dashboard with charts](https://docs.lightdash.com/api-reference/projects/create-dashboard-with-charts.md): Create a new dashboard with embedded charts
- [Create project preview](https://docs.lightdash.com/api-reference/projects/create-project-preview.md): Create a preview project
- [Create tag](https://docs.lightdash.com/api-reference/projects/create-tag.md): Create a new tag in a project
- [Delete tag](https://docs.lightdash.com/api-reference/projects/delete-tag.md): Delete a tag from a project
- [Dismiss validation error](https://docs.lightdash.com/api-reference/projects/dismiss-validation-error.md): Deletes a single validation error.
- [Download user activity CSV](https://docs.lightdash.com/api-reference/projects/download-user-activity-csv.md): Download user activity as CSV
- [Get BigQuery datasets](https://docs.lightdash.com/api-reference/projects/get-bigquery-datasets.md): Get BigQuery datasets for a project
- [Get BigQuery projects](https://docs.lightdash.com/api-reference/projects/get-bigquery-projects.md): Get BigQuery projects accessible by the user
- [Get chart fields for rename](https://docs.lightdash.com/api-reference/projects/get-chart-fields-for-rename.md): Get a list of fields for this chart's explore to be used when renaming a chart in the UI
- [Get compilation log for a specific job](https://docs.lightdash.com/api-reference/projects/get-compilation-log-for-a-specific-job.md): Get compilation log by job UUID
- [Get dashboard fields for rename](https://docs.lightdash.com/api-reference/projects/get-dashboard-fields-for-rename.md): Get a list of fields from explores referenced by the dashboard's filters
- [Get explore](https://docs.lightdash.com/api-reference/projects/get-explore.md): Get a specific explore
- [Get project](https://docs.lightdash.com/api-reference/projects/get-project.md): Get a project of an organiztion
- [Get project compilation logs](https://docs.lightdash.com/api-reference/projects/get-project-compilation-logs.md): Get compilation logs for a project
- [Get SQL charts as code](https://docs.lightdash.com/api-reference/projects/get-sql-charts-as-code.md): Gets SQL charts in code representation
- [Get user activity](https://docs.lightdash.com/api-reference/projects/get-user-activity.md): Get user activity for a project
- [Get user warehouse credentials preference](https://docs.lightdash.com/api-reference/projects/get-user-warehouse-credentials-preference.md): Get the user's warehouse credentials preference for a project
- [Get validation results](https://docs.lightdash.com/api-reference/projects/get-validation-results.md): Get validation results for a project. This will return the results of the latest validation job.
- [Handle dbt Cloud webhook](https://docs.lightdash.com/api-reference/projects/handle-dbt-cloud-webhook.md): Handle dbt Cloud webhook for job completion
- [List chart summaries in project](https://docs.lightdash.com/api-reference/projects/list-chart-summaries-in-project.md): List all charts summaries in a project
- [List charts as code](https://docs.lightdash.com/api-reference/projects/list-charts-as-code.md): Get charts in code representation
- [List charts in project](https://docs.lightdash.com/api-reference/projects/list-charts-in-project.md): List all charts in a project
- [List custom metrics](https://docs.lightdash.com/api-reference/projects/list-custom-metrics.md): Get all custom metrics in a project
- [List dashboards](https://docs.lightdash.com/api-reference/projects/list-dashboards.md): Get all dashboards in a project
- [List dashboards as code](https://docs.lightdash.com/api-reference/projects/list-dashboards-as-code.md): Get dashboards in code representation
- [List explores](https://docs.lightdash.com/api-reference/projects/list-explores.md): Get all explores for a project
- [List project group accesses](https://docs.lightdash.com/api-reference/projects/list-project-group-accesses.md): List group access for projects
- [List project user warehouse credentials](https://docs.lightdash.com/api-reference/projects/list-project-user-warehouse-credentials.md): Get user warehouse credentials available for a project
- [List spaces in project](https://docs.lightdash.com/api-reference/projects/list-spaces-in-project.md): List all spaces in a project
- [List tags](https://docs.lightdash.com/api-reference/projects/list-tags.md): Get all tags in a project
- [List verified content](https://docs.lightdash.com/api-reference/projects/list-verified-content.md): List all verified content (charts and dashboards) in a project
- [Preview rename](https://docs.lightdash.com/api-reference/projects/preview-rename.md): Preview which resources would be affected by a bulk rename
- [Refresh pre-aggregate by definition name](https://docs.lightdash.com/api-reference/projects/refresh-pre-aggregate-by-definition-name.md): Refresh a single pre-aggregate by its definition name
- [Refresh project](https://docs.lightdash.com/api-reference/projects/refresh-project.md): Refresh a project by recompiling dbt
- [Refresh project pre-aggregates](https://docs.lightdash.com/api-reference/projects/refresh-project-pre-aggregates.md): Refresh all pre-aggregates in a project
- [Rename chart](https://docs.lightdash.com/api-reference/projects/rename-chart.md): Rename a chart and its fields
- [Rename dashboard filter](https://docs.lightdash.com/api-reference/projects/rename-dashboard-filter.md): Rename a dashboard filter's field or model reference
- [Rename resources](https://docs.lightdash.com/api-reference/projects/rename-resources.md): Rename resources in a project
- [Replace YAML tags](https://docs.lightdash.com/api-reference/projects/replace-yaml-tags.md): Replace all YAML-defined tags in a project
- [Set explores](https://docs.lightdash.com/api-reference/projects/set-explores.md): Set explores for a project
- [Update dashboards](https://docs.lightdash.com/api-reference/projects/update-dashboards.md): Update multiple dashboards
- [Update default user spaces setting](https://docs.lightdash.com/api-reference/projects/update-default-user-spaces-setting.md): Toggle default user spaces for a project. When enabled, creates personal spaces for all eligible users.
- [Update project metadata](https://docs.lightdash.com/api-reference/projects/update-project-metadata.md): Update project metadata like upstreamProjectUuid we don't trigger a compile, so not for updating warehouse or credentials
- [Update query timezone settings](https://docs.lightdash.com/api-reference/projects/update-query-timezone-settings.md): Update query timezone settings for a project
- [Update scheduler settings](https://docs.lightdash.com/api-reference/projects/update-scheduler-settings.md): Update scheduler settings for a project
- [Update tag](https://docs.lightdash.com/api-reference/projects/update-tag.md): Update a tag in a project
- [Update user warehouse credentials preference](https://docs.lightdash.com/api-reference/projects/update-user-warehouse-credentials-preference.md): Update the user's warehouse credentials preference for a project
- [Upsert chart as code](https://docs.lightdash.com/api-reference/projects/upsert-chart-as-code.md): Upsert a chart from code representation
- [Upsert dashboard as code](https://docs.lightdash.com/api-reference/projects/upsert-dashboard-as-code.md): Upsert a dashboard from code representation
- [Upsert SQL chart as code](https://docs.lightdash.com/api-reference/projects/upsert-sql-chart-as-code.md): Upserts an SQL chart from code representation
- [Validate formula](https://docs.lightdash.com/api-reference/projects/validate-formula.md): Validate a spreadsheet formula against the explore's fields
- [Validate project](https://docs.lightdash.com/api-reference/projects/validate-project.md): Validate content inside a project. This will start a validation job and return the job id.
- [Validate specific chart](https://docs.lightdash.com/api-reference/projects/validate-specific-chart.md): Validates a specific chart and updates validation entries in database.
- [Validate specific dashboard](https://docs.lightdash.com/api-reference/projects/validate-specific-dashboard.md): Validates a specific dashboard and updates validation entries in database.
- [Create space](https://docs.lightdash.com/api-reference/roles-&-permissions/create-space.md): Create a new space inside a project
- [Get project member access

NOTE:
We don't use the API on the frontend. Instead, we can call the API
so that we make sure of the user's access to the project.](https://docs.lightdash.com/api-reference/roles-&-permissions/get-project-member-accessnote:we-dont-use-the-api-on-the-frontend-instead-we-can-call-the-apiso-that-we-make-sure-of-the-users-access-to-the-project.md): Get a project explicit member's access. There may be users that have access to the project via their organization membership.
- [Grant group access to space](https://docs.lightdash.com/api-reference/roles-&-permissions/grant-group-access-to-space.md): Grant a group access to a space
- [Grant project access to user](https://docs.lightdash.com/api-reference/roles-&-permissions/grant-project-access-to-user.md): Grant a user access to a project
- [Grant user access to space](https://docs.lightdash.com/api-reference/roles-&-permissions/grant-user-access-to-space.md): Grant a user access to a space
- [List project access](https://docs.lightdash.com/api-reference/roles-&-permissions/list-project-access.md): Get access list for a project. This is a list of users that have been explictly granted access to the project. There may be other users that have access to the project via their organization membership.
- [Revoke group access to space](https://docs.lightdash.com/api-reference/roles-&-permissions/revoke-group-access-to-space.md): Remove a group's access to a space
- [Revoke project access for user](https://docs.lightdash.com/api-reference/roles-&-permissions/revoke-project-access-for-user.md): Remove a user's access to a project
- [Revoke user access to space](https://docs.lightdash.com/api-reference/roles-&-permissions/revoke-user-access-to-space.md): Remove a user's access to a space
- [Update organization member](https://docs.lightdash.com/api-reference/roles-&-permissions/update-organization-member.md): Updates the membership profile for a user in the current user's organization
- [Update project access for user](https://docs.lightdash.com/api-reference/roles-&-permissions/update-project-access-for-user.md): Update a user's access to a project
- [Update space](https://docs.lightdash.com/api-reference/roles-&-permissions/update-space.md): Update a space in a project
- [Delete scheduler](https://docs.lightdash.com/api-reference/schedulers/delete-scheduler.md): Delete a scheduler
- [Get run logs](https://docs.lightdash.com/api-reference/schedulers/get-run-logs.md): Get detailed logs for a specific scheduler run
- [Get scheduled jobs](https://docs.lightdash.com/api-reference/schedulers/get-scheduled-jobs.md): Get scheduled jobs
- [Get scheduler](https://docs.lightdash.com/api-reference/schedulers/get-scheduler.md): Get a scheduler
- [Get scheduler job status](https://docs.lightdash.com/api-reference/schedulers/get-scheduler-job-status.md): Get a generic job status This method can be used when polling from the frontend
- [Get scheduler logs](https://docs.lightdash.com/api-reference/schedulers/get-scheduler-logs.md): Get scheduled logs
- [List scheduler runs](https://docs.lightdash.com/api-reference/schedulers/list-scheduler-runs.md): Get paginated scheduler runs with aggregated child job counts
- [List schedulers](https://docs.lightdash.com/api-reference/schedulers/list-schedulers.md): List all schedulers with pagination, search, sorting, and filtering
- [List user schedulers](https://docs.lightdash.com/api-reference/schedulers/list-user-schedulers.md): List all schedulers for the current user across all projects with pagination, search, sorting, and filtering
- [Reassign scheduler owner](https://docs.lightdash.com/api-reference/schedulers/reassign-scheduler-owner.md): Reassign ownership of multiple schedulers
- [Send scheduler](https://docs.lightdash.com/api-reference/schedulers/send-scheduler.md): Send a scheduler now before saving it
- [Send scheduler by uuid](https://docs.lightdash.com/api-reference/schedulers/send-scheduler-by-uuid.md): Send an existing scheduler now by its uuid
- [Update scheduler](https://docs.lightdash.com/api-reference/schedulers/update-scheduler.md): Update a scheduler
- [Update scheduler enabled status](https://docs.lightdash.com/api-reference/schedulers/update-scheduler-enabled-status.md): Set scheduler enabled
- [Create group](https://docs.lightdash.com/api-reference/scim/create-group.md): Create a new group in the SCIM application
- [Create user](https://docs.lightdash.com/api-reference/scim/create-user.md): Create a new user
- [Delete group](https://docs.lightdash.com/api-reference/scim/delete-group.md): Delete a specific group by its SCIM ID
- [Delete user](https://docs.lightdash.com/api-reference/scim/delete-user.md): Delete a user by ID
- [Get group](https://docs.lightdash.com/api-reference/scim/get-group.md): Get a specific group by its SCIM ID
- [Get resource type](https://docs.lightdash.com/api-reference/scim/get-resource-type.md): Get individual SCIM resource type
- [Get role](https://docs.lightdash.com/api-reference/scim/get-role.md): Get a SCIM role by ID
- [Get schema](https://docs.lightdash.com/api-reference/scim/get-schema.md): Get individual SCIM schema
- [Get user](https://docs.lightdash.com/api-reference/scim/get-user.md): Get a SCIM user by ID
- [List groups](https://docs.lightdash.com/api-reference/scim/list-groups.md): Get a list of groups within an organization
- [List resource types](https://docs.lightdash.com/api-reference/scim/list-resource-types.md): Get SCIM resource types
- [List roles](https://docs.lightdash.com/api-reference/scim/list-roles.md): Get a list of roles within an organization
- [List schemas](https://docs.lightdash.com/api-reference/scim/list-schemas.md): Get SCIM schemas
- [List users](https://docs.lightdash.com/api-reference/scim/list-users.md): List SCIM users in the organization
- [Patch group](https://docs.lightdash.com/api-reference/scim/patch-group.md): Partially updates a group’s attributes (e.g., add or remove members).
- [Patch user](https://docs.lightdash.com/api-reference/scim/patch-user.md): Patch a user by ID (SCIM PATCH)
- [Provider config](https://docs.lightdash.com/api-reference/scim/provider-config.md): Get SCIM service provider configuration
- [Replace group](https://docs.lightdash.com/api-reference/scim/replace-group.md): Update a group's attributes completely
- [Replace user](https://docs.lightdash.com/api-reference/scim/replace-user.md): Update a user by ID (SCIM PUT)
- [Root check](https://docs.lightdash.com/api-reference/scim/root-check.md): Root SCIM endpoint for validating SCIM configuration
- [Create share URL](https://docs.lightdash.com/api-reference/share-links/create-share-url.md): Given a full URL generates a short url id that can be used for sharing
- [Get share URL](https://docs.lightdash.com/api-reference/share-links/get-share-url.md): Get a share url from a short url id
- [Delete space](https://docs.lightdash.com/api-reference/spaces/delete-space.md): Delete a space from a project
- [Get delete impact](https://docs.lightdash.com/api-reference/spaces/get-delete-impact.md): Get the impact of deleting a space (affected child spaces, charts, dashboards)
- [Get space](https://docs.lightdash.com/api-reference/spaces/get-space.md): Get details for a space in a project
- [Get spotlight table config](https://docs.lightdash.com/api-reference/spotlight/get-spotlight-table-config.md): Get spotlight table configuration
- [Reset spotlight table config](https://docs.lightdash.com/api-reference/spotlight/reset-spotlight-table-config.md): Reset spotlight table configuration to defaults
- [Update spotlight table config](https://docs.lightdash.com/api-reference/spotlight/update-spotlight-table-config.md): Create or update spotlight table configuration
- [Create SQL chart](https://docs.lightdash.com/api-reference/sql-runner/create-sql-chart.md): Create sql chart
- [Create SQL chart scheduler](https://docs.lightdash.com/api-reference/sql-runner/create-sql-chart-scheduler.md): Create a scheduler for a SQL chart
- [Create virtual view](https://docs.lightdash.com/api-reference/sql-runner/create-virtual-view.md): Create a virtual-view
- [Create write back PR](https://docs.lightdash.com/api-reference/sql-runner/create-write-back-pr.md): Write back from SQL runner
- [Delete SQL chart](https://docs.lightdash.com/api-reference/sql-runner/delete-sql-chart.md): Delete sql chart
- [Delete virtual view](https://docs.lightdash.com/api-reference/sql-runner/delete-virtual-view.md): Delete a virtual-view
- [Get SQL chart](https://docs.lightdash.com/api-reference/sql-runner/get-sql-chart.md): Get saved sql chart
- [Get SQL chart by slug](https://docs.lightdash.com/api-reference/sql-runner/get-sql-chart-by-slug.md): Get saved sql chart
- [Get SQL chart promotion diff](https://docs.lightdash.com/api-reference/sql-runner/get-sql-chart-promotion-diff.md): Get diff from SQL chart to promote
- [Get SQL chart results job](https://docs.lightdash.com/api-reference/sql-runner/get-sql-chart-results-job.md): Schedules a job to get its results
- [Get SQL chart results job by UUID](https://docs.lightdash.com/api-reference/sql-runner/get-sql-chart-results-job-by-uuid.md): Schedules a job to get its results
- [Get stored results](https://docs.lightdash.com/api-reference/sql-runner/get-stored-results.md): Get results from a file stored locally
- [Get table fields](https://docs.lightdash.com/api-reference/sql-runner/get-table-fields.md): Get fields for a warehouse table
- [List SQL chart schedulers](https://docs.lightdash.com/api-reference/sql-runner/list-sql-chart-schedulers.md): Get all schedulers for a SQL chart
- [List warehouse tables](https://docs.lightdash.com/api-reference/sql-runner/list-warehouse-tables.md): Get warehouse tables for a project
- [Preview write back](https://docs.lightdash.com/api-reference/sql-runner/preview-write-back.md): Preview write back from SQL runner
- [Promote SQL chart](https://docs.lightdash.com/api-reference/sql-runner/promote-sql-chart.md): Promote SQL chart to upstream project
- [Refresh catalog cache](https://docs.lightdash.com/api-reference/sql-runner/refresh-catalog-cache.md): Refresh the catalog cache
- [Run SQL pivot query](https://docs.lightdash.com/api-reference/sql-runner/run-sql-pivot-query.md): Run a SQL pivot query
- [Run SQL query](https://docs.lightdash.com/api-reference/sql-runner/run-sql-query.md): Run a SQL query
- [Update SQL chart](https://docs.lightdash.com/api-reference/sql-runner/update-sql-chart.md): Update sql chart
- [Update virtual view](https://docs.lightdash.com/api-reference/sql-runner/update-virtual-view.md): Update a virtual view
- [Create SSH key pair](https://docs.lightdash.com/api-reference/ssh-keypairs/create-ssh-key-pair.md): Create a new SSH key pair
- [Uninstall GitHub App](https://docs.lightdash.com/api-reference/uninstall-github-app.md): Uninstall the GitHub App from the organization
- [Uninstall GitLab integration](https://docs.lightdash.com/api-reference/uninstall-gitlab-integration.md): Uninstall GitLab integration from the organization
- [Update AI settings](https://docs.lightdash.com/api-reference/update-ai-settings.md): Update AI organization settings
- [Create user attribute](https://docs.lightdash.com/api-reference/user-attributes/create-user-attribute.md): Creates new user attribute
- [Delete user attribute](https://docs.lightdash.com/api-reference/user-attributes/delete-user-attribute.md): Remove a user attribute
- [List user attributes](https://docs.lightdash.com/api-reference/user-attributes/list-user-attributes.md): Get all user attributes
- [Update user attribute](https://docs.lightdash.com/api-reference/user-attributes/update-user-attribute.md): Updates a user attribute
- [Add project access to group](https://docs.lightdash.com/api-reference/user-groups/add-project-access-to-group.md): Add project access to a group
- [Add user to group](https://docs.lightdash.com/api-reference/user-groups/add-user-to-group.md): Add a Lightdash user to a group
- [Delete group](https://docs.lightdash.com/api-reference/user-groups/delete-group.md): Delete a group
- [Get group](https://docs.lightdash.com/api-reference/user-groups/get-group.md): Get group details
- [Get group members](https://docs.lightdash.com/api-reference/user-groups/get-group-members.md): View members of a group
- [Remove project access from group](https://docs.lightdash.com/api-reference/user-groups/remove-project-access-from-group.md): Remove project access from a group
- [Remove user from group](https://docs.lightdash.com/api-reference/user-groups/remove-user-from-group.md): Remove a user from a group
- [Update group](https://docs.lightdash.com/api-reference/user-groups/update-group.md): Update a group
- [Update project access for group](https://docs.lightdash.com/api-reference/user-groups/update-project-access-for-group.md): Update project access for a group
- [Lightdash API](https://docs.lightdash.com/api-reference/v1/introduction.md)
- [Recipes](https://docs.lightdash.com/api-reference/v1/recipes.md): A collection of practical, copy-paste examples showing how to combine Lightdash API endpoints to achieve common workflows.
- [Add scopes to role](https://docs.lightdash.com/api-reference/v2/add-scopes-to-role.md): Add scopes to role
- [Assign organization role to user](https://docs.lightdash.com/api-reference/v2/assign-organization-role-to-user.md): Assign system role to user at organization level
- [Assign project role to group](https://docs.lightdash.com/api-reference/v2/assign-project-role-to-group.md): Create or update project role assignment for group (upsert)
- [Assign project role to user](https://docs.lightdash.com/api-reference/v2/assign-project-role-to-user.md): Create or update project role assignment for user (upsert)
- [Cancel query](https://docs.lightdash.com/api-reference/v2/cancel-query.md): Cancels a running async query and discards any partial results
- [Create custom role](https://docs.lightdash.com/api-reference/v2/create-custom-role.md): Create a new role in organization
- [Delete chart](https://docs.lightdash.com/api-reference/v2/delete-chart.md): Delete a saved chart by uuid or slug within a project
- [Delete custom role](https://docs.lightdash.com/api-reference/v2/delete-custom-role.md): Delete role from organization
- [Delete dashboard](https://docs.lightdash.com/api-reference/v2/delete-dashboard.md): Delete a dashboard by uuid or slug within a project
- [Download results](https://docs.lightdash.com/api-reference/v2/download-results.md): Downloads query results in various formats with custom formatting options
- [Download results](https://docs.lightdash.com/api-reference/v2/download-results-1.md): Downloads query results in various formats with custom formatting options
- [Duplicate role](https://docs.lightdash.com/api-reference/v2/duplicate-role.md): Duplicate a role
- [Execute dashboard chart](https://docs.lightdash.com/api-reference/v2/execute-dashboard-chart.md): Executes a chart within a dashboard context asynchronously with inherited dashboard filters
- [Execute dashboard SQL chart](https://docs.lightdash.com/api-reference/v2/execute-dashboard-sql-chart.md): Executes a SQL chart within a dashboard context asynchronously with inherited filters
- [Execute metric query](https://docs.lightdash.com/api-reference/v2/execute-metric-query.md): Executes a metric query asynchronously against your data warehouse using dimensions, metrics, filters, and sorts
- [Execute saved chart](https://docs.lightdash.com/api-reference/v2/execute-saved-chart.md): Executes a saved chart query asynchronously with optional parameter overrides
- [Execute SQL chart](https://docs.lightdash.com/api-reference/v2/execute-sql-chart.md): Executes a saved SQL chart query asynchronously with optional chart configurations
- [Execute SQL query](https://docs.lightdash.com/api-reference/v2/execute-sql-query.md): Executes a raw SQL query asynchronously against your data warehouse for custom queries
- [Execute underlying data](https://docs.lightdash.com/api-reference/v2/execute-underlying-data.md): Executes a query to retrieve underlying raw data for drilling down into aggregated values
- [Get chart](https://docs.lightdash.com/api-reference/v2/get-chart.md): Get a saved chart by uuid or slug within a project
- [Get comments](https://docs.lightdash.com/api-reference/v2/get-comments.md): Gets all comments for a dashboard within a project
- [Get custom role](https://docs.lightdash.com/api-reference/v2/get-custom-role.md): Get custom role by uuid
- [Get dashboard](https://docs.lightdash.com/api-reference/v2/get-dashboard.md): Get a dashboard by uuid or slug within a project
- [Get dashboard pre-aggregate audit](https://docs.lightdash.com/api-reference/v2/get-dashboard-pre-aggregate-audit.md): Audits pre-aggregate hit/miss coverage for every tile on a dashboard without executing the queries. Returns a per-tile breakdown grouped by tab, suitable for CI coverage checks and pre-aggregate tuning.
- [Get feature flag](https://docs.lightdash.com/api-reference/v2/get-feature-flag.md): Get feature flag
- [Get organization roles](https://docs.lightdash.com/api-reference/v2/get-organization-roles.md): Get roles for organization
- [Get pre-aggregate materializations](https://docs.lightdash.com/api-reference/v2/get-pre-aggregate-materializations.md): Retrieves pre-aggregate definitions with their latest materialization status
- [Get pre-aggregate stats](https://docs.lightdash.com/api-reference/v2/get-pre-aggregate-stats.md): Retrieves aggregated pre-aggregate hit/miss statistics for a project
- [Get project defaults](https://docs.lightdash.com/api-reference/v2/get-project-defaults.md): Get project defaults configuration
- [Get project parameters](https://docs.lightdash.com/api-reference/v2/get-project-parameters.md): Get project parameters by names
- [Get results](https://docs.lightdash.com/api-reference/v2/get-results.md): Retrieves paginated results from a previously executed async query using its UUID
- [Get validation result](https://docs.lightdash.com/api-reference/v2/get-validation-result.md): Get a single validation result by ID.
- [List chart schedulers](https://docs.lightdash.com/api-reference/v2/list-chart-schedulers.md): Get all schedulers for a saved chart
- [List content](https://docs.lightdash.com/api-reference/v2/list-content.md): Get content (charts, dashboards, spaces)
- [List dashboard schedulers](https://docs.lightdash.com/api-reference/v2/list-dashboard-schedulers.md): Get all schedulers for a dashboard
- [List deleted content](https://docs.lightdash.com/api-reference/v2/list-deleted-content.md): Get deleted content (soft-deleted charts, dashboards, etc.)
- [List metrics with time dimensions](https://docs.lightdash.com/api-reference/v2/list-metrics-with-time-dimensions.md): Get paginated metrics that have time dimensions available
- [List organization role assignments](https://docs.lightdash.com/api-reference/v2/list-organization-role-assignments.md): List organization role assignments (system roles only)
- [List project parameters](https://docs.lightdash.com/api-reference/v2/list-project-parameters.md): Get a paginated list of project parameters with search and sorting capabilities.
- [List project role assignments](https://docs.lightdash.com/api-reference/v2/list-project-role-assignments.md): List project role assignments
- [List validation results](https://docs.lightdash.com/api-reference/v2/list-validation-results.md): Get paginated validation results for a project with search, filter, and sort support.
- [Permanently delete content](https://docs.lightdash.com/api-reference/v2/permanently-delete-content.md): Permanently delete a soft-deleted item (chart, dashboard, etc.)
- [Remove project role from group](https://docs.lightdash.com/api-reference/v2/remove-project-role-from-group.md): Delete project role assignment for group
- [Remove project role from user](https://docs.lightdash.com/api-reference/v2/remove-project-role-from-user.md): Delete project role assignment for user
- [Remove scope from role](https://docs.lightdash.com/api-reference/v2/remove-scope-from-role.md): Remove scope from role
- [Replace project defaults](https://docs.lightdash.com/api-reference/v2/replace-project-defaults.md): Replace project defaults configuration
- [Replace project parameters](https://docs.lightdash.com/api-reference/v2/replace-project-parameters.md): Replace all project parameters
- [Restore content](https://docs.lightdash.com/api-reference/v2/restore-content.md): Restore a soft-deleted item (chart, dashboard, etc.)
- [Run dashboard pre-aggregate audit](https://docs.lightdash.com/api-reference/v2/run-dashboard-pre-aggregate-audit.md): Audit pre-aggregate hit/miss coverage with runtime filter overrides
- [Search field values](https://docs.lightdash.com/api-reference/v2/search-field-values.md): Searches for unique field values asynchronously, returning a query UUID to poll for results
- [Update custom role](https://docs.lightdash.com/api-reference/v2/update-custom-role.md): Update role in organization
- [Update dashboard](https://docs.lightdash.com/api-reference/v2/update-dashboard.md): Update a dashboard by uuid or slug within a project
- [Update project group role](https://docs.lightdash.com/api-reference/v2/update-project-group-role.md): Update project role assignment for group
- [The Lightdash way: data access](https://docs.lightdash.com/best-practice/lightdash-way.md): Our mission at Lightdash is to enable everybody in your company to answer their own questions using data.
- [Planning your dashboard: the Who, What and How of building great dashboards.](https://docs.lightdash.com/best-practice/planning-your-dashboard.md): For those of you who are just getting started with building dashboards, it it can be useful to do some planning before you get your hands dirty and actually start building the thing.
- [Contact Us](https://docs.lightdash.com/contact/contact-info.md): Here's the fastest way to reach us
- [FAQs](https://docs.lightdash.com/contact/faqs.md)
- [Generating a HAR file](https://docs.lightdash.com/contact/generating-har-file.md): How to capture a HAR file from your browser to help the Lightdash support team troubleshoot issues
- [Migrating to dbt 1.10: Fix Meta and Tags Configuration Warnings](https://docs.lightdash.com/dbt-guides/dbt-1.10-migration.md): Learn how to fix dbt 1.10 deprecation warnings for `meta` and `tags` properties, and migrate your project automatically with MetaMove.
- [Migrating to dbt Fusion](https://docs.lightdash.com/dbt-guides/dbt-fusion-migration.md): Learn how to migrate from dbt Core or dbt Cloud to the new dbt Fusion engine, including preparation steps, requirements, and best practices.
- [Guide to package-lock.yml in dbt](https://docs.lightdash.com/dbt-guides/dbt-package-lock.md): Learn what dbt's package-lock.yml file does, why it matters for your data projects, and how to manage it effectively.
- [Adding and managing Tables](https://docs.lightdash.com/get-started/develop-in-lightdash/adding-tables-to-lightdash.md)
- [How to create dimensions](https://docs.lightdash.com/get-started/develop-in-lightdash/how-to-create-dimensions.md)
- [How to create metrics](https://docs.lightdash.com/get-started/develop-in-lightdash/how-to-create-metrics.md)
- [Install Lightdash Skills](https://docs.lightdash.com/get-started/develop-in-lightdash/install-skills.md): Enable AI-powered development with Claude Code or Cursor by installing Lightdash skills
- [Developing in Lightdash](https://docs.lightdash.com/get-started/develop-in-lightdash/intro.md): This guide is for people who are new to Lightdash and need to learn the developer workflow. We'll go over how to install and use the CLI, plus how to create metrics and dimensions.
- [Creating dashboards](https://docs.lightdash.com/get-started/exploring-data/dashboards.md)
- [Exploring your content](https://docs.lightdash.com/get-started/exploring-data/exploring-your-content.md)
- [Using dashboards](https://docs.lightdash.com/get-started/exploring-data/interactive-dashboards.md)
- [Learning to explore data in Lightdash](https://docs.lightdash.com/get-started/exploring-data/intro.md): This guide is for people who are new to Lightdash and want to learn the fundamentals of Lightdash: querying from tables, building charts and dashboards, and sharing with your team.
- [An intro to metrics and dimensions](https://docs.lightdash.com/get-started/exploring-data/intro-metrics-dimensions.md)
- [Sharing with your team](https://docs.lightdash.com/get-started/exploring-data/sharing-insights.md): It's time to share your hard work with the world!
- [Querying from tables and exploring your data](https://docs.lightdash.com/get-started/exploring-data/using-explores.md)
- [Update your project connection](https://docs.lightdash.com/get-started/setup-lightdash/connect-project.md)
- [Create your first project](https://docs.lightdash.com/get-started/setup-lightdash/get-project-lightdash-ready.md)
- [Setting up a new project](https://docs.lightdash.com/get-started/setup-lightdash/intro.md): This guide is for people who are new to Lightdash and would like to learn how to set up a new project. We'll show you how to get your dbt project Lightdash-ready, connect your database and dbt project, and invite your team.
- [Inviting teammates to your Lightdash project](https://docs.lightdash.com/get-started/setup-lightdash/invite-new-users.md): You can only share things with people you've invited to your Lightdash project. Users with **Admin** access to your project can invite users.
- [AI agents](https://docs.lightdash.com/guides/ai-agents.md): No code, no complex tools, just type what you want to know. AI Agents use your saved dashboards and the metrics you've defined in Lightdash semantic layer, so your whole team can find answers faster.
- [Agent memory](https://docs.lightdash.com/guides/ai-agents/agent-memory.md): How AI agents learn from your corrections and feedback
- [Best practices for AI agents](https://docs.lightdash.com/guides/ai-agents/best-practices.md): Learn how to configure and optimize your AI agents for the best results
- [Data access control](https://docs.lightdash.com/guides/ai-agents/data-access.md): Understand how AI agents access and use your data
- [Evaluations](https://docs.lightdash.com/guides/ai-agents/evaluations.md): Test and validate your AI agent's performance with custom evaluation suites
- [Getting started with AI agents](https://docs.lightdash.com/guides/ai-agents/getting-started.md): Learn how to create and configure your first AI agent in Lightdash
- [Self-improvement (Beta)](https://docs.lightdash.com/guides/ai-agents/self-improvement.md): Enable AI agents to improve your semantic layer automatically
- [Using AI agents](https://docs.lightdash.com/guides/ai-agents/using-ai-agents.md): Learn how to interact with AI agents in Lightdash and Slack
- [Verified Answers](https://docs.lightdash.com/guides/ai-agents/verified-answers.md): Train your AI agent with high-quality examples for better, more consistent responses
- [Using AI with Lightdash](https://docs.lightdash.com/guides/ai-overview.md): Lightdash offers multiple AI-powered capabilities to help you explore data, build your semantic layer, and integrate with external tools.
- [Automate with CI/CD](https://docs.lightdash.com/guides/cli/automate-cli-workflow.md): You can use Github actions or other CI/CD tools to automate the CLI workflow
- [Authenticating your CLI](https://docs.lightdash.com/guides/cli/cli-authentication.md)
- [Autogenerate Lightdash-ready YAML files for your models](https://docs.lightdash.com/guides/cli/how-to-auto-generate-schema-files.md): Use the lightdash generate command to auto-generate and sync schema.yml files for your dbt models so they appear as tables in Lightdash.
- [How to install the Lightdash CLI](https://docs.lightdash.com/guides/cli/how-to-install-the-lightdash-cli.md): The Lightdash CLI is the recommended way to develop your dbt + Lightdash project. It makes development faster and easier, as well as giving you options for building more powerful automation to manage your Lightdash instance.
- [Upgrading your Lightdash CLI](https://docs.lightdash.com/guides/cli/how-to-upgrade-cli.md)
- [Deploy changes to production](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-deploy.md)
- [How to use lightdash lint](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-lint.md): Validate your Lightdash Code files against JSON schemas before deploying to catch errors early.
- [Preview local changes](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-preview.md): Preview projects are temporary Lightdash projects where you can safely experiment with your metrics, dimensions and charts without affecting your production project.
- [Lightdash Validate](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-validate.md): You can check to see if your changes break any of the content in your project using `lightdash validate`. This command will run the validator which will return a list of content in your project that is broken and details about the errors.
- [Configure your charts](https://docs.lightdash.com/guides/configure-charts.md): Learn about the configuration options available for most chart types in Lightdash.
- [Using custom fields](https://docs.lightdash.com/guides/custom-fields.md): The fields that you see in your `dimensions` and `metrics` are created by the people maintaining your Lightdash project. But, you can create new custom dimensions or metrics for quick calculations and binning on the fly. On this page, we'll explain what custom dimensions and metrics are and how to u…
- [Custom tooltips](https://docs.lightdash.com/guides/custom-tooltip.md)
- [Date zoom](https://docs.lightdash.com/guides/date-zoom.md): Change the time granularity of charts on your dashboard without editing them
- [Agent skills](https://docs.lightdash.com/guides/developer/agent-skills.md): Use AI coding agents like Cursor, Claude Code, Codex, and Antigravity to build and maintain your Lightdash semantic layer.
- [Caching](https://docs.lightdash.com/guides/developer/caching.md): Caching can reduce the overall number of queries that Lightdash executes against your data warehouse. Learn more about the types of caching and how to enable caching in this doc.
- [Test changes with Lightdash compile](https://docs.lightdash.com/guides/developer/cli/how-to-compile-your-lightdash-project.md): If you've connected Lightdash to GitHub, you can setup a `github action` and get Lightdash to compile your project and test your changes whenever you open a pull request.
- [Dashboards as code](https://docs.lightdash.com/guides/developer/dashboards-as-code.md): You can download your charts and dashboards as code, make changes, then upload your changes back to your Lightdash project using the CLI. Content as code is also useful for creating new Lightdash projects where you want the content to be copied from an existing project and added to your new project.
- [dbt model best practices for Lightdash](https://docs.lightdash.com/guides/developer/dbt-model-best-practices.md): Learn how to structure your dbt models for optimal performance and usability in Lightdash.
- [dbt write-back](https://docs.lightdash.com/guides/developer/dbt-write-back.md): dbt Write-Back allows you to develop your models and Metrics in Lightdash and write back these changes to your dbt project. Writing back to dbt will create a new branch and pull request in your project so you can save and manage these changes.
- [Editing dashboards with agents](https://docs.lightdash.com/guides/developer/editing-dashboards-with-agents.md): Use AI coding agents to bulk edit dashboards and charts using the download-edit-upload workflow.
- [Creating tailored tables from a single dbt model](https://docs.lightdash.com/guides/developer/explores.md): You can use the `explores` configuration in your Lightdash Semantic Layer to curate multiple ways to query from the same table for different audiences.
- [How to filter a dashboard in the URL](https://docs.lightdash.com/guides/developer/filtering-dashboard-in-url.md)
- [Preview projects](https://docs.lightdash.com/guides/developer/preview-projects.md): **Preview projects** are temporary Lightdash projects where you can safely experiment with your metrics, dimensions and charts without affecting your production project.
- [Renaming models, metrics, and dimensions](https://docs.lightdash.com/guides/developer/renaming-models-and-fields.md)
- [SQL runner](https://docs.lightdash.com/guides/developer/sql-runner.md): The SQL runner is used to build ad-hoc queries or charts using totally custom SQL.
- [Timezones](https://docs.lightdash.com/guides/developer/timezones.md): How Lightdash handles timezones in date filters, what settings are available, and how to work around common timezone issues.
- [How to use parameters](https://docs.lightdash.com/guides/developer/using-parameters.md)
- [Validating your content](https://docs.lightdash.com/guides/developer/validating-your-content.md): Broken content is not useful content. We've built tools in Lightdash to help validate your content so you can keep it useful and we'll notify you when it isn't.
- [Virtual views](https://docs.lightdash.com/guides/developer/virtual-views.md): Virtual Views are created in the [SQL Runner](/guides/developer/sql-runner) and allow other users to reuse your custom SQL queries in Lightdash. They get listed in your `Tables` and can be used like the tables that come from your dbt project.
- [How to set up Lightdash YAML validation for VS Code](https://docs.lightdash.com/guides/developer/vs-code-yaml-validation.md)
- [How to Embed Charts](https://docs.lightdash.com/guides/embedding/charts.md): Learn how to embed individual Lightdash charts with minimal UI for focused, single-metric displays
- [How to Embed Dashboards](https://docs.lightdash.com/guides/embedding/dashboards.md): Complete guide to embedding Lightdash dashboards with full configuration options for both iframe and React SDK methods
- [How to embed content](https://docs.lightdash.com/guides/embedding/how-to-embed-content.md): Lightdash allows you to embed your content using expirable URLs and tokens. This is a great way to enable self-serve analytics in your own application and platform by leveraging the insights you've got in Lightdash and making them available to your own users.
- [Filters reference](https://docs.lightdash.com/guides/filters.md): Filters appear at the top of the Explore view and allow users to change the data being pulled in.
- [Formatting your fields](https://docs.lightdash.com/guides/formatting-your-fields.md)
- [Formula table calculations](https://docs.lightdash.com/guides/formula-table-calculations.md): Build table calculations using a spreadsheet-style formula syntax instead of raw SQL.
- [Alerts](https://docs.lightdash.com/guides/how-to-create-alerts.md): Alerts enable you to receive notifications via email or Slack when the value of a saved chart meets your specified conditions.
- [Scheduled deliveries](https://docs.lightdash.com/guides/how-to-create-scheduled-deliveries.md): Scheduled deliveries let you send a dashboard or saved chart, and their results to people via email or Slack - even to people who don't have an account in your Lightdash instance.
- [How to promote content](https://docs.lightdash.com/guides/how-to-promote-content.md): Promoting content enables you to copy content from one project to another. It's especially useful when working with preview or development projects. You can promote charts created in your development projects to production, so it's easy to test and make changes without the fear of breaking things in…
- [Keyboard shortcuts](https://docs.lightdash.com/guides/keyboard-shortcuts.md): Speed up your workflow with keyboard shortcuts in Lightdash
- [Lightdash semantic layer](https://docs.lightdash.com/guides/lightdash-semantic-layer.md): Here we explain everything you need to know about the Lightdash semantic layer: how it works, where you can use it, benefits, and challenges.
- [Lightdash YAML](https://docs.lightdash.com/guides/lightdash-yaml.md): Use Lightdash without a dbt project by defining your semantic layer directly in YAML files.
- [Using Filters](https://docs.lightdash.com/guides/limiting-data-using-filters.md): Filters appear at the top of the Explore view or dashboard and allow users to change the data being pulled into your charts.
- [Metrics Catalog](https://docs.lightdash.com/guides/metrics-catalog.md): Metrics Catalog is a suite of features designed to put Metrics front and center. It simplifies data exploration, making it easy for business users to focus on metrics without dealing with complex tables or time dimensions.
- [Canvas](https://docs.lightdash.com/guides/metrics-catalog/canvas.md): Use the Canvas view to visualize metric relationships, hierarchies, and dependencies in a flexible workspace.
- [Catalog](https://docs.lightdash.com/guides/metrics-catalog/catalog.md): Browse, explore, and curate your metrics in the Metrics Catalog.
- [How to do period-over-period analysis in Lightdash](https://docs.lightdash.com/guides/period-over-period.md): Learn how to do period-over-period analysis in Lightdash with examples and best practices.
- [Table calculations](https://docs.lightdash.com/guides/table-calculations.md): Table calculations make it easy to create metrics on the fly (for example, aggregating the data in your table over some window, or getting a running total of a column).
- [SQL templates](https://docs.lightdash.com/guides/table-calculations/sql-templates.md): Use our SQL templates to get started with your table calculations!
- [Percent change from previous](https://docs.lightdash.com/guides/table-calculations/table-calculation-sql-templates/percent-change-from-previous.md): The percent change gives you the percent change in a value compared to the value in the row above it.
- [Percent of group/pivot total](https://docs.lightdash.com/guides/table-calculations/table-calculation-sql-templates/percent-of-group-pivot-total.md): The percent of the group/pivot total will give you the percentage of each value in a group out of the total sum of the values for that group.
- [Percent of previous value](https://docs.lightdash.com/guides/table-calculations/table-calculation-sql-templates/percent-of-previous-value.md)
- [Percent of column total](https://docs.lightdash.com/guides/table-calculations/table-calculation-sql-templates/percent-of-total-column.md): The percent of the column total will give you the percentage of each value in the column out of the total sum of the values in the column.
- [Rank in column](https://docs.lightdash.com/guides/table-calculations/table-calculation-sql-templates/rank-in-column.md): Ranking values in a column is when you set every value as a number either higher than or lower than the other values. The lowest value (rank = 1) indicates the value with the first rank in your set of values.
- [Rolling window](https://docs.lightdash.com/guides/table-calculations/table-calculation-sql-templates/rolling-window.md): Rolling windows, or lookbacks, calculate metrics like rolling averages using the current row combined with N previous rows. This can be useful for smoothing out volatile time series data to better understand long term trends.
- [Running total](https://docs.lightdash.com/guides/table-calculations/table-calculation-sql-templates/running-total.md): Running totals give you the sum of a value + all of the previous values in that column.
- [Using the Slack integration](https://docs.lightdash.com/guides/using-slack-integration.md)
- [Verified charts and dashboards](https://docs.lightdash.com/guides/verified-content.md): Mark charts and dashboards as verified so your team can instantly identify trusted, approved content. Verified content gets a green checkmark badge that shows who verified it and when, and verification is automatically removed if the content is edited.
- [Version history](https://docs.lightdash.com/guides/version-history.md): Roll back to previous versions of charts and dashboards in Lightdash.
- [Welcome to Lightdash](https://docs.lightdash.com/introduction.md): Lightdash instantly turns your dbt project into a full-stack BI platform.
- [Lightdash Admin References](https://docs.lightdash.com/references/admin.md): Below are reference docs for all admin functions and features in Lightdash.
- [Area chart](https://docs.lightdash.com/references/chart-types/area-chart.md): Use area charts to show how values develop over time when the total is as important as its parts.
- [Bar chart](https://docs.lightdash.com/references/chart-types/bar-chart.md): Use bar charts to compare things between different groups or track how a number changes over time.
- [Big value](https://docs.lightdash.com/references/chart-types/big-value.md): Use big value charts to display a single value prominently.
- [Custom charts](https://docs.lightdash.com/references/chart-types/custom-charts.md): Custom charts offer additional customization and an extended library of charts. The charts are powered by [vega-lite](https://vega.github.io/vega-lite/examples) - the link will take you to some example galleries of what you can build using this powerful charting library. This includes heat maps, bub…
- [Funnel chart](https://docs.lightdash.com/references/chart-types/funnel-chart.md): Use funnel charts to show pipeline performance, product conversion metrics, or any process with discrete stages.
- [Gauge](https://docs.lightdash.com/references/chart-types/gauge.md): Use gauges to highlight a single value against a qualitative range, like performance against a target.
- [Horizontal bar chart](https://docs.lightdash.com/references/chart-types/horizontal-bar-chart.md): Use horizontal bar charts when grouping by values with long labels or many possible values.
- [Line chart](https://docs.lightdash.com/references/chart-types/line-chart.md): Use line charts to show changes in a number over a short or long period of time.
- [Map](https://docs.lightdash.com/references/chart-types/map.md): Use maps to display geographic data on an interactive map.
- [Mixed chart](https://docs.lightdash.com/references/chart-types/mixed-chart.md): Use mixed charts to combine bars, lines, and scatter charts on the same visualization.
- [Chart types overview](https://docs.lightdash.com/references/chart-types/overview.md): Results tables can be useful for finding specific numbers or checking out your data, but it's usually easier to see trends and make sense of your data using charts.
- [Pie chart](https://docs.lightdash.com/references/chart-types/pie-chart.md): Use pie charts to visualize data that adds up to a meaningful whole.
- [Sankey chart](https://docs.lightdash.com/references/chart-types/sankey.md): Use Sankey charts to visualize flows between categories, showing how values move from sources to targets.
- [Scatter chart](https://docs.lightdash.com/references/chart-types/scatter-chart.md): Use scatter charts to look at the relationship or correlation between two variables.
- [Table](https://docs.lightdash.com/references/chart-types/table.md): Use tables for looking at tabular data or lists of things like user IDs or transactions.
- [Treemap chart](https://docs.lightdash.com/references/chart-types/treemap-chart.md): Use treemap charts to show parts of a whole using nested rectangles.
- [Dimensions reference](https://docs.lightdash.com/references/dimensions.md): Dimensions are the columns in your table. They are the "attributes" of your data. For example, `user_id` in your users table is a dimension.
- [Embedding reference](https://docs.lightdash.com/references/embedding.md): Complete API reference for embedding Lightdash content securely using JWTs
- [Embedding with iframe](https://docs.lightdash.com/references/iframe-embedding.md): Complete reference for embedding Lightdash content using iframes with JWTs in URL hash fragments
- [Lightdash Integration Reference Docs](https://docs.lightdash.com/references/integrations.md): Reference docs for all integrations available on Lightdash.
- [dbt Projects](https://docs.lightdash.com/references/integrations/dbt-projects.md): You can easily make changes in dbt and see them updated in your Lightdash project.
- [Google Sheets](https://docs.lightdash.com/references/integrations/google-sheets.md): Syncs let you send your chart results to a Google Sheet in your Google Drive on a schedule.
- [Lightdash MCP](https://docs.lightdash.com/references/integrations/lightdash-mcp.md)
- [Slack integration](https://docs.lightdash.com/references/integrations/slack-integration.md): Below is everything you need to know about the Lightdash Slack integration.
- [Joins reference](https://docs.lightdash.com/references/joins.md): Joins let you connect different models to each other so that you can explore more than one model at the same time in Lightdash and see how different parts of your data relate to each other.
- [Lightdash CLI reference](https://docs.lightdash.com/references/lightdash-cli.md): The Lightdash CLI is the recommended way to develop your Lightdash project. It makes development faster and easier, as well as giving you options for building more powerful automation to manage your Lightdash projects.
- [lightdash.config.yml reference](https://docs.lightdash.com/references/lightdash-config-yml.md): The lightdash.config.yml file allows you to configure project-wide settings for your Lightdash project, including Metrics Catalog, parameters, and defaults.
- [Metrics reference](https://docs.lightdash.com/references/metrics.md)
- [Organization credentials](https://docs.lightdash.com/references/organization-credentials.md): Organization credentials allow admins to create reusable warehouse credentials at the organization level, making it easier for users to create projects securely.
- [Auditing pre-aggregates from the CLI](https://docs.lightdash.com/references/pre-aggregates/cli-audit.md): Use lightdash pre-aggregate-audit to inspect coverage, find gaps in your YAML, and gate CI on dashboard hit rates.
- [Getting started with pre-aggregates](https://docs.lightdash.com/references/pre-aggregates/getting-started.md): Define pre-aggregates in your dbt YAML, configure scheduling, and start serving queries from materialized data.
- [Monitoring and debugging pre-aggregates](https://docs.lightdash.com/references/pre-aggregates/monitoring.md): Track materialization status, understand why queries miss pre-aggregates, and manage refreshes.
- [Pre-aggregates](https://docs.lightdash.com/references/pre-aggregates/overview.md): Speed up dashboards and reduce warehouse costs by serving queries from pre-computed, materialized summaries.
- [Embedding with React SDK](https://docs.lightdash.com/references/react-sdk.md): Reference documentation for the Lightdash React SDK for seamless embedding in React applications
- [SQL variables](https://docs.lightdash.com/references/sql-variables.md): When writing SQL in your Lightdash models, you can use the following references to template your SQL and make it more reusable
- [Aggregate functions](https://docs.lightdash.com/references/table-calculation-functions/aggregate-functions.md): Built-in functions for referencing column and row totals in your table calculations.
- [Pivot functions](https://docs.lightdash.com/references/table-calculation-functions/pivot-functions.md): Built-in functions for accessing values across pivot columns in your table calculations.
- [Row functions](https://docs.lightdash.com/references/table-calculation-functions/row-functions.md): Built-in functions for accessing values from other rows in your table calculations.
- [Tables reference](https://docs.lightdash.com/references/tables.md): You can run queries against the tables in your Lightdash project.
- [Add the Slack integration](https://docs.lightdash.com/references/workspace/adding-slack-integration.md)
- [Custom Roles](https://docs.lightdash.com/references/workspace/custom-roles.md): Custom roles allow you to create granular permission sets tailored to your organization's specific needs. With custom roles, you can define exactly which scopes (permissions) users should have, giving you fine-grained control over access to Lightdash features and resources.
- [Customizing the appearance of your project](https://docs.lightdash.com/references/workspace/customizing-the-appearance-of-your-project.md)
- [Default user spaces](https://docs.lightdash.com/references/workspace/default-user-spaces.md): Give every eligible user their own personal space in a project, provisioned automatically on their next login.
- [Feature Maturity Levels](https://docs.lightdash.com/references/workspace/feature-maturity-levels.md): We use standardized maturity levels to help you understand the stability and availability of features as we develop them
- [Groups](https://docs.lightdash.com/references/workspace/groups.md): Groups are a way to manage access to multiple users at the same time. A user can belong to multiple groups.
- [Creating multiple projects](https://docs.lightdash.com/references/workspace/how-to-create-multiple-projects.md): With Lightdash, you can have a single organization (e.g. Lightdash), and multiple projects within that organization (e.g. Production, Jaffle Shop, etc.)
- [Personal access tokens](https://docs.lightdash.com/references/workspace/personal-tokens.md)
- [Personal warehouse connections](https://docs.lightdash.com/references/workspace/personal-warehouse-connections.md): Learn when and how personal warehouse credentials are used in Lightdash projects.
- [Pinning](https://docs.lightdash.com/references/workspace/pinning.md)
- [Project compilation history](https://docs.lightdash.com/references/workspace/project-compilation-history.md): View the history of your project compilations to track changes, monitor deployments, and troubleshoot compilation issues.
- [Roles and permissions](https://docs.lightdash.com/references/workspace/roles.md)
- [SCIM Integration](https://docs.lightdash.com/references/workspace/scim-integration.md)
- [Service accounts](https://docs.lightdash.com/references/workspace/service-accounts.md): Service accounts provide a userless alternative to Personal Access Tokens (PATs) when working with the Lightdash CLI or the API. They are created and managed at the organization level, can be assigned granular scopes, and remain valid even if the administrator who created them leaves the organizatio…
- [Spaces](https://docs.lightdash.com/references/workspace/spaces.md): Once you've used Lightdash for a while, your team will probably end up with a lot of saved charts and dashboards. Spaces let you organize your saved charts and dashboards.
- [SSO providers](https://docs.lightdash.com/references/workspace/sso-providers.md): Overview of supported Single Sign-On providers across Lightdash plans
- [Usage analytics](https://docs.lightdash.com/references/workspace/usage-analytics.md): To understand who is accessing content or running queries in your Lightdash projects, we've built usage analytics to help you track this.
- [User attributes](https://docs.lightdash.com/references/workspace/user-attributes.md): User attributes provide a way to customise Lightdash charts, dashboards, and other behaviour depending on the user that is logged in. For example, you could only show your sales team members data that are relevant to their region.
- [User impersonation](https://docs.lightdash.com/references/workspace/user-impersonation.md): Temporarily view Lightdash as another user to troubleshoot user-specific issues/permissions.
- [Python SDK](https://docs.lightdash.com/sdk/python-sdk.md): Query your semantic layer with native Python syntax.
- [Configure a Slack integration for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-a-slack-app-for-lightdash.md)
- [Configure a Github integration for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-github-for-lightdash.md)
- [Configure Lightdash to use an external database](https://docs.lightdash.com/self-host/customize-deployment/configure-lightdash-to-use-an-external-database.md)
- [Configure Lightdash to use external storage](https://docs.lightdash.com/self-host/customize-deployment/configure-lightdash-to-use-external-object-storage.md)
- [Configure logging for Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-logging-for-lightdash.md)
- [Configure MCP for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-mcp-for-lightdash.md): Enable the Model Context Protocol (MCP) integration on your self-hosted Lightdash instance.
- [Configure Prometheus metrics for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-prometheus-metrics-for-self-hosted-lightdash.md)
- [Configure SMTP for Lightdash email notifications](https://docs.lightdash.com/self-host/customize-deployment/configure-smtp-for-lightdash-email-notifications.md)
- [Configure a standalone scheduler worker for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/configure-standalone-scheduled-worker.md)
- [Add headless browser on self-hosting](https://docs.lightdash.com/self-host/customize-deployment/enable-headless-browser-for-lightdash.md): We use a chrome headless browser to generate images from your charts and dashboards so we can send them via email or Slack.
- [Enable the scheduler in self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/enable-scheduler-in-self-hosted-lightdash.md)
- [Enterprise License Keys](https://docs.lightdash.com/self-host/customize-deployment/enterprise-license-keys.md): Access enterprise features on self-hosted Lightdash instances
- [Environment variables](https://docs.lightdash.com/self-host/customize-deployment/environment-variables.md)
- [Configure a Google Sheets integration for self-hosted Lightdash](https://docs.lightdash.com/self-host/customize-deployment/google-sheets-integration.md): In this guide we will show you how you can [upload to Google Sheets in scheduled deliveries](/references/integrations/google-sheets) and upload results from `charts` to Google Sheets on your self-hosted Lightdash server.
- [Resource recommendations](https://docs.lightdash.com/self-host/customize-deployment/recommended-resources.md): The recommended resource requests for each Lightdash component are as follows
- [Secure Lightdash with HTTPS](https://docs.lightdash.com/self-host/customize-deployment/secure-lightdash-with-https.md): To run Lightdash in production it is highly recommended to secure it with HTTPS. This is usually done using your cloud provider's load balancer or ingress controller. Optionally you could use a proxy service like [nginx](https://www.nginx.com/) or [traefik](https://traefik.io).
- [Configure Lightdash to use passwords or SSO for authentication](https://docs.lightdash.com/self-host/customize-deployment/use-sso-login-for-self-hosted-lightdash.md)
- [Enterprise on-prem setup](https://docs.lightdash.com/self-host/enterprise-on-prem.md): Guide for deploying Lightdash Enterprise Edition on-prem, on prem, on premises, on-premises on your own infrastructure. FedRAMP ready.
- [Lightdash Cloud vs. Self-Hosted](https://docs.lightdash.com/self-host/lightdash-cloud-vs-self-hosted.md): Lightdash is open-source and licensed under the MIT license. This means that you are free to self-host Lightdash on your own infrastructure but without any warranty or support from the Lightdash team.
- [NATS workers](https://docs.lightdash.com/self-host/nats-workers/overview.md): Scale Lightdash query processing with dedicated NATS worker pods using the Helm chart.
- [Pre-aggregate workers](https://docs.lightdash.com/self-host/nats-workers/pre-aggregate-workers.md): Configure and scale pre-aggregate worker pods for materialization and DuckDB query serving.
- [Warehouse workers](https://docs.lightdash.com/self-host/nats-workers/warehouse-workers.md): Configure and scale dedicated warehouse query worker pods.
- [Self-Host Lightdash](https://docs.lightdash.com/self-host/self-host-lightdash.md)
- [Self-host Lightdash using docker compose](https://docs.lightdash.com/self-host/self-host-lightdash-docker-compose.md)
- [Updating Lightdash to the latest version](https://docs.lightdash.com/self-host/update-lightdash.md)
- [Upgrading Lightdash (versioning)](https://docs.lightdash.com/self-host/upgrading-lightdash-versioning.md): How Lightdash versioning works and how to upgrade between versions.

## OpenAPI Specs

- [swagger](https://raw.githubusercontent.com/lightdash/lightdash/refs/heads/main/packages/backend/src/generated/swagger.json)
- [openapi](https://docs.lightdash.com/api-reference/openapi.json)

## Optional

- [About Us](https://www.lightdash.com/about)
- [Community](https://join.slack.com/t/lightdash-community/shared_invite/zt-3pbwqmq5e-vhTc7HHcS787w618ngoPHA)
- [Blog](https://www.lightdash.com/blog)