# Lightdash

## Docs

- [Delete apiv1projects datacatalog categories](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/delete-apiv1projects-datacatalog-categories.md)
- [Delete apiv1projects datacatalogmetricstreeedges ](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/delete-apiv1projects-datacatalogmetricstreeedges-.md)
- [Get apiv1projects datacatalog](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalog.md): Get catalog items
- [Get apiv1projects datacatalog analytics](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalog-analytics.md): Get catalog analytics for tables
- [Get apiv1projects datacatalog analytics 1](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalog-analytics-1.md): Get catalog analytics for fields
- [Get apiv1projects datacatalog metadata](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalog-metadata.md): Get catalog metadata for tables
- [Get apiv1projects datacatalog segment dimensions](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalog-segment-dimensions.md): Get dimensions that can be used to segment metrics
- [Get apiv1projects datacatalogmetrics](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalogmetrics.md): Get metrics catalog
- [Get apiv1projects datacatalogmetrics ](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalogmetrics-.md): Get metric by table and metric name
- [Get apiv1projects datacatalogmetrics with time dimensions](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalogmetrics-with-time-dimensions.md): Get metrics with time dimensions
- [Get apiv1projects datacatalogmetricshas](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalogmetricshas.md): Check if there are any metrics in catalog
- [Get apiv1projects datacatalogmetricstree](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/get-apiv1projects-datacatalogmetricstree.md)
- [Patch apiv1projects datacatalog icon](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/patch-apiv1projects-datacatalog-icon.md)
- [Post apiv1projects datacatalog categories](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/post-apiv1projects-datacatalog-categories.md)
- [Post apiv1projects datacatalogmetricstreeedges](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/catalog/post-apiv1projects-datacatalogmetricstreeedges.md)
- [Get change](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/changesets/get-change.md): Get a specific change by UUID
- [List changesets](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/changesets/list-changesets.md): Get active changeset for a project
- [Post apiv1projects changesetschanges revert](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/changesets/post-apiv1projects-changesetschanges-revert.md)
- [Post apiv1projects changesetsrevert all](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/changesets/post-apiv1projects-changesetsrevert-all.md)
- [Get apiv1saved history](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/get-apiv1saved-history.md): Get chart version history from last 30 days
- [Get apiv1saved promotediff](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/get-apiv1saved-promotediff.md): Get diff from chart to promote
- [Get apiv1saved version](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/get-apiv1saved-version.md): Get chart version
- [Post apiv1saved calculate total](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/post-apiv1saved-calculate-total.md): Calculate metric totals from a saved chart
- [Post apiv1saved chart and results](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/post-apiv1saved-chart-and-results.md)
- [Post apiv1saved downloadcsv](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/post-apiv1saved-downloadcsv.md): Download a CSV from a saved chart uuid
- [Post apiv1saved promote](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/post-apiv1saved-promote.md): Promote chart to its upstream project
- [Post apiv1saved results](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/post-apiv1saved-results.md): Run a query for a chart
- [Post apiv1saved rollback](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/post-apiv1saved-rollback.md): Rollback chart to version
- [Post apiv1saved version results](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/charts/post-apiv1saved-version-results.md): Run a query for a chart version
- [Delete apiv1commentsdashboards ](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/comments/delete-apiv1commentsdashboards-.md): Deletes a comment on a dashboard
- [Get apiv1commentsdashboards](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/comments/get-apiv1commentsdashboards.md): Gets all comments for a dashboard
- [Patch apiv1commentsdashboards ](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/comments/patch-apiv1commentsdashboards-.md): Resolves a comment on a dashboard
- [Post apiv1commentsdashboards ](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/comments/post-apiv1commentsdashboards-.md): Creates a comment on a dashboard tile
- [Get apiv1projects pinned lists items](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/content/get-apiv1projects-pinned-lists-items.md): Get pinned items
- [Patch apiv1projects pinned lists itemsorder](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/content/patch-apiv1projects-pinned-lists-itemsorder.md): Update pinned items order
- [Post apiv2content move](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/content/post-apiv2content-move.md): Move a single item (Chart, Dashboard, Space) to another space
- [Post apiv2contentbulk action move](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/content/post-apiv2contentbulk-action-move.md): Move multiple items (Charts, Dashboards, Spaces) to another space
- [Get apiv1dashboards promotediff](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/dashboards/get-apiv1dashboards-promotediff.md): Get diff from dashboard to promote
- [Post apiv1dashboards promote](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/dashboards/post-apiv1dashboards-promote.md): Promote dashboard to its upstream project
- [Delete apiv1githubuninstall](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/delete-apiv1githubuninstall.md)
- [Delete apiv1gitlabuninstall](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/delete-apiv1gitlabuninstall.md)
- [Post apiv1projects explores runquery](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/exploring/post-apiv1projects-explores-runquery.md): Run a query for explore
- [Post apiv1projects explores rununderlyingdataquery](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/exploring/post-apiv1projects-explores-rununderlyingdataquery.md): Run a query for underlying data results
- [Post apiv1projects sqlquery](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/exploring/post-apiv1projects-sqlquery.md): Run a raw sql query against the project's warehouse connection
- [Get apiv1csv](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/exports/get-apiv1csv.md): Get a Csv
- [Get event names](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/funnel/get-event-names.md): Get distinct event names from a dimension for funnel step selection
- [Run funnel query](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/funnel/run-funnel-query.md): Execute a funnel analysis query and return conversion metrics
- [Get AI settings](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-ai-settings.md): Get AI organization settings
- [Get apiv1aiagentsadminagents](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1aiagentsadminagents.md)
- [Get apiv1aiagentsadminthreads](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1aiagentsadminthreads.md)
- [Get apiv1githubconfig](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1githubconfig.md)
- [Get apiv1githubinstall](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1githubinstall.md): Install the Lightdash GitHub App and link to an organization
- [Get apiv1githuboauthcallback](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1githuboauthcallback.md): Callback URL for GitHub App Authorization also used for GitHub App Installation with combined Authorization
- [Get apiv1githubreposlist](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1githubreposlist.md)
- [Get apiv1gitlabinstall](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1gitlabinstall.md): Initiate GitLab OAuth integration
- [Get apiv1gitlaboauthcallback](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1gitlaboauthcallback.md): GitLab OAuth callback handler
- [Get apiv1gitlabreposlist](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/get-apiv1gitlabreposlist.md)
- [Create file PR](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/git-integration/create-file-pr.md): Create a pull request with arbitrary file changes
- [Get explore file](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/git-integration/get-explore-file.md): Get the YAML file for an explore's base table
- [Post apiv1projects git integrationpull requestscustom dimensions](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/git-integration/post-apiv1projects-git-integrationpull-requestscustom-dimensions.md)
- [Post apiv1projects git integrationpull requestscustom metrics](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/git-integration/post-apiv1projects-git-integrationpull-requestscustom-metrics.md)
- [Delete apiv1slack](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/delete-apiv1slack.md)
- [Get apiv1gdriveget access token](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/get-apiv1gdriveget-access-token.md): Get access token for google drive
- [Get apiv1slack](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/get-apiv1slack.md)
- [Get apiv1slackchannels](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/get-apiv1slackchannels.md): Get slack channels
- [Get apiv1slackimage](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/get-apiv1slackimage.md)
- [Get apiv1slackinstall](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/get-apiv1slackinstall.md)
- [Get apiv1slackis authenticated](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/get-apiv1slackis-authenticated.md): Check if the user has an OpenID identity for Slack
- [Lookup channel](https://lightdash-docs-scripts-cicd.mintlify.app/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.
- [Post apiv1gdriveupload gsheet](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/post-apiv1gdriveupload-gsheet.md): Upload results from query to Google Sheet
- [Put apiv1slackcustom settings](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/integrations/put-apiv1slackcustom-settings.md): Update slack notification channel to send notifications to scheduled jobs fail
- [Proxy GeoJSON](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/map/proxy-geojson.md): Proxies external GeoJSON files to bypass CORS restrictions
- [Post apiv1projects metricsexplorer runmetricexplorerquery](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/metrics-explorer/post-apiv1projects-metricsexplorer-runmetricexplorerquery.md): Run a metrics explorer query
- [Post apiv1projects metricsexplorer runmetrictotal](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/metrics-explorer/post-apiv1projects-metricsexplorer-runmetrictotal.md)
- [Delete apiv1userme](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/delete-apiv1userme.md): Delete user
- [Delete apiv1usermepersonal access tokens](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/delete-apiv1usermepersonal-access-tokens.md): Delete personal access token
- [Delete apiv1userwarehousecredentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/delete-apiv1userwarehousecredentials.md): Delete user warehouse credentials
- [Get apiv1user](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/get-apiv1user.md): Get authenticated user
- [Get apiv1useraccount](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/get-apiv1useraccount.md): Get account information
- [Get apiv1userlogin options](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/get-apiv1userlogin-options.md): Get login options
- [Get apiv1usermeallowedorganizations](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/get-apiv1usermeallowedorganizations.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.
- [Get apiv1usermeemailstatus](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/get-apiv1usermeemailstatus.md): Get the verification status for the current user's primary email
- [Get apiv1usermepersonal access tokens](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/get-apiv1usermepersonal-access-tokens.md): List personal access tokens
- [Get apiv1userwarehousecredentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/get-apiv1userwarehousecredentials.md): Get user warehouse credentials
- [Patch apiv1usermepersonal access tokens rotate](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/patch-apiv1usermepersonal-access-tokens-rotate.md): Rotate personal access token
- [Patch apiv1userwarehousecredentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/patch-apiv1userwarehousecredentials.md): Update user warehouse credentials
- [Post apiv1user](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/post-apiv1user.md): Register user
- [Post apiv1usermejoinorganization](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/post-apiv1usermejoinorganization.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.
- [Post apiv1usermepersonal access tokens](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/post-apiv1usermepersonal-access-tokens.md): Create personal access token
- [Post apiv1userwarehousecredentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/post-apiv1userwarehousecredentials.md): Create user warehouse credentials
- [Put apiv1usermeemailotp](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/my-account/put-apiv1usermeemailotp.md): Create a new one-time passcode for the current user's primary email. The user will receive an email with the passcode.
- [Get apiv1notifications](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/notifications/get-apiv1notifications.md): Gets notifications for a user based on the type
- [Patch apiv1notifications](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/notifications/patch-apiv1notifications.md): Update notification
- [Create warehouse credentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organization-warehouse-credentials/create-warehouse-credentials.md): Create new warehouse credentials for the organization
- [Delete warehouse credentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organization-warehouse-credentials/delete-warehouse-credentials.md): Delete warehouse credentials
- [Get warehouse credential](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organization-warehouse-credentials/get-warehouse-credential.md): Get a specific warehouse credential by UUID
- [List warehouse credentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organization-warehouse-credentials/list-warehouse-credentials.md): Get all warehouse credentials for the current organization
- [Update warehouse credentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organization-warehouse-credentials/update-warehouse-credentials.md): Update existing warehouse credentials
- [Delete apiv1org](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/delete-apiv1org.md): Deletes an organization and all users inside that organization
- [Delete apiv1orgcolor palettes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/delete-apiv1orgcolor-palettes.md)
- [Delete apiv1orguser](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/delete-apiv1orguser.md): Deletes a user from the current user's organization
- [Get apiv1org](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-apiv1org.md): Get the current user's organization
- [Get apiv1orgallowedemaildomains](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-apiv1orgallowedemaildomains.md): Gets the allowed email domains for the current user's organization
- [Get apiv1orgcolor palettes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-apiv1orgcolor-palettes.md)
- [Get apiv1orggroups](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-apiv1orggroups.md): Gets all the groups in the current user's organization
- [Get apiv1orgprojects](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-apiv1orgprojects.md): Gets all projects of the current user's organization
- [Get apiv1orgusers](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-apiv1orgusers.md): Gets all the members of the current user's organization
- [Get apiv1orgusers 1](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-apiv1orgusers-1.md): Get the member profile for a user in the current user's organization by uuid
- [Get apiv1orgusersemail](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-apiv1orgusersemail.md): Get the member profile for a user in the current user's organization by email
- [Get user schedulers](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/get-user-schedulers.md): Gets a summary of scheduled deliveries owned by a user across all projects
- [Patch apiv1org](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/patch-apiv1org.md): Update the current user's organization
- [Patch apiv1orgallowedemaildomains](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/patch-apiv1orgallowedemaildomains.md): Updates the allowed email domains for the current user's organization
- [Patch apiv1orgcolor palettes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/patch-apiv1orgcolor-palettes.md)
- [Post apiv1orgcolor palettes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/post-apiv1orgcolor-palettes.md)
- [Post apiv1orgcolor palettes active](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/post-apiv1orgcolor-palettes-active.md)
- [Post apiv1orggroups](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/post-apiv1orggroups.md): Creates a new group in the current user's organization
- [Post apiv1orgprojects](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/post-apiv1orgprojects.md)
- [Put apiv1org](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/put-apiv1org.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.
- [Reassign schedulers](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/organizations/reassign-schedulers.md): Reassigns all scheduled deliveries from one user to another
- [Check Databricks OAuth authentication](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/check-databricks-oauth-authentication.md): Check if user is authenticated with Databricks OAuth
- [Delete apiv1projects tags](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/delete-apiv1projects-tags.md)
- [Delete apiv1projects validate](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/delete-apiv1projects-validate.md): Deletes a single validation error.
- [Get apiv1analyticsuser activity](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1analyticsuser-activity.md)
- [Get apiv1bigqueryssodatasets](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1bigqueryssodatasets.md)
- [Get apiv1bigqueryssois authenticated](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1bigqueryssois-authenticated.md)
- [Get apiv1projects](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects.md): Get a project of an organiztion
- [Get apiv1projects chart summaries](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-chart-summaries.md): List all charts summaries in a project
- [Get apiv1projects charts](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-charts.md): List all charts in a project
- [Get apiv1projects chartscode](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-chartscode.md): Charts as code
- [Get apiv1projects compile logs](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-compile-logs.md): Get compilation logs for a project
- [Get apiv1projects custom metrics](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-custom-metrics.md)
- [Get apiv1projects dashboards](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-dashboards.md)
- [Get apiv1projects dashboardscode](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-dashboardscode.md)
- [Get apiv1projects explores](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-explores.md)
- [Get apiv1projects explores 1](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-explores-1.md)
- [Get apiv1projects groupaccesses](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-groupaccesses.md): List group access for projects
- [Get apiv1projects renamechart fields](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-renamechart-fields.md): Get a list of fields for this chart's explore to be used when renaming a chart in the UI
- [Get apiv1projects spaces](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-spaces.md): List all spaces in a project
- [Get apiv1projects tags](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-tags.md)
- [Get apiv1projects user credentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-user-credentials.md)
- [Get apiv1projects validate](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1projects-validate.md): Get validation results for a project. This will return the results of the latest validation job.
- [Get apiv1snowflakessois authenticated](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-apiv1snowflakessois-authenticated.md)
- [Get compilation log for a specific job](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-compilation-log-for-a-specific-job.md): Get compilation log by job UUID
- [Get SQL charts as code](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-sql-charts-as-code.md): Gets SQL charts in code representation
- [Get unused content](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/get-unused-content.md): Get unused content for a project showing charts and dashboards with little to no usage
- [Patch apiv1projects dashboards](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/patch-apiv1projects-dashboards.md)
- [Patch apiv1projects metadata](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/patch-apiv1projects-metadata.md): Update project metadata like upstreamProjectUuid we don't trigger a compile, so not for updating warehouse or credentials
- [Patch apiv1projects schedulersettings](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/patch-apiv1projects-schedulersettings.md)
- [Patch apiv1projects tags](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/patch-apiv1projects-tags.md)
- [Patch apiv1projects user credentials](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/patch-apiv1projects-user-credentials.md)
- [Post apiv1analyticsuser activity download](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1analyticsuser-activity-download.md)
- [Post apiv1projects calculate subtotals](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-calculate-subtotals.md)
- [Post apiv1projects calculate total](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-calculate-total.md): Calculate all metric totals from a metricQuery
- [Post apiv1projects charts code](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-charts-code.md)
- [Post apiv1projects createpreview](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-createpreview.md)
- [Post apiv1projects dashboards](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-dashboards.md)
- [Post apiv1projects dashboards code](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-dashboards-code.md)
- [Post apiv1projects dashboardswith charts](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-dashboardswith-charts.md)
- [Post apiv1projects dbt cloudwebhook](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-dbt-cloudwebhook.md)
- [Post apiv1projects explores compilequery](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-explores-compilequery.md)
- [Post apiv1projects explores downloadcsv](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-explores-downloadcsv.md)
- [Post apiv1projects refresh](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-refresh.md)
- [Post apiv1projects rename](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-rename.md)
- [Post apiv1projects renamechart](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-renamechart.md)
- [Post apiv1projects tags](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-tags.md)
- [Post apiv1projects validate](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/post-apiv1projects-validate.md): Validate content inside a project. This will start a validation job and return the job id.
- [Put apiv1projects explores](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/put-apiv1projects-explores.md)
- [Put apiv1projects tagsyaml](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/put-apiv1projects-tagsyaml.md)
- [Upsert SQL chart as code](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/projects/upsert-sql-chart-as-code.md): Upserts an SQL chart from code representation
- [Cancel query](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/cancel-query.md): Cancels a running async query and discards any partial results
- [Download results](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/download-results.md): Downloads query results in various formats with custom formatting options
- [Download results](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/download-results-1.md): Downloads query results in various formats with custom formatting options
- [Execute dashboard chart](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/execute-dashboard-chart.md): Executes a chart within a dashboard context asynchronously with inherited dashboard filters
- [Execute dashboard SQL chart](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/execute-dashboard-sql-chart.md): Executes a SQL chart within a dashboard context asynchronously with inherited filters
- [Execute metric query](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/execute-metric-query.md): Executes a metric query asynchronously against your data warehouse using dimensions, metrics, filters, and sorts
- [Execute saved chart](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/execute-saved-chart.md): Executes a saved chart query asynchronously with optional parameter overrides
- [Execute SQL chart](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/execute-sql-chart.md): Executes a saved SQL chart query asynchronously with optional chart configurations
- [Execute SQL query](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/execute-sql-query.md): Executes a raw SQL query asynchronously against your data warehouse for custom queries
- [Execute underlying data](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/execute-underlying-data.md): Executes a query to retrieve underlying raw data for drilling down into aggregated values
- [Get results](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/query/get-results.md): Retrieves paginated results from a previously executed async query using its UUID
- [Delete apiv1projects access](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/delete-apiv1projects-access.md): Remove a user's access to a project
- [Delete apiv1projects spaces groupshare](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/delete-apiv1projects-spaces-groupshare.md): Remove a group's access to a space
- [Delete apiv1projects spaces share](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/delete-apiv1projects-spaces-share.md): Remove a user's access to a space
- [Get apiv1projects access](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/get-apiv1projects-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.
- [Get apiv1projects user](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/get-apiv1projects-user.md): Get a project explicit member's access. There may be users that have access to the project via their organization membership.
- [Patch apiv1orgusers](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/patch-apiv1orgusers.md): Updates the membership profile for a user in the current user's organization
- [Patch apiv1projects access](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/patch-apiv1projects-access.md): Update a user's access to a project
- [Patch apiv1projects spaces](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/patch-apiv1projects-spaces.md): Update a space in a project
- [Post apiv1projects access](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/post-apiv1projects-access.md): Grant a user access to a project
- [Post apiv1projects spaces](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/post-apiv1projects-spaces.md): Create a new space inside a project
- [Post apiv1projects spaces groupshare](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/post-apiv1projects-spaces-groupshare.md): Grant a group access to a space
- [Post apiv1projects spaces share](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/roles-&-permissions/post-apiv1projects-spaces-share.md): Grant a user access to a space
- [Delete apiv1schedulers](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/delete-apiv1schedulers.md): Delete a scheduler
- [Get apiv1schedulers](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/get-apiv1schedulers.md): Get a scheduler
- [Get apiv1schedulers jobs](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/get-apiv1schedulers-jobs.md): Get scheduled jobs
- [Get apiv1schedulers list](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/get-apiv1schedulers-list.md): List all schedulers with pagination, search, sorting, and filtering
- [Get apiv1schedulers logs](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/get-apiv1schedulers-logs.md): Get scheduled logs
- [Get apiv1schedulersjob status](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/get-apiv1schedulersjob-status.md): Get a generic job status This method can be used when polling from the frontend
- [Get run logs](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/get-run-logs.md): Get detailed logs for a specific scheduler run
- [List scheduler runs](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/list-scheduler-runs.md): Get paginated scheduler runs with aggregated child job counts
- [Patch apiv1schedulers](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/patch-apiv1schedulers.md): Update a scheduler
- [Patch apiv1schedulers enabled](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/patch-apiv1schedulers-enabled.md): Set scheduler enabled
- [Post apiv1schedulerssend](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/post-apiv1schedulerssend.md): Send a scheduler now before saving it
- [Reassign scheduler owner](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/reassign-scheduler-owner.md): Reassign ownership of multiple schedulers
- [Send scheduler by uuid](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/schedulers/send-scheduler-by-uuid.md): Send an existing scheduler now by its uuid
- [Create group](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/create-group.md): Create a new group in the SCIM application
- [Create user](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/create-user.md): Create a new user
- [Delete group](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/delete-group.md): Delete a specific group by its SCIM ID
- [Delete user](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/delete-user.md): Delete a user by ID
- [Get group](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/get-group.md): Get a specific group by its SCIM ID
- [Get resource type](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/get-resource-type.md): Get individual SCIM resource type
- [Get role](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/get-role.md): Get a SCIM role by ID
- [Get schema](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/get-schema.md): Get individual SCIM schema
- [Get user](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/get-user.md): Get a SCIM user by ID
- [List groups](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/list-groups.md): Get a list of groups within an organization
- [List resource types](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/list-resource-types.md): Get SCIM resource types
- [List roles](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/list-roles.md): Get a list of roles within an organization
- [List schemas](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/list-schemas.md): Get SCIM schemas
- [List users](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/list-users.md): List SCIM users in the organization
- [Patch group](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/patch-group.md): Partially updates a group’s attributes (e.g., add or remove members).
- [Patch user](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/patch-user.md): Patch a user by ID (SCIM PATCH)
- [Provider config](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/provider-config.md): Get SCIM service provider configuration
- [Replace group](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/replace-group.md): Update a group's attributes completely
- [Replace user](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/replace-user.md): Update a user by ID (SCIM PUT)
- [Root check](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/scim/root-check.md): Root SCIM endpoint for validating SCIM configuration
- [Get apiv1share](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/share-links/get-apiv1share.md): Get a share url from a short url id
- [Post apiv1share](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/share-links/post-apiv1share.md): Given a full URL generates a short url id that can be used for sharing
- [Delete apiv1projects spaces](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/spaces/delete-apiv1projects-spaces.md): Delete a space from a project
- [Get apiv1projects spaces](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/spaces/get-apiv1projects-spaces.md): Get details for a space in a project
- [Delete apiv1projects spotlighttableconfig](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/spotlight/delete-apiv1projects-spotlighttableconfig.md)
- [Get apiv1projects spotlighttableconfig](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/spotlight/get-apiv1projects-spotlighttableconfig.md)
- [Post apiv1projects spotlighttableconfig](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/spotlight/post-apiv1projects-spotlighttableconfig.md)
- [Delete apiv1projects sqlrunnersaved](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/delete-apiv1projects-sqlrunnersaved.md): Delete sql chart
- [Delete apiv1projects sqlrunnervirtual view](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/delete-apiv1projects-sqlrunnervirtual-view.md): Delete a virtual-view
- [Get apiv1projects sqlrunnerfields](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/get-apiv1projects-sqlrunnerfields.md)
- [Get apiv1projects sqlrunnerresults](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/get-apiv1projects-sqlrunnerresults.md): Get results from a file stored locally
- [Get apiv1projects sqlrunnersaved](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/get-apiv1projects-sqlrunnersaved.md): Get saved sql chart
- [Get apiv1projects sqlrunnersaved results job](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/get-apiv1projects-sqlrunnersaved-results-job.md): Schedules a job to get its results
- [Get apiv1projects sqlrunnersavedslug](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/get-apiv1projects-sqlrunnersavedslug.md): Get saved sql chart
- [Get apiv1projects sqlrunnersavedslug results job](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/get-apiv1projects-sqlrunnersavedslug-results-job.md): Schedules a job to get its results
- [Get apiv1projects sqlrunnertables](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/get-apiv1projects-sqlrunnertables.md)
- [Patch apiv1projects sqlrunnersaved](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/patch-apiv1projects-sqlrunnersaved.md): Update sql chart
- [Post apiv1projects sqlrunnerpreview](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/post-apiv1projects-sqlrunnerpreview.md): Preview write back from SQL runner
- [Post apiv1projects sqlrunnerpull request](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/post-apiv1projects-sqlrunnerpull-request.md): Write back from SQL runner
- [Post apiv1projects sqlrunnerrefresh catalog](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/post-apiv1projects-sqlrunnerrefresh-catalog.md): Refresh the catalog cache
- [Post apiv1projects sqlrunnerrun](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/post-apiv1projects-sqlrunnerrun.md)
- [Post apiv1projects sqlrunnerrunpivotquery](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/post-apiv1projects-sqlrunnerrunpivotquery.md)
- [Post apiv1projects sqlrunnersaved](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/post-apiv1projects-sqlrunnersaved.md): Create sql chart
- [Post apiv1projects sqlrunnervirtual view](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/post-apiv1projects-sqlrunnervirtual-view.md): Create a virtual-view
- [Put apiv1projects sqlrunnervirtual view](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/sql-runner/put-apiv1projects-sqlrunnervirtual-view.md)
- [Post apiv1sshkey pairs](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/ssh-keypairs/post-apiv1sshkey-pairs.md)
- [Update AI settings](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/update-ai-settings.md): Update AI organization settings
- [Delete apiv1orgattributes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-attributes/delete-apiv1orgattributes.md): Remove a user attribute
- [Get apiv1orgattributes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-attributes/get-apiv1orgattributes.md): Get all user attributes
- [Post apiv1orgattributes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-attributes/post-apiv1orgattributes.md): Creates new user attribute
- [Put apiv1orgattributes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-attributes/put-apiv1orgattributes.md): Updates a user attribute
- [Delete apiv1groups](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/delete-apiv1groups.md): Delete a group
- [Delete apiv1groups members](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/delete-apiv1groups-members.md): Remove a user from a group
- [Delete apiv1groups projects](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/delete-apiv1groups-projects.md): Remove project access from a group
- [Get apiv1groups](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/get-apiv1groups.md): Get group details
- [Get apiv1groups members](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/get-apiv1groups-members.md): View members of a group
- [Patch apiv1groups](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/patch-apiv1groups.md): Update a group
- [Patch apiv1groups projects](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/patch-apiv1groups-projects.md): Update project access for a group
- [Post apiv1groups projects](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/post-apiv1groups-projects.md): Add project access to a group
- [Put apiv1groups members](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/user-groups/put-apiv1groups-members.md): Add a Lightdash user to a group
- [Lightdash API](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v1/introduction.md)
- [Recipes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v1/recipes.md): A collection of practical, copy-paste examples showing how to combine Lightdash API endpoints to achieve common workflows.
- [Delete apiv2orgs roles](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/delete-apiv2orgs-roles.md): Delete role from organization
- [Delete apiv2orgs roles scopes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/delete-apiv2orgs-roles-scopes.md): Remove scope from role
- [Delete apiv2projects rolesassignmentsgroup](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/delete-apiv2projects-rolesassignmentsgroup.md): Delete project role assignment for group
- [Delete apiv2projects rolesassignmentsuser](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/delete-apiv2projects-rolesassignmentsuser.md): Delete project role assignment for user
- [Get apiv2content](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/get-apiv2content.md): Get content (charts, dashboards, spaces)
- [Get apiv2feature flag](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/get-apiv2feature-flag.md): Get feature flag
- [Get apiv2orgs roles](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/get-apiv2orgs-roles.md): Get roles for organization
- [Get apiv2orgs roles 1](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/get-apiv2orgs-roles-1.md): Get custom role by uuid
- [Get apiv2orgs rolesassignments](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/get-apiv2orgs-rolesassignments.md): List organization role assignments (system roles only)
- [Get apiv2projects parameters](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/get-apiv2projects-parameters.md)
- [Get apiv2projects rolesassignments](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/get-apiv2projects-rolesassignments.md): List project role assignments
- [List project parameters](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/list-project-parameters.md): Get a paginated list of project parameters with search and sorting capabilities.
- [Patch apiv2orgs roles](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/patch-apiv2orgs-roles.md): Update role in organization
- [Patch apiv2projects rolesassignmentsgroup](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/patch-apiv2projects-rolesassignmentsgroup.md): Update project role assignment for group
- [Post apiv2orgs roles](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/post-apiv2orgs-roles.md): Create a new role in organization
- [Post apiv2orgs roles duplicate](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/post-apiv2orgs-roles-duplicate.md): Duplicate a role
- [Post apiv2orgs roles scopes](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/post-apiv2orgs-roles-scopes.md): Add scopes to role
- [Post apiv2orgs rolesassignmentsuser](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/post-apiv2orgs-rolesassignmentsuser.md): Assign system role to user at organization level
- [Post apiv2projects rolesassignmentsgroup](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/post-apiv2projects-rolesassignmentsgroup.md): Create or update project role assignment for group (upsert)
- [Post apiv2projects rolesassignmentsuser](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/post-apiv2projects-rolesassignmentsuser.md): Create or update project role assignment for user (upsert)
- [Put apiv2projects parameters](https://lightdash-docs-scripts-cicd.mintlify.app/api-reference/v2/put-apiv2projects-parameters.md)
- [The Lightdash way: data access](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/contact/contact-info.md): There are a few ways you can get in touch with the team. Here's which one to use depending on your situation:
- [FAQs](https://lightdash-docs-scripts-cicd.mintlify.app/contact/faqs.md)
- [Migrating to dbt 1.10: Fix Meta and Tags Configuration Warnings](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/get-started/develop-in-lightdash/adding-tables-to-lightdash.md)
- [How to create dimensions](https://lightdash-docs-scripts-cicd.mintlify.app/get-started/develop-in-lightdash/how-to-create-dimensions.md)
- [How to create metrics](https://lightdash-docs-scripts-cicd.mintlify.app/get-started/develop-in-lightdash/how-to-create-metrics.md)
- [Developing in Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/get-started/exploring-data/dashboards.md)
- [Exploring your content](https://lightdash-docs-scripts-cicd.mintlify.app/get-started/exploring-data/exploring-your-content.md)
- [Using dashboards](https://lightdash-docs-scripts-cicd.mintlify.app/get-started/exploring-data/interactive-dashboards.md)
- [Learning to explore data in Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/get-started/exploring-data/intro-metrics-dimensions.md)
- [Sharing with your team](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/get-started/exploring-data/using-explores.md)
- [Update your project connection](https://lightdash-docs-scripts-cicd.mintlify.app/get-started/setup-lightdash/connect-project.md)
- [Create your first project](https://lightdash-docs-scripts-cicd.mintlify.app/get-started/setup-lightdash/get-project-lightdash-ready.md)
- [Setting up a new project](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/ai-agents/agent-memory.md): How AI agents learn from your corrections and feedback
- [Best practices for AI agents](https://lightdash-docs-scripts-cicd.mintlify.app/guides/ai-agents/best-practices.md): Learn how to configure and optimize your AI agents for the best results
- [Data access control](https://lightdash-docs-scripts-cicd.mintlify.app/guides/ai-agents/data-access.md): Understand how AI agents access and use your data
- [Evaluations](https://lightdash-docs-scripts-cicd.mintlify.app/guides/ai-agents/evaluations.md): Test and validate your AI agent's performance with custom evaluation suites
- [Getting started with AI agents](https://lightdash-docs-scripts-cicd.mintlify.app/guides/ai-agents/getting-started.md): Learn how to create and configure your first AI agent in Lightdash
- [Self-improvement (Beta)](https://lightdash-docs-scripts-cicd.mintlify.app/guides/ai-agents/self-improvement.md): Enable AI agents to improve your semantic layer automatically
- [Using AI agents](https://lightdash-docs-scripts-cicd.mintlify.app/guides/ai-agents/using-ai-agents.md): Learn how to interact with AI agents in Lightdash and Slack
- [Verified Answers](https://lightdash-docs-scripts-cicd.mintlify.app/guides/ai-agents/verified-answers.md): Train your AI agent with high-quality examples for better, more consistent responses
- [Automate with CI/CD](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/cli/cli-authentication.md)
- [Autogenerate Lightdash-ready YAML files for your models](https://lightdash-docs-scripts-cicd.mintlify.app/guides/cli/how-to-auto-generate-schema-files.md): The beauty of Lightdash is that we're pretty well synced with your dbt project. So, in Lightdash, Tables actually come from dbt models that have been defined in your dbt project's `.yml` files.
- [How to install the Lightdash CLI](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/cli/how-to-upgrade-cli.md)
- [Deploy changes to production](https://lightdash-docs-scripts-cicd.mintlify.app/guides/cli/how-to-use-lightdash-deploy.md)
- [Preview local changes](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/configure-charts.md): Learn about the configuration options available for most chart types in Lightdash.
- [Using custom fields](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/custom-tooltip.md)
- [Caching](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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.
- [Creating tailored tables from a single dbt model](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/developer/filtering-dashboard-in-url.md)
- [Preview projects](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/developer/renaming-models-and-fields.md)
- [SQL runner](https://lightdash-docs-scripts-cicd.mintlify.app/guides/developer/sql-runner.md): The SQL runner is used to build ad-hoc queries or charts using totally custom SQL.
- [How to use parameters](https://lightdash-docs-scripts-cicd.mintlify.app/guides/developer/using-parameters.md)
- [Validating your content](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/developer/vs-code-yaml-validation.md)
- [How to Embed Charts](https://lightdash-docs-scripts-cicd.mintlify.app/guides/embedding/charts.md): Learn how to embed individual Lightdash charts with minimal UI for focused, single-metric displays
- [How to Embed Dashboards](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/formatting-your-fields.md)
- [Alerts](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/keyboard-shortcuts.md): Speed up your workflow with keyboard shortcuts in Lightdash
- [Lightdash semantic layer](https://lightdash-docs-scripts-cicd.mintlify.app/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.
- [Using Filters](https://lightdash-docs-scripts-cicd.mintlify.app/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.
- [Spotlight](https://lightdash-docs-scripts-cicd.mintlify.app/guides/metrics-catalog.md): Spotlight 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.
- [How to do period-over-period analysis in Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/guides/period-over-period.md): Learn how to do period-over-period analysis in Lightdash with examples and best practices.
- [Table calculations](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/table-calculations/sql-templates.md): Use our SQL templates to get started with your table calculations!
- [Percent change from previous](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/table-calculations/table-calculation-sql-templates/percent-of-previous-value.md)
- [Percent of column total](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/guides/using-slack-integration.md)
- [Chart version history](https://lightdash-docs-scripts-cicd.mintlify.app/guides/version-history.md): You can easily roll back to previous versions of charts in Lightdash.
- [Welcome to Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/introduction.md): Lightdash instantly turns your dbt project into a full-stack BI platform.
- [Lightdash Admin References](https://lightdash-docs-scripts-cicd.mintlify.app/references/admin.md): Below are reference docs for all admin functions and features in Lightdash.
- [Area chart](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/big-value.md): Use big value charts to display a single value prominently.
- [Custom charts](https://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/custom-charts.md): Custom charts are available in Beta for those that want 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…
- [Funnel chart](https://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/funnel-chart.md): Use funnel charts to show pipeline performance, product conversion metrics, or any process with discrete stages.
- [Gauge](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/line-chart.md): Use line charts to show changes in a number over a short or long period of time.
- [Map (Beta)](https://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/map.md): Use maps to display geographic data on an interactive map.
- [Mixed chart](https://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/mixed-chart.md): Use mixed charts to combine bars, lines, and scatter charts on the same visualization.
- [Chart types overview](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/pie-chart.md): Use pie charts to visualize data that adds up to a meaningful whole.
- [Scatter chart](https://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/scatter-chart.md): Use scatter charts to look at the relationship or correlation between two variables.
- [Table](https://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/table.md): Use tables for looking at tabular data or lists of things like user IDs or transactions.
- [Treemap chart](https://lightdash-docs-scripts-cicd.mintlify.app/references/chart-types/treemap-chart.md): Use treemap charts to show parts of a whole using nested rectangles.
- [Dimensions reference](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/embedding.md): Complete API reference for embedding Lightdash content securely using JWTs
- [Embedding with iframe](https://lightdash-docs-scripts-cicd.mintlify.app/references/iframe-embedding.md): Complete reference for embedding Lightdash content using iframes with JWTs in URL hash fragments
- [Lightdash Integration Reference Docs](https://lightdash-docs-scripts-cicd.mintlify.app/references/integrations.md): Reference docs for all integrations available on Lightdash.
- [dbt Projects](https://lightdash-docs-scripts-cicd.mintlify.app/references/integrations/dbt-projects.md): You can easily make changes in dbt and see them updated in your Lightdash project.
- [Google Sheets](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/integrations/lightdash-mcp.md)
- [Slack integration](https://lightdash-docs-scripts-cicd.mintlify.app/references/integrations/slack-integration.md): Below is everything you need to know about the Lightdash Slack integration.
- [Joins reference](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/lightdash-config-yml.md): The lightdash.config.yml file allows you to configure project-wide settings for your Lightdash project, including spotlight and parameters.
- [Metrics reference](https://lightdash-docs-scripts-cicd.mintlify.app/references/metrics.md)
- [Organization credentials](https://lightdash-docs-scripts-cicd.mintlify.app/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.
- [Embedding with React SDK](https://lightdash-docs-scripts-cicd.mintlify.app/references/react-sdk.md): Reference documentation for the Lightdash React SDK for seamless embedding in React applications
- [SQL variables](https://lightdash-docs-scripts-cicd.mintlify.app/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
- [Tables reference](https://lightdash-docs-scripts-cicd.mintlify.app/references/tables.md): You can run queries against the tables in your Lightdash project.
- [Add the Slack integration](https://lightdash-docs-scripts-cicd.mintlify.app/references/workspace/adding-slack-integration.md)
- [Custom Roles](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/workspace/customizing-the-appearance-of-your-project.md)
- [Feature Maturity Levels](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/workspace/personal-tokens.md)
- [Personal warehouse connections](https://lightdash-docs-scripts-cicd.mintlify.app/references/workspace/personal-warehouse-connections.md): Learn when and how personal warehouse credentials are used in Lightdash projects.
- [Pinning](https://lightdash-docs-scripts-cicd.mintlify.app/references/workspace/pinning.md)
- [Project compilation history](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/references/workspace/roles.md)
- [SCIM Integration](https://lightdash-docs-scripts-cicd.mintlify.app/references/workspace/scim-integration.md)
- [Service accounts](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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.
- [Usage analytics](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/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.
- [Configure a Slack integration for self-hosted Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/configure-a-slack-app-for-lightdash.md)
- [Configure a Github integration for self-hosted Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/configure-github-for-lightdash.md)
- [Configure Lightdash to use an external database](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/configure-lightdash-to-use-an-external-database.md)
- [Configure Lightdash to use external storage](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/configure-lightdash-to-use-external-object-storage.md)
- [Configure logging for Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/configure-logging-for-lightdash.md)
- [Configure Prometheus metrics for self-hosted Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/configure-prometheus-metrics-for-self-hosted-lightdash.md)
- [Configure SMTP for Lightdash email notifications](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/configure-smtp-for-lightdash-email-notifications.md)
- [Configure a standalone scheduler worker for self-hosted Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/configure-standalone-scheduled-worker.md)
- [Add headless browser on self-hosting](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/enable-scheduler-in-self-hosted-lightdash.md)
- [Enterprise License Keys](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/enterprise-license-keys.md): Access enterprise features on self-hosted Lightdash instances
- [Environment variables](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/environment-variables.md)
- [Configure a Google Sheets integration for self-hosted Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/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 Google Sheets on `charts` on your on self-hosted Lightdash server.
- [Resource recommendations](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/recommended-resources.md): The recommended resource requests for each Lightdash component are as follows
- [Secure Lightdash with HTTPS](https://lightdash-docs-scripts-cicd.mintlify.app/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://lightdash-docs-scripts-cicd.mintlify.app/self-host/customize-deployment/use-sso-login-for-self-hosted-lightdash.md)
- [Lightdash Cloud vs. Self-Hosted](https://lightdash-docs-scripts-cicd.mintlify.app/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.
- [Self-Host Lightdash](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/self-host-lightdash.md)
- [Self-host Lightdash using docker compose](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/self-host-lightdash-docker-compose.md)
- [Self-Host Lightdash with Restack](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/self-host-lightdash-restack.md)
- [Updating Lightdash to the latest version](https://lightdash-docs-scripts-cicd.mintlify.app/self-host/update-lightdash.md)

## OpenAPI Specs

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

## Optional

- [About Us](https://www.lightdash.com/about)
- [Community](https://join.slack.com/t/lightdash-community/shared_invite/zt-2wgtavou8-VRhwXI~QbjCAHQs0WBac3w)
- [Blog](https://www.lightdash.com/blog)