# Databrain

## Docs

- [Product changelog](https://docs.usedatabrain.com/changelog/product-changelog.md)
- [Self hosted changelog](https://docs.usedatabrain.com/changelog/self-hosted-changelog.md)
- [Getting Started](https://docs.usedatabrain.com/developer-docs.md): How to Seamlessly Embed a DataBrain Dashboard
- [Token API v1 → v2 Migration](https://docs.usedatabrain.com/developer-docs/api-migration-guide.md): Guide for migrating existing integrations for generating token from API v1 to v2, covering differences, deprecations, and implementation steps.
- [Step 1: Create Datamart and Workspace](https://docs.usedatabrain.com/developer-docs/chat-mode/step-1-create-datamart-and-workspace.md): To utilize chat mode in your embed, you need to first create a datamart assuming you already created a data source.
- [Step 2: Create Data App and Embed ID](https://docs.usedatabrain.com/developer-docs/chat-mode/step-2-create-data-app-and-embed-id.md): Configure a data app with AI Chat Mode by enabling access control, setting up semantic layer integration, and generating embed credentials for chat-enabled analytics.
- [Self-Hosted Deployment Verification](https://docs.usedatabrain.com/developer-docs/deployment-verification.md): Use this Docker image to verify your self-hosted application. It runs a comprehensive verification script to ensure your deployment is successful.
- [Embed using iFrame (Not Recommended approach)](https://docs.usedatabrain.com/developer-docs/embed-using-iframe-not-recommended-approach.md): You can embed the dashboard or metric using iFrame in your app.
- [Architecture Deep Dive](https://docs.usedatabrain.com/developer-docs/embedding-setup/architecture-deep-dive.md): Technical deep-dive into DataBrain's embedding architecture, authentication, performance, and deployment patterns
- [Production-Ready Embedding Guide](https://docs.usedatabrain.com/developer-docs/embedding-setup/step-by-step-guide.md): Complete step-by-step guide to embedding DataBrain dashboards in production
- [Angular](https://docs.usedatabrain.com/developer-docs/framework-specific-guide/angular.md)
- [Nextjs](https://docs.usedatabrain.com/developer-docs/framework-specific-guide/nextjs.md)
- [Reactjs](https://docs.usedatabrain.com/developer-docs/framework-specific-guide/reactjs.md)
- [Solid](https://docs.usedatabrain.com/developer-docs/framework-specific-guide/solid.md)
- [Svelte](https://docs.usedatabrain.com/developer-docs/framework-specific-guide/svelte.md)
- [Vanilla JS](https://docs.usedatabrain.com/developer-docs/framework-specific-guide/vanillajs.md)
- [Vuejs](https://docs.usedatabrain.com/developer-docs/framework-specific-guide/vuejs.md)
- [Admin Authentication Flow](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/admin-authentication-flow.md): Understand the complete flow for setting up and managing admin authentication on self-hosted Databrain instances.
- [Fetch Dashboards by Workspace](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/cloud-databrain-endpoint.md): Retrieve a list of dashboards available in a workspace with optional pagination support.
- [Create Admin Account (Self-Hosted)](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-admin-account.md): Create the first admin account for your self-hosted Databrain instance. Returns an access token for the new admin. Self-hosted only.
- [Create Admin JWT (Self-Hosted)](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-admin-jwt.md): Sign in as an admin and receive a JWT access token for self-hosted Databrain. Use this token for service token and admin APIs. Self-hosted only.
- [Create API Token for Data App](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-api-token.md): Generate a new API token for a specific Data App to enable embed operations.
- [Create an Empty Dashboard Embed](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-dashboard-embed.md): Create a new empty dashboard for multi-tenant scenarios where each client gets their own blank canvas.
- [Create Data App](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-data-app.md): Create a new Data App to organize and manage your embedded analytics.
- [Create Datamart](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-datamart.md): Create a new datamart to organize and manage your data sources with custom table and column configurations.
- [Create Datasource](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-datasource.md): Create a new datasource connection to your data infrastructure. Supports multiple database types and cloud services.
- [Embed a Pre-built Dashboard/Metric](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-embed.md): Create an embed for an existing dashboard or metric that was built by your data analyst.
- [Create Semantic Layer](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-semantic-layer.md): Create a semantic layer for a datamart by adding table descriptions, column metadata, and feedback.
- [Create Service Token (Self-Hosted)](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-service-token.md): Create or save a service token for your self-hosted Databrain instance. Available only on self-hosted deployments.
- [Create Workspace](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/create-workspace.md): Create a new workspace with datasource, datamart, multi-datasource, or multi-datamart configuration to organize your analytics environment.
- [Data App Embedding APIs](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api.md): Retrieve dashboards and metrics from datapps
- [Datamart API](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/datamart-api.md)
- [Delete Data App](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/delete-data-app.md): Permanently delete a Data App and all its associated resources.
- [Delete Datamart](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/delete-datamart.md): Delete a datamart from your organization. This action cannot be undone.
- [Delete Datasource](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/delete-datasource.md): Delete a datasource from your organization. This action cannot be undone and will remove all associated configurations.
- [Delete an Embed](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/delete-embed.md): Delete an embed from your data app. This action cannot be undone.
- [Delete Semantic Layer](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/delete-semantic-layer.md): Delete the semantic layer from a datamart, removing all descriptions, synonyms, column types, and feedback.
- [Delete Workspace](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/delete-workspace.md): Permanently delete a workspace from your organization by name.
- [Embed Data App API (CRUD)](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/embed-data-app-crud.md)
- [Embedding APIs](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/embedding-apis.md): Retrieve dashboards and metrics from workspaces
- [Export Dashboard](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/export-dashboard.md): Export a dashboard from a workspace as a JSON file for backup, migration, or import into another workspace.
- [Export Embedded Dashboard](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/export-embed.md): Export the dashboard and configuration behind a data app embed using a data app API token.
- [Fetch Dashboards by Data App](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/fetch-dashboards-by-datapp.md): Retrieve a list of dashboards available in your data app with optional filtering and pagination.
- [Fetch metric data by data app](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/fetch-metric-data-by-dataapp.md): Execute queries on metrics within your embedded dashboards and retrieve the resulting data.
- [Fetch Metrics by Embed and Client](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/fetch-metrics-by-embed-and-client.md): Retrieve metrics available for a specific embed configuration and client, with support for pagination and client-specific filtering.
- [Fetch Metrics by Workspace](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/fetch-metrics-by-workspace.md): Retrieve metrics from a workspace with optional pagination support.
- [Get AWSS3 sync Progress status](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/get-awss3-sync-progress-status.md)
- [Get Semantic Layer](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/get-semantic-layer.md): Retrieve the semantic layer configuration for a datamart, including table descriptions, column metadata, and completion score.
- [Import Dashboard](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/import-dashboard.md): Import a dashboard from a previously exported JSON payload into a workspace.
- [List API Tokens for Data App](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/list-api-tokens.md): Retrieve a list of all API tokens associated with a specific Data App.
- [List Data Apps](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/list-data-apps.md): Retrieve a list of all Data Apps in your organization with their embed configurations.
- [List Datamarts](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/list-datamarts.md): Retrieve a list of all datamarts in your data app with their configurations and access settings.
- [List Datasources](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/list-datasources.md): Retrieve a list of all datasources in your organization. Supports optional pagination for large datasets.
- [List All Embeds](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/list-embed.md): Fetch a list of all embeds created by the authenticated data app.
- [List Schedule Reports by Embed](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/list-schedule-reports-by-embed.md): Retrieve scheduled email reports for a specific embed configuration, with support for pagination and filtering by client or user identifier.
- [List Workspaces](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/list-workspaces.md): Retrieve all workspaces in your organization with optional pagination support for efficient data retrieval.
- [Proxy Authentication](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/proxy-authentication.md): Configure a proxy server to securely forward requests to your Databrain backend with authentication.
- [Publish/Unpublish Metric](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/publish-metric.md): Publish or unpublish metrics in an embed configuration to control which metrics are visible to end users.
- [Rename an Embed](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/rename-embed.md): Rename an existing embed and optionally its underlying dashboard, without changing its access settings.
- [Reset Admin Password (Self-Hosted)](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/reset-admin-password.md): Change the password for the currently authenticated admin user on a self-hosted Databrain instance. Self-hosted only.
- [Rotate API Key](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/rotate-api-key.md): Rotate your Data App API key to enhance security and manage key lifecycle effectively.
- [Rotate Service Token](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/rotate-service-token.md): Rotate your service token. Expires the current token after an optional grace period and returns a new token.
- [Semantic Layer API](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/semantic-layer-api.md)
- [SMTP Settings](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/smtp-settings.md): Configure SMTP settings for your data app so scheduled reports can be sent by email.
- [Sync Datasource](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/sync-datasource.md)
- [Guest Token](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/token.md): Generate secure guest tokens for embedding DataBrain dashboards and metrics in your application.
- [Update Data App](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/update-data-app.md): Update the name and settings of an existing Data App.
- [Update Datamart](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/update-datamart.md): Update an existing datamart's table configurations and tenancy settings without recreating from scratch.
- [Update Datasource](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/update-datasource.md): Update the credentials and configuration of an existing datasource. The API validates and tests the new credentials before applying changes.
- [Update an Embed](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/update-embed.md): Update an existing embed to modify access settings, permissions, and datamart associations.
- [Update Semantic Layer](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/update-semantic-layer.md): Update the semantic layer for a datamart by modifying table descriptions, column metadata, or feedback.
- [Update Workspace](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/update-workspace.md): Update an existing workspace's connection settings to change datasource, datamart, multi-datasource, or multi-datamart configuration.
- [Whitelist Domains](https://docs.usedatabrain.com/developer-docs/helpers/api-reference/whitelist-domains.md): Retrieve or update the list of domains allowed to embed your data app (GET to list, PUT to update).
- [API Token](https://docs.usedatabrain.com/developer-docs/helpers/api-token.md): Generating API Token in DataBrain
- [Component Options Reference](https://docs.usedatabrain.com/developer-docs/helpers/component-options-reference.md): Comprehensive reference guide for all available options and properties for Databrain web components
- [Dashboard App Filter](https://docs.usedatabrain.com/developer-docs/helpers/dashboard-app-filter.md): Dashboard App Filter: Instruction Manual
- [Dashboard id](https://docs.usedatabrain.com/developer-docs/helpers/dashboard-id.md): Accessing Dashboard ID
- [Embed Functions](https://docs.usedatabrain.com/developer-docs/helpers/embed-functions.md): You can add your own buttons with embed functions.
- [End User Dashboard Creation](https://docs.usedatabrain.com/developer-docs/helpers/end-user-dashboard-creation.md): Description of your new file.
- [End User Metric Creation](https://docs.usedatabrain.com/developer-docs/helpers/end-user-metric-creation.md)
- [LLM Architecture](https://docs.usedatabrain.com/developer-docs/helpers/llm-architecture.md): Architecture of flow of information.
- [LLM Connectors](https://docs.usedatabrain.com/developer-docs/helpers/llm-connectors.md): Getting Started with Configuring Popular LLMs with DataBrain
- [Azure Open AI](https://docs.usedatabrain.com/developer-docs/helpers/llm-connectors/azure-open-ai.md)
- [Claude AI](https://docs.usedatabrain.com/developer-docs/helpers/llm-connectors/claude-ai.md)
- [Gemini](https://docs.usedatabrain.com/developer-docs/helpers/llm-connectors/gemini.md)
- [Llama](https://docs.usedatabrain.com/developer-docs/helpers/llm-connectors/llama.md)
- [Mixtral](https://docs.usedatabrain.com/developer-docs/helpers/llm-connectors/mixtral.md)
- [Open AI](https://docs.usedatabrain.com/developer-docs/helpers/llm-connectors/open-ai.md)
- [Metric App Filter](https://docs.usedatabrain.com/developer-docs/helpers/metric-app-filter.md): Metric App Filter: Instruction Manual
- [Metric ID](https://docs.usedatabrain.com/developer-docs/helpers/metric-id.md): Accessing the Metric ID
- [Options](https://docs.usedatabrain.com/developer-docs/helpers/options.md): The extra options/parameters that you can pass for your Web Component.
- [Custom Fiscal Year filter setup in DataBrain](https://docs.usedatabrain.com/developer-docs/helpers/options/custom-fiscal-year-filter-setup-in-databrain.md): Step-by-step guide to set up an Indian Fiscal Year filter in DataBrain for region-specific data analysis.
- [Override Language](https://docs.usedatabrain.com/developer-docs/helpers/override-language.md): The `@databrainhq/plugin` package allows you to customize the language of your embedded components by passing a translation dictionary and specifying the desired language.
- [Server Event](https://docs.usedatabrain.com/developer-docs/helpers/server-event.md): It is a function prop that detects and retrieves error or loading occurring within dashboard component, facilitating timely resolution and enabling various automated tasks to be triggered in response.
- [Token Body](https://docs.usedatabrain.com/developer-docs/helpers/token-body.md): Here you will see what are the fields to pass in the body while creating a guest token.
- [Translate](https://docs.usedatabrain.com/developer-docs/helpers/translate.md): The plugin components support multilingual translations using the language and translationDictionary props. This allows you to render metric titles, descriptions, and labels in the end user
- [Workspace name](https://docs.usedatabrain.com/developer-docs/helpers/workspace-name.md): Accessing and Editing Workspace Name
- [How to embed?](https://docs.usedatabrain.com/developer-docs/how-to-embed.md): Learn how to create a data app, generate API tokens, and create guest tokens for embedding Databrain dashboards in your application.
- [License Key Validation for Self-Hosted App](https://docs.usedatabrain.com/developer-docs/license-key-validation-for-self-hosted-app.md): This guide is essential for self-hosted app users, detailing the process of license key validation and renewal.
- [Client Setup](https://docs.usedatabrain.com/developer-docs/mcp-server/client-setup.md): Detailed configuration instructions for each AI client
- [MCP Server](https://docs.usedatabrain.com/developer-docs/mcp-server/overview.md): Add embedded analytics to your app using natural language. Connect the Databrain MCP server to any AI assistant and describe what you want.
- [Prompts Reference](https://docs.usedatabrain.com/developer-docs/mcp-server/prompts-reference.md): All 10 guided prompts available in the Databrain MCP server
- [Quickstart](https://docs.usedatabrain.com/developer-docs/mcp-server/quickstart.md): Get the Databrain MCP server running in 2 minutes
- [Tools Reference](https://docs.usedatabrain.com/developer-docs/mcp-server/tools-reference.md): All 24 tools available in the Databrain MCP server
- [Troubleshooting](https://docs.usedatabrain.com/developer-docs/mcp-server/troubleshooting.md): Common issues and solutions for the Databrain MCP server
- [Workflows](https://docs.usedatabrain.com/developer-docs/mcp-server/workflows.md): Step-by-step guides for the most common MCP server use cases
- [Multi-Tenant Access Control](https://docs.usedatabrain.com/developer-docs/multi-tenant-access-control.md): For your multi-tenant database architectures, establish atomic access controls through row-level policies (Database Tenancy & Table Tenancy), configurable in the Client Settings of our data source settings.
- [5-Minute Embedding Tutorial](https://docs.usedatabrain.com/developer-docs/quick-start/embedding-tutorial.md): Get your first DataBrain dashboard embedded in 5 minutes
- [Rate Limiting Configuration](https://docs.usedatabrain.com/developer-docs/rate-limiting.md): Configure API rate limits for your self-hosted DataBrain deployment to balance security and performance
- [Security & Compliance](https://docs.usedatabrain.com/developer-docs/security.md): How DataBrain keeps your data secure and helps you meet compliance requirements
- [ Self Hosted Config](https://docs.usedatabrain.com/developer-docs/self-hosted-config.md): When self hosted version of the app is used, the app needs to use these settings during embedding.
- [Self-Hosted Health Checks & Probes](https://docs.usedatabrain.com/developer-docs/self-hosted-health-checks.md): How to configure liveness/readiness probes and health checks for self-hosted Databrain (Kubernetes and Docker), including graceful shutdown (SIGTERM) behavior.
- [Dashboard for Multiple Clients](https://docs.usedatabrain.com/developer-docs/solutions-alchemy/dashboard-for-multiple-clients.md): One universal dynamic dashboard for multiple clients
- [Dashboards for Client Groups](https://docs.usedatabrain.com/developer-docs/solutions-alchemy/dashboards-for-client-group.md): Segmenting Dashboards based on user accounts/client groups.
- [Embedding: Role based Dashboard Filtering](https://docs.usedatabrain.com/developer-docs/solutions-alchemy/embedding-role-based-dashboard-filtering.md): Dashboard Filtered based on the user role.
- [Timezone Handling in Guest Token](https://docs.usedatabrain.com/developer-docs/solutions-alchemy/guest-token-timezone.md): Pass a timezone parameter when generating a guest token to ensure SQL queries run in the correct timezone and date/time fields are consistently formatted across regions.
- [Localized Currency Symbols](https://docs.usedatabrain.com/developer-docs/solutions-alchemy/localized-currency-symbols.md): This guide provides a practical approach for utilizing Dynamic Property to dynamically display revenue in multiple currencies for different countries.
- [Manage Metrics](https://docs.usedatabrain.com/developer-docs/solutions-alchemy/manage-metrics.md): Allow end user to manage metrics from embedded dashboard.
- [Troubleshooting Guide](https://docs.usedatabrain.com/developer-docs/testing/troubleshooting.md): Common issues and solutions for embedded DataBrain dashboards
- [Token](https://docs.usedatabrain.com/developer-docs/token.md)
- [Create and Access Your Databrain Account](https://docs.usedatabrain.com/getting-started/account-setup.md): Follow this quick guide to sign up for a new Databrain account or sign in to your existing one.
- [Dashboards](https://docs.usedatabrain.com/getting-started/core-concepts/dashboards.md): Create interactive analytics dashboards to visualize your data
- [Data Apps](https://docs.usedatabrain.com/getting-started/core-concepts/data-apps.md): Package dashboards and metrics for embedding in your application
- [Datamarts](https://docs.usedatabrain.com/getting-started/core-concepts/datamarts.md): Create optimized data models for analytics and AI-powered insights
- [Embedding Architecture](https://docs.usedatabrain.com/getting-started/core-concepts/embedding-architecture.md): Understanding DataBrain's embedding architecture and how it works
- [Metrics](https://docs.usedatabrain.com/getting-started/core-concepts/metrics.md): Build individual visualizations and KPIs to power your dashboards
- [Workspaces](https://docs.usedatabrain.com/getting-started/core-concepts/workspaces.md): Organize your analytics projects with workspaces
- [Dashboard Customization](https://docs.usedatabrain.com/getting-started/dashboard-customization.md): Learn how to customize your dashboard layout, add new elements, and manage metrics in Databrain.
- [Welcome to DataBrain](https://docs.usedatabrain.com/getting-started/introduction.md): Embed powerful analytics dashboards into your application in minutes
- [Invite Users ](https://docs.usedatabrain.com/getting-started/invite-users.md): Learn how to configure invite users in both app and self-hosted environments.
- [Metric Customization](https://docs.usedatabrain.com/getting-started/metric-creation.md): Learn how to customize metrics in DataBrain dashboards by switching axes, grouping data, drilling down, and configuring chart click actions.
- [Adding Elements to Dashboard](https://docs.usedatabrain.com/guides/dashboards/adding-elements-to-dashboard.md): This guide provides a straightforward approach to enhancing your dashboard by adding new elements, which can improve data visualization and user engagement.
- [Boards](https://docs.usedatabrain.com/guides/dashboards/boards.md): Boards allow you to save multiple configurations of a dashboard based on applied dashboard metric filters, and switch axis. You can then quickly switch between these saved boards without re-applying filters every time.
- [Create/Modify Dashboard Filter](https://docs.usedatabrain.com/guides/dashboards/create-modify-dashboard-filter.md): Dashboard filters allow for more precise data viewing and analysis within your dashboard.
- [Add LHS and RHS custom sql support for dashboard filter](https://docs.usedatabrain.com/guides/dashboards/create-modify-dashboard-filter/add-lhs-and-rhs-custom-sql-support-for-dashboard-filter.md): This guide is essential for users looking to enhance their dashboard's filtering capabilities with custom SQL support.
- [Dashboard Filter - Variable Apply On](https://docs.usedatabrain.com/guides/dashboards/create-modify-dashboard-filter/dashboard-filter-variable-apply-on.md): In this page you can see the functioning of variable apply on method available in Dashboard Filters.
- [Customize Layout](https://docs.usedatabrain.com/guides/dashboards/customize-layout.md): Customizing the layout of metrics provides a tailored view to analyze data more effectively
- [Dashboard Settings](https://docs.usedatabrain.com/guides/dashboards/dashboard-settings.md): The dashboard settings offer various tools to enhance, manage, and customize your analytics experience.
- [Edit a Dashboard](https://docs.usedatabrain.com/guides/dashboards/edit-a-dashboard.md): This guide provides essential instructions for efficiently managing your dashboard, allowing you to customize it to better suit your needs.
- [Import/Export Dashboard](https://docs.usedatabrain.com/guides/dashboards/import-export-dashboard.md): This guide provides clear instructions for importing and exporting dashboards, offering two methods to streamline your workflow.
- [Schedule Reports For Internal Users](https://docs.usedatabrain.com/guides/dashboards/report-scheduler.md): This guide demonstrates how to create, schedule, and manage automated dashboard reports with flexible delivery options for users.
- [Share Dashboard](https://docs.usedatabrain.com/guides/dashboards/share-dashboard.md): Sharing dashboards allows for easy collaboration and data presentation.
- [Datadog Integration](https://docs.usedatabrain.com/guides/datadog-integration.md): Send OpenTelemetry traces, metrics, and logs from Databrain to Datadog
- [Allow Access to our IP](https://docs.usedatabrain.com/guides/datasources/allow-access-to-our-ip.md): Getting Started with Database IP Whitelisting for Databrain
- [Configure Tenants](https://docs.usedatabrain.com/guides/datasources/configure-tenants.md): After setting up a data source, the next step is to configure the organization details to tailor the analytics experience for your clients.
- [Amazon Redshift](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/amazon-redshift.md)
- [Amazon S3](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/amazon-s3.md)
- [Athena](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/athena.md): This guide will walk you through the steps to connect your Athena database to Databrain.
- [BigQuery](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/bigquery.md)
- [ClickHouse](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/clickhouse.md)
- [CockroachDB](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/cockroachdb.md)
- [CSV](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/csv.md)
- [DataBricks](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/databricks.md)
- [ElasticSearch](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/elasticsearch.md)
- [Firebolt](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/firebolt.md)
- [Connecting Data Sources to Databrain](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/index.md): Getting Started with Connecting Popular Data Sources with Databrain
- [MongoDB](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/mongoDB.md)
- [MSSQL](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/mssql.md)
- [MySQL](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/mysql.md)
- [OpenSearch](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/opensearch.md)
- [Postgres](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/postgres.md)
- [SingleStore](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/singlestore.md): This guide will walk you through the steps to connect your SingleStore database to Databrain.
- [Snowflake](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/snowflake.md)
- [Trino](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/trino.md)
- [Create Data App](https://docs.usedatabrain.com/guides/datasources/create-a-data-app.md): This guide provides a straightforward process for creating a Data App, catering to various integration needs such as demonstration, embedded applications, and popular collaboration platforms
- [Create a datamart](https://docs.usedatabrain.com/guides/datasources/create-a-datamart.md): This guide provides a straightforward process for creating a datamart in Databrain, allowing users to efficiently manage and analyze data.
- [Create Embed](https://docs.usedatabrain.com/guides/datasources/create-embed.md): Learn how to create embeds for your Data App so you can integrate Databrain into your product experience.
- [Creating a Custom Dataset/View in a Multi-Datasource Environment](https://docs.usedatabrain.com/guides/datasources/creating-a-custom-dataset-view-in-a-multi-datasource-environment.md): This guide provides essential steps for creating and saving a custom dataset in a multi-datasource environment, ensuring efficient and organized data management.
- [Edit tenancy](https://docs.usedatabrain.com/guides/datasources/edit-tenancy.md): This guide provides a straightforward approach to modifying tenancy settings within a datasource connection.
- [Generate API Key](https://docs.usedatabrain.com/guides/datasources/generate-api-key.md): Learn how to generate API keys for your Data App so you can authenticate API requests securely.
- [How to Sync a Data Source](https://docs.usedatabrain.com/guides/datasources/how-to-sync-a-datasource.md): This guide provides a straightforward, step-by-step approach to syncing a data source, ensuring users can efficiently manage their data connections.
- [Semantic Layer](https://docs.usedatabrain.com/guides/datasources/semantic-layer.md): This guide provides a comprehensive step-by-step process for building and managing a semantic layer in Databrain's Data Studio, making it essential for data professionals.
- [Elastic APM Integration](https://docs.usedatabrain.com/guides/elastic-apm-integration.md): Send OpenTelemetry traces, metrics, and logs from Databrain to Elastic APM
- [Custom SQL Console](https://docs.usedatabrain.com/guides/features/custom-sql-console.md)
- [Custom SQL Query Guidelines](https://docs.usedatabrain.com/guides/features/custom-sql-query-guidelines.md): This guide provides best practices for writing well-structured SQL queries to improve readability, maintainability, and performance.
- [Python Editor Console](https://docs.usedatabrain.com/guides/features/python-editor-console.md)
- [Python Query Guidelines](https://docs.usedatabrain.com/guides/features/python-query-guidelines.md): Best practices for writing clean, maintainable, and production-ready Python queries in Databrain.
- [Dashboard Filter](https://docs.usedatabrain.com/guides/filters/dashboard-filter.md): In this page we will explain you how you can create filters for the dashboard metrics
- [Metric Filter](https://docs.usedatabrain.com/guides/filters/metric-filter.md): A metric-level filter is a metric-specific filter that can be applied to a particular metric only and cannot reuse for other metrics.
- [What is Databrain?](https://docs.usedatabrain.com/guides/getting-started-with-databrain/what-is-databrain.md)
- [Grafana Cloud Integration](https://docs.usedatabrain.com/guides/grafana-cloud-integration.md): Send OpenTelemetry traces, metrics, and logs from Databrain to Grafana Cloud
- [Honeycomb Integration](https://docs.usedatabrain.com/guides/honeycomb-integration.md): Send OpenTelemetry traces, metrics, and logs from Databrain to Honeycomb
- [Get an guest token](https://docs.usedatabrain.com/guides/integrating-plugin/get-a-guest-token.md): This page will help you to get a guest token which you can use to access the dashboard metrics in your app using the databrain plugin.
- [Get an auth token](https://docs.usedatabrain.com/guides/integrating-plugin/get-an-auth-token.md): This page will help you get an auth token and use it to call databrain apis.
- [Kloudfuse integration](https://docs.usedatabrain.com/guides/kloudfuse-integration.md)
- [Quick start](https://docs.usedatabrain.com/guides/metric-component-upto-version-V0.11.15/quickstart.md): This will explain you how to use the databrain plugin and customization.
- [AI Summary](https://docs.usedatabrain.com/guides/metric/ai-summary.md): This guide provides a straightforward method for utilizing AI to generate concise summaries of metrics from your dashboard.
- [Overview](https://docs.usedatabrain.com/guides/metric/apply-metric-filter.md): Metric filters refine the data displayed on your metric cards, offering a more focused analysis.
- [Metric Filter - Custom](https://docs.usedatabrain.com/guides/metric/apply-metric-filter/metric-filter-custom.md): Create a Custom Dashboard/Metric Filter: Quick Instruction Manual
- [Metric Filter - Variable](https://docs.usedatabrain.com/guides/metric/apply-metric-filter/metric-filter-variable.md): Variable Filter in Metric Filter: Quick Instruction Manual
- [Archive/Unarchive Metric Card](https://docs.usedatabrain.com/guides/metric/archive-unarchive-metric-card.md): Manage your dashboard by archiving unused metric cards and retrieving them when needed.
- [Complex Filter](https://docs.usedatabrain.com/guides/metric/complex-filter.md): Complex Filter Feature: Quick Instruction Manual
- [Download Metric Card](https://docs.usedatabrain.com/guides/metric/download-metric-card.md): Access and save your metric card data in various formats for offline analysis or sharing.
- [Download Underlying Data](https://docs.usedatabrain.com/guides/metric/download-underlying-data.md): This guide provides a straightforward process for accessing and downloading underlying data from a dashboard, allowing users to analyse metrics in detail.
- [Dynamic Property](https://docs.usedatabrain.com/guides/metric/dynamic-property.md): This guide explains the process of using dynamic properties in metric creation. These properties can fetch dynamic values directly from the database, with dependencies on dashboard or metric filters.
- [Edit a Metric](https://docs.usedatabrain.com/guides/metric/edit-a-metric.md): This guide provides essential steps for effectively editing metrics in Databrain, allowing users to customize their dashboards to better reflect their data needs.
- [Footnote and Long Description](https://docs.usedatabrain.com/guides/metric/footnote-and-long-description.md): This guide provides essential instructions to enhance your dashboard cards with additional descriptive elements and to improve the overall communication and utility of your data visualizations.
- [Group By](https://docs.usedatabrain.com/guides/metric/group-by.md): This guide offers a straightforward method for organizing data by using the "Group By" feature, enhancing data analysis efficiency.
- [Joins , Filter, Sort, Group By](https://docs.usedatabrain.com/guides/metric/joins-filter-sort-groupby.md): Enhance and refine your metrics using various functionalities available.
- [Merge Metrics](https://docs.usedatabrain.com/guides/metric/merge-metrics.md): This guide provides a straightforward approach to customize your dashboard layout more dynamically by merging metric cards. This enhances readability and streamlines related metrics.
- [Metric Expression for Single Value Card](https://docs.usedatabrain.com/guides/metric/metric-expression-for-single-value-card.md): This guide is essential to enhance dashboards by leveraging Metric Expressions for single-value cards.
- [Metric Summary](https://docs.usedatabrain.com/guides/metric/metric-summary.md): This guide provides a straightforward process for creating metric summaries. These summaries can be added directly as text boxes within your dashboard, providing quick insights at a glance.
- [Section Filters](https://docs.usedatabrain.com/guides/metric/section-filters.md): This guide provides a straightforward approach to customizing your dashboard layout with section filters, allowing for a more tailored data analysis experience.
- [Switch X axis and Switch Y axis](https://docs.usedatabrain.com/guides/metric/switch-x-axis-and-switch-y-axis.md): This guide provides a straightforward method to easily switch the X and Y axes in your data visualization, enhancing your ability to analyse and interpret data from different perspectives.
- [View Unpublished Metrics](https://docs.usedatabrain.com/guides/metric/view-unpublished-metrics.md): Monitor and identify metrics that are in draft mode before they are published to dashboards. This guide provides step-by-step instructions to help you locate unpublished metrics in your workspace.
- [New Relic Integration](https://docs.usedatabrain.com/guides/newrelic-integration.md): Send OpenTelemetry traces, metrics, and logs from Databrain to New Relic
- [Observability Setup](https://docs.usedatabrain.com/guides/observability-setup.md): Configure logging and OpenTelemetry for monitoring your self-hosted Databrain instance
- [Add a Data Source](https://docs.usedatabrain.com/guides/onboarding-and-configuration/add-a-data-source.md): Data sources in Databrain enable users to fetch and manage data from various platforms efficiently. This guide walks you through the simple process of adding and configuring a new data source.
- [Choosing the Right Tenancy Model for Your Data](https://docs.usedatabrain.com/guides/onboarding-and-configuration/choosing-the-right-tenancy-model-for-your-data.md)
- [Create a Dashboard](https://docs.usedatabrain.com/guides/onboarding-and-configuration/create-a-dashboard.md): This guide provides a straightforward process for creating a private workspace. This feature enhances privacy and allows for focused work without visibility constraints.
- [Create a Metric](https://docs.usedatabrain.com/guides/onboarding-and-configuration/create-a-metric.md): Metrics offer detailed insights and visualization of your data within a dashboard. This guide provides a step-by-step process to create a Metric in Databrain.
- [Create a Metric using Chat Mode](https://docs.usedatabrain.com/guides/onboarding-and-configuration/create-a-metric/create-a-metric-using-chat-mode.md): This guide offers a streamlined process for creating a metric using Chat Mode, making it easy for users to visualize and customize their data effectively.
- [Create a Metric using Custom SQL](https://docs.usedatabrain.com/guides/onboarding-and-configuration/create-a-metric/create-a-metric-using-custom-sql.md): This guide provides a step-by-step approach to utilizing custom SQL for creating metrics, which can enhance your data analysis capabilities.
- [Create Calculated Fields](https://docs.usedatabrain.com/guides/onboarding-and-configuration/create-a-metric/create-custom-columns.md): This guide offers a straightforward approach to creating custom columns by utilizing calculated fields and SQL queries, enabling users to tailor their data analysis to specific needs.
- [Create a Private Workspace](https://docs.usedatabrain.com/guides/onboarding-and-configuration/create-a-private-workspace.md): This guide provides a straightforward process for creating a private workspace. This feature enhances privacy and allows for focused work without visibility constraints.
- [Create a Workspace](https://docs.usedatabrain.com/guides/onboarding-and-configuration/create-a-workspace.md): This guide provides a detailed process for creating a new workspace within the application. Follow these steps to set up a workspace tailored to your specific needs.
- [Explore Data](https://docs.usedatabrain.com/guides/onboarding-and-configuration/explore-data.md): This guide provides a overview of how to explore and manage data within the platform. It is used to easily navigate and familiarize with your tables with sort, filter, and search functionalities.
- [Forgot password? Recover your Databrain Account](https://docs.usedatabrain.com/guides/onboarding-and-configuration/forgot-password-recover-your-databrain-account.md): This guide offers a straightforward solution for users who have forgotten their Databrain account password, ensuring quick access to their accounts.
- [Google Sign In Setup for Self-hosted app](https://docs.usedatabrain.com/guides/onboarding-and-configuration/google-sign-in-setup-for-self-hosted-app.md): This guide provides essential instructions for accessing your Databrain account effortlessly using Google Sign-In for self-hosted app.
- [How to Invite Users?](https://docs.usedatabrain.com/guides/onboarding-and-configuration/how-to-invite-users.md): Learn how to invite users and configure email settings in both app and self-hosted environments.
- [Sign-In](https://docs.usedatabrain.com/guides/onboarding-and-configuration/sign-in.md): This guide provides essential instructions for accessing your Databrain account effortlessly.
- [Sign-Up](https://docs.usedatabrain.com/guides/onboarding-and-configuration/sign-up.md): This guide provides a straightforward process for signing up for Databrain.
- [SSO Login](https://docs.usedatabrain.com/guides/onboarding-and-configuration/sso-login.md): To enable Single Sign-On (SSO) for your application, you can integrate either a SAML or OIDC Identity Provider (IdP).
- [Oidc Identity Provider (Idp)](https://docs.usedatabrain.com/guides/onboarding-and-configuration/sso-login/oidc-identity-provider-idp.md)
- [Saml Identity Provider (Idp)](https://docs.usedatabrain.com/guides/onboarding-and-configuration/sso-login/saml-identity-provider-idp.md)
- [Workspace Settings](https://docs.usedatabrain.com/guides/onboarding-and-configuration/workspace-settings.md): This guide provides essential insights on customizing your workspace settings effectively. This ensures optional accessibility and control over your data.
- [Cache Settings](https://docs.usedatabrain.com/guides/onboarding-and-configuration/workspace-settings/cache-settings.md)
- [Configure General Settings](https://docs.usedatabrain.com/guides/onboarding-and-configuration/workspace-settings/general-settings.md)
- [Email Settings for Scheduled Reports](https://docs.usedatabrain.com/guides/preview-of-dashboards/email-settings-for-scheduled-reports.md): Configure email settings that appear during scheduled reports
- [Scheduled Reports for End User](https://docs.usedatabrain.com/guides/preview-of-dashboards/scheduled-reports-for-end-user.md): This guide provides a straightforward process for setting up scheduled email reports, ensuring that users can easily automate their reporting needs
- [Add Data Source → Build Dashboards & Metrics](https://docs.usedatabrain.com/guides/quick-start/add-a-data-source.md): This tutorial guides you through the initial Databrain setup workflow — connecting your database, configuring tenants, and creating dashboards and metrics to visualize your data.
- [SigNoz Integration](https://docs.usedatabrain.com/guides/signoz-integration.md): Send OpenTelemetry traces, metrics, and logs from Databrain to SigNoz (open-source observability)
- [Creating a theme](https://docs.usedatabrain.com/guides/themeing-and-customization/creating-a-theme.md): You can create a theme to choose how the Databrain Plugin in your application should look like
- [View the theme in action](https://docs.usedatabrain.com/guides/themeing-and-customization/view-the-theme-in-action.md): In this article, we will see how to check whether your saved theme is working or not.
- [Chart Actions](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-actions.md): Enhance your data visualization and analysis with these powerful chart customization features.
- [Card Click Action](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-actions/card-click-action.md): This guide offers a process for configuring card click actions in a dashboard. By following these steps, you can set up and utilize the card click action to navigate users to the specified routes.
- [Chart Click Action](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-actions/chart-click-action.md): This guide provides an approach to configuring interactive chart click. The elements or data points of the chart are now clickable, and the action will lead to the route configured by you.
- [Chart Click Action with metric](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-actions/chart-click-action-with-metric.md): This guide offers a straightforward approach to enhancing your data visualization experience by enabling and configuring chart click actions with metrics.
- [Cross Dashboard Drill Down](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-actions/cross-dashboard-drill-down.md): Enable cross-dashboard drill-down to filter all metrics on a dashboard based on a drilled dimension, providing interconnected analysis across your entire dashboard.
- [Drill Down](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-actions/drill-down.md): Explore detailed insights within your charts by drilling down into specific dimensions for a more granular analysis.
- [Chart Appearance](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-appearance.md): Personalize your metric charts with an array of appearance settings for clarity and visual appeal.
- [Chart-Specific Appearance Options](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-appearance/chart-specific-appearance-options.md): This guide presents appearance options for similar charts and key insights into customizing common chart types, improving data presentation and clarity.
- [Axis Charts (Line, Bar, Stack, Row, Area, Stepped)](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/axis-charts.md): Set up Line, Bar, Stack, Row, Area, and Stepped charts with dimensions and measures.
- [Boxplot Chart](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/boxplot.md): Set up a Boxplot chart for distribution and quartile visualization.
- [Bubble Chart V2](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/bubble-chart-v2.md): Bubble Chart V2 lets you control bubble size using a measure. Learn when it's available, data requirements, and why it might be disabled.
- [Bullet Chart](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/bullet.md): Set up a Bullet chart for target vs actual comparison.
- [Circular Charts (Pie, Doughnut, Rose)](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/circular-charts.md): Set up Pie, Doughnut, and Rose charts with dimension and measure.
- [Combo Chart (Bar + Line)](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/combo-chart.md): Set up Combo, Horizontal Combo, and Vertical Combo charts with bar and line series.
- [Funnel, Sankey, and Waterfall Charts](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/funnel-sankey-waterfall.md): Set up Funnel, Funnel V2, Sankey, Waterfall, and Waterfall V2.
- [Gantt Chart](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/gantt.md): Set up a Gantt chart for task timelines.
- [Gauge, Progress Bar, and Linear Gauge](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/gauge-progress-linear-gauge.md): Set up Gauge V2, Progress Bar, Progress Bar V2, Linear Gauge, and Linear Gauge V2 for single-value KPIs.
- [How to Create a Histogram](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/histogram.md): Create histograms using the Histogram chart type or a bar chart with numeric dimensions and binning.
- [Hybrid Bar Chart](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/hybrid-bar.md): Set up a Hybrid Bar chart with mixed stacked and non-stacked bars.
- [Map Charts](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/maps.md): Set up World Map, Indian States, Geo Map, Geo Map with Bar, and Geo Map with Scatter.
- [Network Chart](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/network.md): Set up a Network chart for node and link visualization.
- [Chart Setup Overview](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/overview.md): How to set up each chart type in Databrain. Data requirements, axis assignment, and chart-specific settings.
- [Pivot Table](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/pivot-table.md): Set up Pivot Table, Pivot Table 2, and Pivot Table 3.
- [Scatter and Bubble Charts](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/scatter-bubble.md): Set up Scatter and Bubble (V1) charts. For Bubble V2 with measure-based size, see Bubble Chart V2.
- [Single Value (KPI Card)](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/single-value.md): Set up a Single Value card for KPIs, with optional metric expression and comparison.
- [Table and Horizontal Stack Table](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/table-advanced.md): Set up Table and Horizontal Stack Table charts.
- [Time Series Chart](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/time-series.md): Set up a Time Series chart with date dimension and measures.
- [Tree Map](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/tree-map.md): Set up a Tree Map chart for hierarchical breakdown.
- [Trend Analyzer](https://docs.usedatabrain.com/guides/visualizations-actions-and-appearance/chart-setup/trend-analyzer.md): Set up the Trend Analyzer chart for time-series and trend analysis.
- [Multi Datamart Workspace](https://docs.usedatabrain.com/guides/workspace/multi-datamart-workspace.md): Steps to Set Up and Use Multi-Datamart Switching in Your Dashboard.
- [Multi Datasource Workspace](https://docs.usedatabrain.com/guides/workspace/multi-datasource-workspace.md): Steps to Set Up and Use Multi-Datasource Switching in Your Dashboard.

## OpenAPI Specs

- [openapi](https://docs.usedatabrain.com/api-reference/openapi.json)