# Omni Docs
## Docs
- [Usage analytics](https://docs.omni.co/administration/analytics.md): Gain insight into how Omni is being used in your organization.
- [Using Amazon S3 for Omni audit logs](https://docs.omni.co/administration/audit-logs/amazon-s3.md): Track Omni user activity in your instance with structured logs, accessible in an Amazon S3 bucket.
- [Audit log event types](https://docs.omni.co/administration/audit-logs/event-types.md): Reference for all audit log event types and their payload fields.
- [Using Google Cloud Storage for Omni audit logs](https://docs.omni.co/administration/audit-logs/google-cloud-storage.md): Configure Google Cloud Storage as the destination for your Omni audit logs to track user activity with structured event data.
- [Audit logs](https://docs.omni.co/administration/audit-logs/index.md): Set up audit logging in Omni to track user activity with structured event logs delivered to Amazon S3 or Google Cloud Storage.
- [Microsoft Entra authentication](https://docs.omni.co/administration/authentication/entra/index.md): Connect Omni to Microsoft Entra for secure SAML single sign-on and automated user provisioning.
- [Microsoft Entra SAML authentication](https://docs.omni.co/administration/authentication/entra/saml.md): Configure service provider (SP)-initiated SAML authentication between Microsoft Entra and Omni.
- [Auto-provisioning Omni users with Microsoft Entra SCIM](https://docs.omni.co/administration/authentication/entra/scim.md): Automatically manage Omni accounts for your users with Microsoft Entra SCIM provisioning.
- [Syncing Microsoft Entra user attributes to Omni with SCIM](https://docs.omni.co/administration/authentication/entra/user-attributes.md): Sync user attributes from Microsoft Entra to Omni via SCIM.
- [Managing users with Google Workspace SAML](https://docs.omni.co/administration/authentication/google-workspace.md): Integrate Omni with Google Workspace for user authentication via the SAML protocol.
- [Set up Identity Providers (IdP) for authentication](https://docs.omni.co/administration/authentication/index.md): Configure SSO, SAML, or OIDC for your Omni organization
- [Configuring OIDC authentication](https://docs.omni.co/administration/authentication/oidc.md): Configure OpenID Connect (OIDC) authentication for your Omni organization.
- [Okta authentication](https://docs.omni.co/administration/authentication/okta/index.md): Connect Omni to Okta for secure SAML single sign-on and automated user provisioning.
- [Configuring Okta SAML authentication](https://docs.omni.co/administration/authentication/okta/saml.md): Configure service provider (SP)-initiated SAML authentication between Okta and Omni.
- [Auto-provisioning Omni users with Okta SCIM](https://docs.omni.co/administration/authentication/okta/scim.md): Automatically manage Omni accounts for your users with Okta SCIM provisioning.
- [Syncing Okta user attributes to Omni with SCIM](https://docs.omni.co/administration/authentication/okta/user-attributes.md): Sync user attributes from Okta to Omni via SCIM.
- [Rippling authentication](https://docs.omni.co/administration/authentication/rippling/index.md): Connect Omni to Rippling for secure SAML single sign-on and automated user provisioning.
- [Configuring Rippling SAML SSO](https://docs.omni.co/administration/authentication/rippling/saml.md): Integrate Omni with Rippling for user authentication via the SAML protocol.
- [Auto-provisioning Omni users with Rippling SCIM](https://docs.omni.co/administration/authentication/rippling/scim.md): Automatically manage Omni accounts for your users with Rippling SCIM provisioning.
- [SAML and SCIM troubleshooting](https://docs.omni.co/administration/authentication/troubleshooting.md): Common issues and solutions for SAML and SCIM authentication in Omni.
- [Managing billing & invoices](https://docs.omni.co/administration/billing.md): View your organization's Omni billing information & invoices.
- [Managing custom chart palettes](https://docs.omni.co/administration/chart-palettes/custom.md): Create custom palettes with your company colors, ensuring your workbooks, charts, and dashboards are always consistent and on-brand.
- [Setting a default chart palette for your organization](https://docs.omni.co/administration/chart-palettes/default.md): Set a default chart color palette for your Omni organization, applied automatically to new charts based on chart type and data.
- [Managing chart palettes](https://docs.omni.co/administration/chart-palettes/index.md): Predefined color palettes help you apply consistent colors across charts, workbooks, and dashboards.
- [Omni palette color reference](https://docs.omni.co/administration/chart-palettes/omni.md): The color values for the Omni-specific palettes are provided as a reference for creating your own palette variations.
- [Content permission settings](https://docs.omni.co/administration/content-permissions.md): Manage the default content permissions for your organization in **Settings > Content permissions**.
- [Omni administration](https://docs.omni.co/administration/index.md): Manage users, security, billing, and more in your Omni instance
- [Localization settings](https://docs.omni.co/administration/localization.md): Configure language settings at the organization and user levels.
- [Canceling long-running & hanging queries](https://docs.omni.co/administration/running-queries.md): At times, administrators may need to remove long running or hanging queries.
- [Omni supported cloud regions](https://docs.omni.co/administration/security/cloud-regions.md): Your organization can choose where your Omni application is hosted from the following cloud regions:
- [Omni product & system security](https://docs.omni.co/administration/security/index.md): Learn more about how Omni keeps your data secure.
- [Omni information security program](https://docs.omni.co/administration/security/information-security-program.md): Omni maintains written policies and procedures designed to ensure the security of our employees, partners, and customers.
- [Allowlisting Omni's IP addresses](https://docs.omni.co/administration/security/omni-ip-addresses.md): Find the static IP addresses for your Omni environment and configure your firewall or allowlist for secure database connections.
- [Vulnerability disclosure policy](https://docs.omni.co/administration/security/vulnerability-disclosure.md): Learn how Omni handles vulnerabilities and how to report them to our security team.
- [Organization settings](https://docs.omni.co/administration/settings.md): Configure organization-wide settings in Omni, including user access defaults, content visibility, and support access controls.
- [Authentication settings](https://docs.omni.co/administration/settings/authentication.md): Configure general authentication behavior, SAML, and OIDC for your Omni organization.
- [Emoji settings](https://docs.omni.co/administration/settings/emoji.md): Configure emoji mode for query tabs and manage custom emoji at the organization level.
- [Application theme settings](https://docs.omni.co/administration/themes/application.md): Configure application theme settings in Omni, including navigation colors, fonts, dark mode, branding, and theme import/export.
- [Document theme settings](https://docs.omni.co/administration/themes/documents.md): Customize the look and feel of content in your Omni instance.
- [Application and document theme settings](https://docs.omni.co/administration/themes/index.md): Manage application and document themes in Omni to customize branding, colors, fonts, and visual style across your organization.
- [AI credit tracking](https://docs.omni.co/administration/token-tracking.md): Monitor and understand AI credit usage across your Omni organization.
- [User attributes](https://docs.omni.co/administration/users/attributes.md): Utilize user-specific variables to create dynamic content and control data access.
- [Defining custom model roles](https://docs.omni.co/administration/users/custom-roles.md): Define custom roles with specific permission restrictions that can be assigned to users, groups, and connections.
- [Revoking user memberships](https://docs.omni.co/administration/users/delete.md): Learn how to permanently revoke a user's membership in Omni, including what happens to their content and deliveries.
- [Email-only users](https://docs.omni.co/administration/users/email-only.md): Learn how email-only users work in Omni, including how they're created, managed, and used with deliveries and embedded analytics.
- [User groups](https://docs.omni.co/administration/users/groups.md): Assign permissions to users in bulk with user groups.
- [Managing users](https://docs.omni.co/administration/users/index.md): Invite, monitor, and manage users in your Omni organization.
- [Inviting users](https://docs.omni.co/administration/users/invite.md): Send invitations, manage invitation requests, and re-invite users with expired invitations.
- [Managing data access with connection permissions](https://docs.omni.co/administration/users/permissions.md): Assign and test database connection, data model, and content-level permissions to control user access across your Omni instance.
- [Connection and model permissions reference](https://docs.omni.co/administration/users/permissions-reference.md): A detailed reference of all connection and model role permissions in Omni, covering document, query, and modeling capabilities.
- [Common user access scenarios](https://docs.omni.co/administration/users/permissions-scenarios.md): Learn how to implement user permissions to achieve different levels of access in Omni.
- [Troubleshooting user permissions](https://docs.omni.co/administration/users/permissions-troubleshooting.md): Troubleshoot the most common permission issues.
- [Managing a user's settings](https://docs.omni.co/administration/users/settings.md): Learn how to access the settings for individual users and test data access through impersonation.
- [Managing your account settings](https://docs.omni.co/administration/users/your-account.md): Configure your personal Omni settings, including appearance, query timezone, and personal API tokens.
- [Omni Agent (standalone chat)](https://docs.omni.co/ai/chat.md): Explore your data using conversational AI in a standalone chat experience.
- [Dashboard Agent](https://docs.omni.co/ai/dashboard-assistant.md): The Dashboard Agent brings Omni's conversational analytics directly into your dashboards.
- [Eval design guide](https://docs.omni.co/ai/eval-design-guide.md): Best practices for building effective eval sets to measure and improve Omni AI query generation accuracy.
- [Generating forecasts with AI](https://docs.omni.co/ai/forecasting.md): Create statistical forecasts and projections for time-series data using natural language.
- [AI in Omni](https://docs.omni.co/ai/index.md): Omni's AI is grounded in your semantic model — delivering accurate, governed analytics through natural language.
- [Learn from conversation](https://docs.omni.co/ai/learn-from-conversation.md): Let the AI capture business context from your conversations to improve future queries.
- [MCP authentication](https://docs.omni.co/ai/mcp/authentication.md): Choose how to authenticate MCP clients with your Omni instance: OAuth for streamlined setup or API keys for manual control.
- [Using the MCP Server in ChatGPT](https://docs.omni.co/ai/mcp/chatgpt.md): Connect your Omni data to ChatGPT with Omni's MCP Server.
- [Using the MCP Server in Claude Code](https://docs.omni.co/ai/mcp/claude-code.md): Connect your Omni data to Claude Code with Omni's MCP Server.
- [Using the MCP Server in Claude Desktop](https://docs.omni.co/ai/mcp/claude-desktop.md): Connect your Omni data to Claude Desktop with Omni's MCP Server.
- [Using the MCP Server in Codex](https://docs.omni.co/ai/mcp/codex.md): Connect your Omni data to Codex with Omni's MCP Server.
- [Using the MCP Server in Cursor](https://docs.omni.co/ai/mcp/cursor.md): Connect your Omni data to Cursor with Omni's MCP Server.
- [AI MCP Server](https://docs.omni.co/ai/mcp/index.md): Unlock new ways to analyze & explore your data by connecting external AI tools to your Omni model with Omni's MCP Server.
- [Using the MCP Server in Visual Studio Code](https://docs.omni.co/ai/mcp/vscode.md): Connect your Omni data to Visual Studio Code with Omni's MCP Server.
- [Modeling Agent](https://docs.omni.co/ai/model-assistant.md): Chat with AI while you edit your semantic model in the Model IDE—ask questions, draft YAML, and choose how changes are applied.
- [Building queries & filters with AI](https://docs.omni.co/ai/queries.md): Create, iterate, filter, and summarize queries with natural language.
- [AI data security](https://docs.omni.co/ai/security.md): Learn how Omni handles your data when you use AI tools.
- [AI branding](https://docs.omni.co/ai/settings/branding.md): Customize the appearance of the AI chat interface in your Omni organization.
- [AI Feature settings](https://docs.omni.co/ai/settings/features.md): Enable and disable individual AI features in your Omni organization.
- [AI settings](https://docs.omni.co/ai/settings/index.md): Enable and disable AI features in your Omni organization.
- [Using Databricks Genie for Omni AI](https://docs.omni.co/ai/settings/model-providers/databricks-genie.md): Configure Databricks Genie as an AI model provider in Omni using your own serving endpoints.
- [Alternative model providers](https://docs.omni.co/ai/settings/model-providers/index.md): Configure a custom AI model provider for your Omni organization.
- [Using a custom OpenAI model for Omni AI](https://docs.omni.co/ai/settings/model-providers/openai.md): Use custom model identifiers with OpenAI to connect Omni to Ollama, Azure OpenAI, fine-tuned models, and more.
- [Using Snowflake Cortex for Omni AI](https://docs.omni.co/ai/settings/model-providers/snowflake-cortex.md): Configure Snowflake Cortex as an AI model provider in Omni.
- [Agent Skills](https://docs.omni.co/ai/skills.md): Build reusable AI-powered processes that your team can trigger with a single click.
- [Generating visualizations with AI](https://docs.omni.co/ai/visualizations.md): Create and configure charts, tables, and KPIs using natural language prompts.
- [Supported AI functions](https://docs.omni.co/analyze-explore/calculations/ai.md): Reference for AI-powered table calculation functions in Omni for text analysis and generation, using Snowflake and Databricks.
- [Supported table calculation functions](https://docs.omni.co/analyze-explore/calculations/all.md): Learn more about the functions Omni supports for creating table calculations.
- [Supported date & time functions](https://docs.omni.co/analyze-explore/calculations/date-time.md): Omni supports functions typically found in most spreadsheet applications such as Google Sheets. This reference details the date and time functions supported by Omni.
- [Using Excel-style functions to create table calculations](https://docs.omni.co/analyze-explore/calculations/index.md): Create formulas that manipulate and calculate data with Excel-style functions.
- [Supported logic functions](https://docs.omni.co/analyze-explore/calculations/logic.md): Omni supports functions typically found in most spreadsheet applications such as Google Sheets. This reference details the logic functions supported by Omni.
- [Supported math and number functions](https://docs.omni.co/analyze-explore/calculations/math-number.md): Omni supports functions typically found in most spreadsheet applications such as Google Sheets. This reference details the math and number functions supported by Omni.
- [Supported position functions](https://docs.omni.co/analyze-explore/calculations/position.md): Reference for position functions like INDEX, MATCH, and OFFSET in Omni table calculations, similar to Google Sheets and Excel.
- [Supported text functions](https://docs.omni.co/analyze-explore/calculations/text.md): Omni supports functions typically found in most spreadsheet applications such as Google Sheets. This reference details the text functions supported by Omni.
- [Binning and grouping custom fields](https://docs.omni.co/analyze-explore/custom-fields/bin-group.md): Bin and group custom fields with Omni's handy custom calculation accelerators.
- [Creating filtered measures from query results](https://docs.omni.co/analyze-explore/custom-fields/filtered-measures.md): Create a custom field that selectively applies a filter to a measure in a query.
- [Creating custom fields in Omni workbooks](https://docs.omni.co/analyze-explore/custom-fields/index.md): Create new, reusable ad-hoc dimensions and measures with your own custom logic and calculations.
- [Uploading CSVs with data input tables](https://docs.omni.co/analyze-explore/data-input-csvs.md): Upload CSV or Excel files to Omni as data input tables for enrichment and ad-hoc analysis without modifying your data pipelines.
- [Analyze & build in Omni](https://docs.omni.co/analyze-explore/index.md): Explore data, build queries, create calculations, and optimize performance in Omni workbooks.
- [Optimizing query performance with aggregate awareness](https://docs.omni.co/analyze-explore/performance/aggregate-awareness.md): Aggregate awareness enables you to optimize query performance by intelligently routing queries to pre-aggregated tables in your data warehouse.
- [Improving query performance with caching](https://docs.omni.co/analyze-explore/performance/caching.md): Learn how Omni uses multi-layer caching and aggregate awareness to optimize query performance and reduce warehouse load.
- [Building point-and-click queries](https://docs.omni.co/analyze-explore/point-click-queries.md): To write queries using the pivot-table UI, select fields to query and Omni will automatically begin running queries in the database.
- [Building workbook queries on topics](https://docs.omni.co/analyze-explore/queries/topics.md): Start workbook queries from curated topics to explore governed datasets with pre-defined fields, joins, and business logic.
- [Querying data in Omni](https://docs.omni.co/analyze-explore/querying.md): Explore the different ways to query and analyze data in Omni, from conversational AI to point-and-click to SQL.
- [Saving queries as views](https://docs.omni.co/analyze-explore/saved-views.md): Save workbook queries as reusable views to build subqueries and join them to your analysis, compiled as CTEs when queried.
- [Formatting & analyzing data with spreadsheet tabs](https://docs.omni.co/analyze-explore/spreadsheet-tabs.md): Use spreadsheet tabs in Omni workbooks for Excel-style formatting, formulas, and analysis powered by always-live query data.
- [Understanding SQL generation in Omni](https://docs.omni.co/analyze-explore/sql/generation.md): When building an analysis - whether that's through the workbook or using AI - Omni generates SQL to execute against your data warehouse and returns the results.
- [Writing SQL in Omni](https://docs.omni.co/analyze-explore/sql/index.md): Write SQL queries in Omni using Omni SQL, an abstraction layer that simplifies complex syntax with built-in operators and helpers.
- [Handling fan out with symmetric aggregates](https://docs.omni.co/analyze-explore/sql/symmetric-aggregates.md): Use symmetric aggregates to ensure correct aggregation results in queries with table joins and fan outs, without manual adjustments.
- [Build analyses in workbooks](https://docs.omni.co/analyze-explore/workbook-basics.md): Learn Omni workbook basics: create tabs, query data with point-and-click or SQL, save versions, and share analyses with your team.
- [Workbook inspector](https://docs.omni.co/analyze-explore/workbook-inspector.md): Inspect query structure, visualization config, and generated SQL in the workbook inspector to debug and copy to your model.
- [Cancel AI job](https://docs.omni.co/api/ai/cancel-ai-job.md): Request cancellation of an AI job. This endpoint is idempotent — calling it on an already-cancelled or completed job returns success with the current state.
- [Create AI job](https://docs.omni.co/api/ai/create-ai-job.md): Submit a new AI job for asynchronous execution. The AI will analyze the prompt, generate and execute queries against the specified model, and produce a summarized answer.
- [Generate a query](https://docs.omni.co/api/ai/generate-a-query.md): Generate a structured Omni query from natural language using AI
- [Get AI job status](https://docs.omni.co/api/ai/get-ai-job-status.md): Retrieve the current status and details of an AI job, including its state, progress information, and result summary.
- [Pick topic](https://docs.omni.co/api/ai/pick-topic.md): Analyze a natural language prompt and determines which topic in the model is the best fit for answering the question.
- [Stream AI job results](https://docs.omni.co/api/ai/stream-ai-job-results.md): Retrieve the full result of a completed AI job, including all actions taken by the AI (queries generated, data retrieved) and the final summarized answer.
- [API Explorer](https://docs.omni.co/api/api-explorer.md): Interactively browse and test Omni API endpoints using the built-in API Explorer.
- [List API tokens](https://docs.omni.co/api/api-tokens/list-api-tokens.md): This endpoint requires **Organization Admin** permissions.
- [API authentication](https://docs.omni.co/api/authentication.md): Authenticate your requests to the Omni API with an API key.
- [Create connection environments](https://docs.omni.co/api/connection-environments/create-connection-environments.md): Creates connection environments by associating environment-specific connections with a base connection
- [Delete connection environment](https://docs.omni.co/api/connection-environments/delete-connection-environment.md): Deletes a connection environment by ID. Requires Connection Admin or Organization Admin permissions.
- [Update connection environment](https://docs.omni.co/api/connection-environments/update-connection-environment.md): Associates user attribute values with a specific connection environment, which will determine when it is used.
- [Create connection](https://docs.omni.co/api/connections/create-connection.md)
- [List connections](https://docs.omni.co/api/connections/list-connections.md): Retrieves a list of database connections with optional filtering and sorting
- [Update connection](https://docs.omni.co/api/connections/update-connection.md): Update connection properties including credentials. Credentials are encrypted at rest and never returned in API responses.
- [Export dashboard](https://docs.omni.co/api/content-migration/export-dashboard.md): Export dashboard for migration between Omni instances
- [Import dashboard](https://docs.omni.co/api/content-migration/import-dashboard.md): Import dashboard to Omni instance
- [Find and replace content](https://docs.omni.co/api/content-validator/find-and-replace-content.md): Performs find/replace operations on content using the specified model.
- [Validate content](https://docs.omni.co/api/content-validator/validate-content.md): Validates all content against the model and returns documents with queries and any validation issues.
- [Retrieve content](https://docs.omni.co/api/content/retrieve-content.md): Retrieve paginated list of documents and folders
- [Check download status](https://docs.omni.co/api/dashboard-downloads/check-download-status.md)
- [Download file](https://docs.omni.co/api/dashboard-downloads/download-file.md)
- [Initiate download](https://docs.omni.co/api/dashboard-downloads/initiate-download.md)
- [Get dashboard filters and controls](https://docs.omni.co/api/dashboard-filters/get-dashboard-filters-and-controls.md): Returns the filter and control configuration for a dashboard, including IDs, types, current default values, and metadata.
- [Update dashboard filters/controls](https://docs.omni.co/api/dashboard-filters/update-dashboard-filterscontrols.md)
- [Create dbt environment](https://docs.omni.co/api/dbt/create-dbt-environment.md): This endpoint requires **Connection Admin** permissions for the connection.
- [Delete dbt configuration](https://docs.omni.co/api/dbt/delete-dbt-configuration.md): **Connection Admin** permissions are required to use this endpoint.
- [Delete dbt environment](https://docs.omni.co/api/dbt/delete-dbt-environment.md): This endpoint requires **Connection Admin** permissions for the connection.
- [Get dbt configuration](https://docs.omni.co/api/dbt/get-dbt-configuration.md): **Connection Admin** permissions are required to use this endpoint.
- [Get dbt exposures](https://docs.omni.co/api/dbt/get-dbt-exposures.md): **Connection Admin** permissions are required to use this endpoint.
- [List dbt environments](https://docs.omni.co/api/dbt/list-dbt-environments.md): This endpoint requires **Connection Viewer** or higher permissions for the connection.
- [Set dbt environment on model branch](https://docs.omni.co/api/dbt/set-dbt-environment-on-model-branch.md): Sets the active dbt environment on a model branch. This endpoint allows you to programmatically configure which dbt environment a branch should use, enabling CI/CD pipelines to automate dbt environment configuration before triggering schema refreshes.
- [Update dbt configuration](https://docs.omni.co/api/dbt/update-dbt-configuration.md): **Connection Admin** permissions are required to use this endpoint.
- [Update dbt environment](https://docs.omni.co/api/dbt/update-dbt-environment.md): This endpoint requires **Connection Admin** permissions for the connection.
- [Favorite document](https://docs.omni.co/api/document-favorites/favorite-document.md): Add a document to a user's favorites. Only published documents can be favorited.
- [Unfavorite document](https://docs.omni.co/api/document-favorites/unfavorite-document.md): Remove a document from a user's favorites. Only published documents can be unfavorited.
- [Apply label to document](https://docs.omni.co/api/document-labels/apply-label-to-document.md): Apply an existing label to a document. Labels must be created first via the [Create label](/api/labels/create-label) endpoint.
- [Bulk update document labels](https://docs.omni.co/api/document-labels/bulk-update-document-labels.md)
- [Remove label from document](https://docs.omni.co/api/document-labels/remove-label-from-document.md)
- [Grant document permissions](https://docs.omni.co/api/document-permissions/grant-document-permissions.md): Grant document permissions to users or groups
- [List all users and groups with document access](https://docs.omni.co/api/document-permissions/list-all-users-and-groups-with-document-access.md): Returns all users and groups with access to a document in a single paginated call.
- [Retrieve document permissions for a user](https://docs.omni.co/api/document-permissions/retrieve-document-permissions-for-a-user.md): Retrieves the document permissions for a specific user.
- [Revoke document permissions](https://docs.omni.co/api/document-permissions/revoke-document-permissions.md): Revokes document permissions for users or user groups.
- [Update document permission settings](https://docs.omni.co/api/document-permissions/update-document-permission-settings.md): Updates the permission and [interactivity settings](/share#controlling-document-interactivity) for a document. For example, the ability to allow users to schedule or download the document's content.
- [Update document permissions](https://docs.omni.co/api/document-permissions/update-document-permissions.md): Update existing document permissions for users or groups
- [Archive draft](https://docs.omni.co/api/documents/archive-draft.md): Archives the current draft of the specified document. Archived drafts will be placed in the in the [**Archived** section of the **Drafts** drawer](/content/develop/drafts#archiving-drafts) in the document's workbook and retained for 30 days.
- [Create document](https://docs.omni.co/api/documents/create-document.md): Create a new document
- [Create draft](https://docs.omni.co/api/documents/create-draft.md): This endpoint requires **Editor** permissions or higher on the specified document.
- [Delete document](https://docs.omni.co/api/documents/delete-document.md): Delete document (moves to Trash)
- [Duplicate published document](https://docs.omni.co/api/documents/duplicate-published-document.md)
- [Get dashboard document](https://docs.omni.co/api/documents/get-dashboard-document.md): Retrieves dashboard document configuration in a format compatible with PUT for round-trip editing. This endpoint returns all fields needed to modify and update a dashboard document.
- [Get document queries](https://docs.omni.co/api/documents/get-document-queries.md): Retrieves queries associated with a document by its identifier.
- [List documents](https://docs.omni.co/api/documents/list-documents.md): List documents with pagination and filtering
- [Move document](https://docs.omni.co/api/documents/move-document.md): Move document to new folder or change scope
- [Transfer document ownership](https://docs.omni.co/api/documents/transfer-document-ownership.md): Transfer ownership of a document to another user in the organization.
- [Update dashboard document](https://docs.omni.co/api/documents/update-dashboard-document.md): This endpoint only works with dashboard documents. Workbook-only documents are not supported.
- [Update document](https://docs.omni.co/api/documents/update-document.md): Updates the name, description, and/or identifier of a document. **Note**: At least one of `name`, `description`, or `identifier` must be provided or the API will return a `Bad Request` error.
- [Get folder permissions](https://docs.omni.co/api/folder-permissions/get-folder-permissions.md): Retrieve folder permissions for a user
- [Grant folder permissions](https://docs.omni.co/api/folder-permissions/grant-folder-permissions.md): Grant folder permissions to users or groups
- [Revoke folder permissions](https://docs.omni.co/api/folder-permissions/revoke-folder-permissions.md): Revoke folder permissions from users or groups
- [Update folder permissions](https://docs.omni.co/api/folder-permissions/update-folder-permissions.md): Update existing folder permissions for users or groups
- [Create folder](https://docs.omni.co/api/folders/create-folder.md): Create a new folder. Folders can be nested up to 7 levels.
- [Delete folder](https://docs.omni.co/api/folders/delete-folder.md): Delete a folder. By default, only empty folders can be deleted. Use the `force` parameter to recursively delete folders containing documents and sub-folders.
- [List folders](https://docs.omni.co/api/folders/list-folders.md): Retrieve a paginated list of folders within an organization. Supports filtering, sorting, and cursor-based pagination.
- [Update folder](https://docs.omni.co/api/folders/update-folder.md): This endpoint requires [**Editor** permissions or higher](/share#content-access-permissions) on the folder being updated.
- [Omni REST APIs](https://docs.omni.co/api/index.md): Programmatically interact with your Omni instance with Omni's REST APIs.
- [Get job status](https://docs.omni.co/api/jobs/get-job-status.md): Currently, this endpoint only supports schema refresh jobs. Job IDs from other job types will return an error.
- [Create label](https://docs.omni.co/api/labels/create-label.md): Create a new label in the organization.
- [Delete label](https://docs.omni.co/api/labels/delete-label.md): Delete a label from the organization.
- [Get label](https://docs.omni.co/api/labels/get-label.md): Retrieve a single label by name.
- [List labels](https://docs.omni.co/api/labels/list-labels.md): Retrieve all labels in the organization.
- [Update label](https://docs.omni.co/api/labels/update-label.md): Update an existing label, including renaming, changing **Verified** status, or adding/removing it from the **Homepage**.
- [Merge a branch](https://docs.omni.co/api/model-branches/merge-a-branch.md): Merges a model branch into the shared model.
- [Create git configuration](https://docs.omni.co/api/model-git-configuration/create-git-configuration.md): Creates a new git configuration for a shared model.
- [Delete git configuration](https://docs.omni.co/api/model-git-configuration/delete-git-configuration.md): Removes the git configuration from a shared model.
- [Get git configuration](https://docs.omni.co/api/model-git-configuration/get-git-configuration.md): Retrieves the git configuration for a shared model.
- [Sync model with git repository](https://docs.omni.co/api/model-git-configuration/sync-model-with-git-repository.md): Triggers a sync operation between the model and its configured git repository.
- [Update git configuration](https://docs.omni.co/api/model-git-configuration/update-git-configuration.md): Updates the git configuration for a shared model. Oly provided fields will be updated.
- [Create model](https://docs.omni.co/api/models/create-model.md): Create a new model. The typical workflow for using this endpoint is:
- [Create or update YAML files](https://docs.omni.co/api/models/create-or-update-yaml-files.md): Creates or overwrites a YAML file for a model. The file can be a special file (`model` or `relationships`) or a YAML file ending in `.topic` or `.view`.
- [Delete a YAML file](https://docs.omni.co/api/models/delete-a-yaml-file.md): Deletes a topic or view YAML file from a model. The file must be a YAML file ending in `.topic` or `.view`.
- [Delete branch](https://docs.omni.co/api/models/delete-branch.md): Deletes a branch associated with the specified shared model.
- [Delete view](https://docs.omni.co/api/models/delete-view.md): Deletes or ignores a view from a model extension layer. Use the `mode` parameter to specify the behavior of this endpoint.
- [Get model YAML](https://docs.omni.co/api/models/get-model-yaml.md): Retrieves the YAML representation of a model with optional filtering and mode selection.
- [List model schemas](https://docs.omni.co/api/models/list-model-schemas.md): Retrieves a sorted list of all available schema names for the specified model, including physical, virtual, and dynamic schemas.
- [List models](https://docs.omni.co/api/models/list-models.md): Retrieves a paginated list of models with their metadata.
- [Migrate a model](https://docs.omni.co/api/models/migrate-a-model.md): Copies a model from one Omni connection to another by reading the source model's YAML at a specific git ref and writing it to the target model. Supports same-organization and cross-organization migrations.
- [Refresh schema](https://docs.omni.co/api/models/refresh-schema.md): Refreshes the schema of the specified model. This will cause the model to reflect the latest changes to schemas, views, and fields from the data source.
- [Rename model](https://docs.omni.co/api/models/rename-model.md): Renames a model by updating its name. This endpoint allows you to programmatically rename models without using the UI, which is particularly useful for bulk operations on shared extension models created via `POST /api/v1/models`.
- [Reset cache](https://docs.omni.co/api/models/reset-cache.md): Resets the cache for the specified cache policy.
- [Validate model](https://docs.omni.co/api/models/validate-model.md): Retrieves validation issues for a model and its branches.
- [Run query](https://docs.omni.co/api/queries/run-query.md): Runs the query specified in the request body. Successful requests will return the data as a base64 encoded [Apache Arrow](https://arrow.apache.org/) table, allowing you to extract query results from Omni and use them elsewhere. For example, piping data to Google Sheets or leveraging data in a Python…
- [Wait for query results](https://docs.omni.co/api/queries/wait-for-query-results.md): Polls for the results of one or more query jobs. Use this endpoint when a request to the [Run query endpoint](/api/queries/run-query) times out and returns `remaining_job_ids` in the response.
- [Omni API rate limiting](https://docs.omni.co/api/rate-limits.md): Understand Omni API rate limits and how to handle them in your integration.
- [Add schedule recipients](https://docs.omni.co/api/schedule-recipients/add-schedule-recipients.md)
- [Bulk manage email-only users](https://docs.omni.co/api/schedule-recipients/bulk-manage-email-only-users.md): Creates or updates up to 20 [email-only users](/share/deliveries/email). An email-only user is a recipient of a delivery that isn't associated with an Omni account.
- [List schedule recipients](https://docs.omni.co/api/schedule-recipients/list-schedule-recipients.md): Retrieves the list of recipients for the specified schedule. Successful responses will include the recipients and details about the schedule's destination type.
- [Manage email-only user](https://docs.omni.co/api/schedule-recipients/manage-email-only-user.md)
- [Remove schedule recipients](https://docs.omni.co/api/schedule-recipients/remove-schedule-recipients.md)
- [Create schedule](https://docs.omni.co/api/schedules/create-schedule.md): Creates a scheduled task for the specified dashboard. Supports applying filters and formatting, creating alert conditions, and triggering test deliveries.
- [Delete schedule](https://docs.omni.co/api/schedules/delete-schedule.md): Deletes a schedule.
- [Get schedule](https://docs.omni.co/api/schedules/get-schedule.md): Returns the details of a single schedule, including its delivery destinations, recurrence configuration, and current status.
- [List schedules](https://docs.omni.co/api/schedules/list-schedules.md): Retrieves scheduled tasks. This endpoint supports filtering, sorting, and cursor-based pagination.
- [Pause schedule](https://docs.omni.co/api/schedules/pause-schedule.md): Pauses a schedule.
- [Resume schedule](https://docs.omni.co/api/schedules/resume-schedule.md): Resumes a schedule.
- [Transfer schedule ownership](https://docs.omni.co/api/schedules/transfer-schedule-ownership.md)
- [Trigger schedule](https://docs.omni.co/api/schedules/trigger-schedule.md): Triggers the execution of a schedule on demand, outside of its regular schedule.
- [Update schedule](https://docs.omni.co/api/schedules/update-schedule.md)
- [Create schema refresh schedule](https://docs.omni.co/api/schema-refresh-schedules/create-schema-refresh-schedule.md): Creates a new schema refresh schedule for the specified connection. Multiple schedules can be created for the same connection.
- [Delete schema refresh schedule](https://docs.omni.co/api/schema-refresh-schedules/delete-schema-refresh-schedule.md): Deletes a schema refresh schedule. This does not affect other schedules for the same connection.
- [Get schema refresh schedule](https://docs.omni.co/api/schema-refresh-schedules/get-schema-refresh-schedule.md): Retrieves the details of a connection's specific schema refresh schedule.
- [List schema refresh schedules](https://docs.omni.co/api/schema-refresh-schedules/list-schema-refresh-schedules.md): Retrieves all schema refresh schedules configured for the specified connection. Each schedule uses a cron expression and timezone to define when the schema should be refreshed.
- [Update schema refresh schedule](https://docs.omni.co/api/schema-refresh-schedules/update-schema-refresh-schedule.md): Updates the schedule and/or timezone for an existing schema refresh schedule.
- [Retrieve a topic](https://docs.omni.co/api/topics/retrieve-a-topic.md): Retrieves a topic in a model by name.
- [Delete an upload](https://docs.omni.co/api/uploads/delete-an-upload.md): Delete a CSV upload by its ID. This removes the file from storage and marks the record as deleted.
- [List uploads](https://docs.omni.co/api/uploads/list-uploads.md): List all uploads ([CSV files and spreadsheets](/analyze-explore/data-input-csvs)) in the organization with metadata and optional filtering.
- [Upload a CSV file](https://docs.omni.co/api/uploads/upload-a-csv-file.md): To use this endpoint: - The **Upload data** setting in **Settings > Content permissions** must enabled by an **Organization Admin** - The authenticating user must have **Restricted Querier** permissions or higher on the model the file will be uploaded to
- [List user attributes](https://docs.omni.co/api/user-attributes/list-user-attributes.md)
- [Assign or update user group model role](https://docs.omni.co/api/user-group-model-roles/assign-or-update-user-group-model-role.md): Assigns or updates a model role for a user group. If the user group already has a role for the specified model, this endpoint will update it to the new role. All members of the user group will inherit this role.
- [Retrieve user group model roles](https://docs.omni.co/api/user-group-model-roles/retrieve-user-group-model-roles.md): Retrieves the model role assignments for a user group.
- [Create user group](https://docs.omni.co/api/user-groups/create-user-group.md): Creates a [user group](/administration/users/groups). To manage model and connection role assignments for user groups, see the [User group model role APIs](/api/user-group-model-roles).
- [Delete user group](https://docs.omni.co/api/user-groups/delete-user-group.md): Deletes the specified user group.
- [List user groups](https://docs.omni.co/api/user-groups/list-user-groups.md): Returns a list of user groups, sorted by creation time.
- [Retrieve user group](https://docs.omni.co/api/user-groups/retrieve-user-group.md): Retrieves a user group using its unique ID.
- [Update user group](https://docs.omni.co/api/user-groups/update-user-group.md): Updates the specified user group by setting the values of the parameters provided and leaving all other properties unchanged.
- [Assign or update user model role](https://docs.omni.co/api/user-model-roles/assign-or-update-user-model-role.md): Assigns or updates a model role for a user. If the user already has a role for the specified model, this endpoint will update it to the new role.
- [Retrieve user model roles](https://docs.omni.co/api/user-model-roles/retrieve-user-model-roles.md): Retrieves the model role assignments for a user. This includes both direct role assignments and roles inherited from user group memberships.
- [Create user](https://docs.omni.co/api/users/create-user.md): Creates a user. To manage model and connection role assignments for users, see the [User model role APIs](/api/user-model-roles).
- [Delete embed user](https://docs.omni.co/api/users/delete-embed-user.md): Deletes the specified embed user. Use the [Delete user](/api/users/delete-user) endpoint to delete standard users.
- [Delete user](https://docs.omni.co/api/users/delete-user.md): Deletes the specified user. Use the [Delete embed user](/api/users/delete-embed-user) endpoint to delete embed users.
- [List email-only users](https://docs.omni.co/api/users/list-email-only-users.md): Retrieve email-only users with their user attributes, with support for cursor-based pagination and filtering
- [List embed users](https://docs.omni.co/api/users/list-embed-users.md): Returns a list of embed users, sorted by creation time. Use the [List users](/api/users/list-users) endpoint to retrieve standard users.
- [List users](https://docs.omni.co/api/users/list-users.md): Returns a list of users, sorted by creation time. Use the [List embed users](/api/users/list-embed-users) endpoint to retrieve embed users.
- [Retrieve embed user](https://docs.omni.co/api/users/retrieve-embed-user.md): Retrieves an embed user using their unique ID. Use the [Retrieve user](/api/users/retrieve-user) endpoint to retrieve standard users.
- [Retrieve user](https://docs.omni.co/api/users/retrieve-user.md): Retrieves a user using their unique ID
- [Update user](https://docs.omni.co/api/users/update-user.md): Updates the specified user by setting the values of the parameters provided and leaving all other properties of the user unchanged.
- [2023 Changelog](https://docs.omni.co/changelog/2023.md): A chronological list of new features, improvements, and bug fixes shipped to the Omni platform during 2023.
- [2024 Changelog](https://docs.omni.co/changelog/2024.md): A chronological list of new features, improvements, and bug fixes shipped to the Omni platform during 2024.
- [2025 Changelog](https://docs.omni.co/changelog/2025.md): A chronological list of new features, improvements, and bug fixes shipped to the Omni platform during 2025.
- [Product updates](https://docs.omni.co/changelog/index.md): Stay current with the latest Omni product updates, including new features, platform improvements, and bug fixes for 2026.
- [Archiving (deleting) connections](https://docs.omni.co/connect-data/archive-connection.md): Archive a database connection to permanently remove it from your Omni organization, including its associated models and content.
- [Connect to private databases with AWS PrivateLink](https://docs.omni.co/connect-data/aws-privatelink.md): Set up AWS PrivateLink to connect Omni to databases in private VPCs using encrypted VPC endpoint connections.
- [Connect to private databases with Azure PrivateLink](https://docs.omni.co/connect-data/azure-privatelink.md): Set up Azure Private Link to connect Omni to databases in private Azure networks using encrypted private endpoint connections.
- [Connecting to Databricks using AWS or Azure PrivateLink](https://docs.omni.co/connect-data/databricks-privatelink.md): Connect Omni to a Databricks workspace over a private network using AWS PrivateLink or Azure Private Link endpoints.
- [Pulling Databricks metrics and metrics views into Omni](https://docs.omni.co/connect-data/databricks-unity-catalog-integration.md): Sync Databricks Unity Catalog metric views into Omni to query, visualize, and explore governed metrics.
- [Dynamic connection environments](https://docs.omni.co/connect-data/dynamic-environments.md): Allow users to switch database environments while modeling or building analyses.
- [Connect data](https://docs.omni.co/connect-data/index.md): Connect your data warehouse or database to Omni and configure connection settings
- [OAuth for database connections](https://docs.omni.co/connect-data/oauth/index.md): Authenticate individual users against your database with OAuth, enforcing database-level permissions in Omni.
- [Configuring Snowflake External OAuth with Okta](https://docs.omni.co/connect-data/oauth/snowflake/external-okta.md): Configure Snowflake External OAuth to authenticate users through Okta.
- [OAuth for Snowflake connections](https://docs.omni.co/connect-data/oauth/snowflake/index.md): Authenticate individual users against your Snowflake database with OAuth, enforcing database-level permissions in Omni.
- [Configuring native OAuth for Snowflake databases](https://docs.omni.co/connect-data/oauth/snowflake/native.md): Configure native Snowflake OAuth, allowing each Omni user to authenticate with their Snowflake credentials when running queries.
- [Offloading schemas](https://docs.omni.co/connect-data/offloading-schemas.md): Improve model performance by deferring the load of large or infrequently used schemas – like dbt virtual schemas – until they’re needed.
- [Connect to Redshift with AWS PrivateLink](https://docs.omni.co/connect-data/redshift-privatelink.md): Connect to Redshift Provisioned clusters or Redshift Serverless workgroups in AWS using PrivateLink
- [Restricting connection schemas](https://docs.omni.co/connect-data/schema-restriction.md): Limit which schemas are included in your Omni model to improve performance and control model scope.
- [Connecting Amazon Athena to Omni as a data source](https://docs.omni.co/connect-data/setup/athena.md): Learn how to create an access key or IAM role and connect your Amazon Athena data source to Omni.
- [Connecting Google BigQuery to Omni](https://docs.omni.co/connect-data/setup/bigquery.md): Learn how to create a service account, generate a private key, and connect your Google BigQuery project to Omni.
- [Connecting ClickHouse to Omni](https://docs.omni.co/connect-data/setup/clickhouse.md): Learn how to retrieve connection details and connect your ClickHouse database to Omni.
- [Connecting Databricks to Omni](https://docs.omni.co/connect-data/setup/databricks.md): Learn how to generate credentials, retrieve connection details, and connect your Databricks workspace to Omni.
- [Connecting Exasol to Omni](https://docs.omni.co/connect-data/setup/exasol.md): Learn how to create a database user, grant permissions, and connect your Exasol database to Omni.
- [Connect a database](https://docs.omni.co/connect-data/setup/index.md): Connect your data warehouse or database to Omni
- [Connecting MariaDB to Omni](https://docs.omni.co/connect-data/setup/mariadb.md): Learn how to create a database user, grant permissions, and connect your MariaDB database to Omni.
- [Connecting Microsoft SQL Server to Omni](https://docs.omni.co/connect-data/setup/microsoftsql.md): Learn how to retrieve connection details and connect your Microsoft SQL Server database to Omni.
- [Connecting MotherDuck to Omni](https://docs.omni.co/connect-data/setup/motherduck.md): Learn how to create an access token and connect your MotherDuck database to Omni.
- [Connecting MySQL to Omni](https://docs.omni.co/connect-data/setup/mysql.md): Learn how to create a database user, grant permissions, and connect your MySQL database to Omni.
- [Connecting Postgres to Omni](https://docs.omni.co/connect-data/setup/postgres.md): Learn how to create a database user, grant permissions, and connect your Postgres database to Omni.
- [Creating quick database connections with connection strings](https://docs.omni.co/connect-data/setup/quick-connect.md): Create database connections quickly by pasting a connection URI
- [Connecting Amazon Redshift to Omni](https://docs.omni.co/connect-data/setup/redshift.md): Learn how to create a database user, grant permissions, and connect your Amazon Redshift data warehouse to Omni.
- [Connecting Snowflake to Omni](https://docs.omni.co/connect-data/setup/snowflake.md): Learn how to create a database user, grant permissions, and connect your Snowflake data warehouse to Omni.
- [Connecting StarRocks to Omni](https://docs.omni.co/connect-data/setup/starrocks.md): Learn how to create a database user, grant permissions, and connect your StarRocks database to Omni.
- [Connecting to Snowflake using AWS or Azure PrivateLink](https://docs.omni.co/connect-data/snowflake-privatelink.md): Connect Omni to your Snowflake instance over a private network using AWS PrivateLink or Azure Private Link endpoints.
- [Snowflake semantic views](https://docs.omni.co/connect-data/snowflake-semantic-views.md): Import and query Snowflake semantic views directly in Omni
- [Connecting databases using SSH](https://docs.omni.co/connect-data/ssh-tunnels.md): SSH tunnels allow you to connect to a database in a private network or add another layer of network encryption.
- [Understanding timezone conversion & connection settings](https://docs.omni.co/connect-data/timezones.md): Learn how connection settings impact timezone conversion in your data, how to determine the converting timezone, and how to prevent conversion.
- [Troubleshooting connection issues](https://docs.omni.co/connect-data/troubleshooting.md): Diagnose and resolve common database connection errors in Omni, including cross-database queries, timeouts, and authentication.
- [Tracking recent work with the My Activity page](https://docs.omni.co/content/activity.md): Track your recent work and navigate back to workbooks, models, dashboards, and chat sessions you've been working on.
- [Developing content & models with Branch Mode](https://docs.omni.co/content/develop/branch-mode.md): Use Branch Mode to safely test model and content changes in isolation before merging them into your production environment.
- [Developing content with Draft-only mode](https://docs.omni.co/content/develop/drafts.md): Every Omni document has two states: draft and published.
- [Editing & publishing content](https://docs.omni.co/content/develop/index.md): Get started with Omni's content development workflows.
- [Common content and model publishing workflows](https://docs.omni.co/content/develop/workflows.md): Omni offers flexible workflows for drafting, reviewing, and publishing changes to documents and the models that back them.
- [Navigating content](https://docs.omni.co/content/navigate.md): The sidebar that displays on the left side of Omni makes it easy for you to find and navigate content in your instance.
- [Organizing content with folders & labels](https://docs.omni.co/content/organize.md): Organize dashboards and workbooks in Omni using folders for hierarchical access control and labels for cross-folder findability.
- [Searching content](https://docs.omni.co/content/search.md): Use content search with facets to quickly find specific dashboards, workbooks, and folders in your Omni instance.
- [October 20, 2023](https://docs.omni.co/demos/2023/20231020.md): Embedded user management & more table calculations
- [October 27, 2023](https://docs.omni.co/demos/2023/20231027.md): More embedding, KPI colors, ignored_views, Snowflake Info Schema App, & more
- [November 3, 2023](https://docs.omni.co/demos/2023/20231103.md): Google Sheets embedding, Transpose & measures on rows, Calculations refinement, & more
- [November 10, 2023](https://docs.omni.co/demos/2023/20231110.md): Dashboard drill iframe, Vis config overhaul, Table layout designs, & more
- [November 17, 2023](https://docs.omni.co/demos/2023/20231117.md): Seamless dashboard drill-down, UX odds & ends, Permission groups, & more
- [December 1, 2023](https://docs.omni.co/demos/2023/20231201.md): Embedded demo, Field picker 2.0, Topic permissions, Better binning, & more
- [December 8, 2023](https://docs.omni.co/demos/2023/20231208.md): Improved performance, SQL viewer permissions, Quick rollback CLI, & more
- [December 15, 2023](https://docs.omni.co/demos/2023/20231215.md): Content system, Custom homepage, Topic joins, Composed model history, & more
- [December 22, 2023](https://docs.omni.co/demos/2023/20231222.md): Gleam embed site, Early content permissions, Extends, & more
- [2023 Demos](https://docs.omni.co/demos/2023/index.md): Browse all 2023 Omni product demo videos covering embedding, content permissions, field pickers, dbt integration, and more.
- [January 5, 2024](https://docs.omni.co/demos/2024/20240105.md): Calcs GPT, Caching controls, Content permissions, & more
- [January 12, 2024](https://docs.omni.co/demos/2024/20240112.md): Adding free text, Better filtering, New calcs, & more
- [January 19, 2024](https://docs.omni.co/demos/2024/20240119.md): Field level permissions, Content validator, Access filters, Pivots & more
- [January 26, 2024](https://docs.omni.co/demos/2024/20240126.md): Calculations date math & pivot progress, Filtered dashboard emailing, dbt, & more
- [February 2, 2024](https://docs.omni.co/demos/2024/20240202.md): Slack scheduling, usage analytics and more!
- [February 9, 2024](https://docs.omni.co/demos/2024/20240209.md): Dashboard styling control designs, Content validator + Clickhouse, Spreadsheet calcs over pivots, & more
- [February 16, 2024](https://docs.omni.co/demos/2024/20240216.md): Complete CSS control for embed dashboard styling, Git workflows in data modeling,Filtering iframes, & more
- [February 23, 2024](https://docs.omni.co/demos/2024/20240223.md): Ridiculously fast embedded dashboards, Seamless dashboard refreshing, Bonus filter wiring & more
- [March 1, 2024](https://docs.omni.co/demos/2024/20240301.md): SCIM user management, Design polish, Connection refresh error improvements (with dbt), Simpler permissions, & more
- [March 8, 2024](https://docs.omni.co/demos/2024/20240308.md): ETL Freshness, Dynamic dbt schema switching, Period-Over-Period, & more
- [March 15, 2024](https://docs.omni.co/demos/2024/20240315.md): Looker migration, Tables (Row Height, Markdown), Conditional Formatting, & more
- [March 22, 2024](https://docs.omni.co/demos/2024/20240322.md): Dashboard PDF & CSV Downloads, Embed Themes (Gradients and Custom Fonts), & more
- [March 29, 2024](https://docs.omni.co/demos/2024/20240329.md): Text-to-Vis (Vega Lite GPT), Text-to-Query (GPT Workbooks), Admin User Impersonation (Sudo), & more
- [April 5, 2024](https://docs.omni.co/demos/2024/20240405.md): Dynamic dbt Schema Swapping, 3-Argument SUMIF, Cell References in SUMIF AND COUNTIF, & more
- [April 12, 2024](https://docs.omni.co/demos/2024/20240412.md): Incremental Model Promotion From the Workbook, Workbook Embedding, API + Schema Refresh Via API, & more
- [April 19, 2024](https://docs.omni.co/demos/2024/20240419.md): Dynamic Fields (Parameters), Sudo / Permissions Testing (Launched), In-Database Aggregate Awareness, & More
- [April 26, 2024](https://docs.omni.co/demos/2024/20240426.md): Compound Filters, Pull Requests + Model History Cleanup, Dynamic dbt Warehouses, & more
- [May 3, 2024](https://docs.omni.co/demos/2024/20240503.md): XLOOKUP, Embedded Workbooks, Dynamic Fields / Select Fields From Filters, & more
- [May 10, 2024](https://docs.omni.co/demos/2024/20240510.md): Table Styling, Excel Downloads With Formulas (Launched), Stickier Vis Config (Launched), & more
- [May 17, 2024](https://docs.omni.co/demos/2024/20240517.md): Filter by Query, Field Swappers on the Dashboard, New Permissions Reporting
- [May 24, 2024](https://docs.omni.co/demos/2024/20240524.md): Omni In-App Logging, Tab Rearranging and Styling, Single-Dashboard-Only User Permission, & more
- [May 31, 2024](https://docs.omni.co/demos/2024/20240531.md): Branch Mode + Git, Single-Tile Scheduling, Dynamic dbt Schema Improvements, & more
- [June 7, 2024](https://docs.omni.co/demos/2024/20240607.md): Dynamic Tables - Links and Events, Default Row Level Access Controls, Snowflake Native App, & more
- [June 14, 2024](https://docs.omni.co/demos/2024/20240614.md): AI Copilot + History, Environment Variables for dbt, Legend Controls & more
- [June 21, 2024](https://docs.omni.co/demos/2024/20240621.md): Workbook UX (+ Tab Reordering), Vis Config Stickiness, Inline Images in Tables, & More
- [June 28, 2024](https://docs.omni.co/demos/2024/20240628.md): Alerts, Email Bursting (User Attributes in Schedules), AI Querying, & More
- [July 8, 2024](https://docs.omni.co/demos/2024/20240708.md): Content as code, Drill modals in workbook & dbt pushdown
- [July 12, 2024](https://docs.omni.co/demos/2024/20240712.md): Query API alpha, table enhancements, controls for controls and lots more!
- [July 19, 2024](https://docs.omni.co/demos/2024/20240719.md): IDE error auto-fixing, refresh schema on schedule, KPI styling enhancements, improved SQL auto-complete and lots more
- [July 26, 2024](https://docs.omni.co/demos/2024/20240726.md): IDE redesigns, lots of filter work, and much more
- [August 2, 2024](https://docs.omni.co/demos/2024/20240802.md): Dashboard themes, dashboard vanity URLs, XLOOKUP portability, in_query, single-use views in topics and much more!
- [August 9, 2024](https://docs.omni.co/demos/2024/20240809.md): Sticky visualization settings, better auto-vis, unlimited downloads, and more
- [August 16, 2024](https://docs.omni.co/demos/2024/20240816.md): Unlimited downloads, even more custom visualizations in markdown, better advanced visualization UX, and more
- [August 23, 2024](https://docs.omni.co/demos/2024/20240823.md): Embed dashboard linking, send to Google Sheets, calculations on SQL, and 11 more!
- [August 30, 2024](https://docs.omni.co/demos/2024/20240830.md): Drill queries, dashboard links, TEXT() promotion, and more
- [September 6, 2024](https://docs.omni.co/demos/2024/20240906.md): Workbook Drafts Preview, SFTP Scheduling, Embedded Content Management, and More
- [September 13, 2024](https://docs.omni.co/demos/2024/20240913.md): Global color palettes, cross-tab spreadsheet references and 12 (?!) more
- [September 20, 2024](https://docs.omni.co/demos/2024/20240920.md): Exploding pivots, embedded dashboard sharing, global color palettes, and much more
- [September 27, 2024](https://docs.omni.co/demos/2024/20240927.md): Embedded saving and sharing, map regions, period-over-period measures, Snowflake native deployment, and much more
- [October 4, 2024](https://docs.omni.co/demos/2024/20241004.md): dbt SQL mode, schema refresh via git, and new content permissions
- [October 11, 2024](https://docs.omni.co/demos/2024/20241011.md): New model controls for timeframes and filter value labels, more visualization configuration, and a nice demo of richer dashboard styling
- [October 18, 2024](https://docs.omni.co/demos/2024/20241018.md): Smart IDE auto-complete, map regions, more dashboard CSS, embedded dashboard scheduling,
- [October 25, 2024](https://docs.omni.co/demos/2024/20241025.md): Vis Config Locking, More Smart Autocomplete, Model Speeds-Ups and Some Table Polish
- [November 1, 2024](https://docs.omni.co/demos/2024/20241101.md): User Specific Timezones, AI Query Tuning, Versioning Dashboards, and Much More
- [November 8, 2024](https://docs.omni.co/demos/2024/20241108.md): AI Tuning, Lots of Visualization Improvements, Better Date Filtering, and Our First Customer Demo
- [November 15, 2024](https://docs.omni.co/demos/2024/20241115.md): Flexible Totals (Including Dimensions and Calc), Calculations with Controls, Better SQL, and More
- [November 22, 2024](https://docs.omni.co/demos/2024/20241122.md): *Actual* Spreadsheets, Mapping Vis Colors in the Data Model, and Much More
- [December 2, 2024](https://docs.omni.co/demos/2024/20241202.md): Simpler dashboard URLs, tab descriptions, calc descriptions, table and vis view, topic files, and more
- [December 6, 2024](https://docs.omni.co/demos/2024/20241206.md): dbt Reader, Nearly-Alpha Spreadsheets, Inline IDE Auto-Correct, and Lots More
- [December 13, 2024](https://docs.omni.co/demos/2024/20241213.md): Color Modeling Launch, More Excel Functions, Dynamic Column Modeling, Drafts Refinement and Lots of Polish
- [December 20, 2024](https://docs.omni.co/demos/2024/20241220.md): Controls in Tiles, Topic-less AI, and Lots of Small Wins Throughout the App
- [2024 Demos](https://docs.omni.co/demos/2024/index.md): Browse all 2024 Omni product demo videos covering AI queries, dashboard themes, custom visualizations, embedding, and more.
- [January 3, 2025](https://docs.omni.co/demos/2025/20250103.md): Bunch of AI Improvements, More/Better Usage Data, Concurrency Improvements, and More
- [January 10, 2025](https://docs.omni.co/demos/2025/20250110.md): Snowflake Cortex Columns, Sub-Folders (Early), Editing dbt Models, and Much More
- [January 17, 2025](https://docs.omni.co/demos/2025/20250117.md): Lots of API, Vis Series Coloring, AI Query Summary, Model Usage Analytics, and Lots of Polish and Pretty Vis
- [January 24, 2025](https://docs.omni.co/demos/2025/20250124.md): CSV Upload (Preview), AI Summary Tiles, Advanced Vis UI Builder, Embed URL Sharing, and More
- [January 31, 2025](https://docs.omni.co/demos/2025/20250131.md): Smart Labels, Editing Vis from the Dashboard, AI Chart Building, Cache Busting API, and More
- [February 6, 2025](https://docs.omni.co/demos/2025/20250206.md): AI Filters, Dashboard Performance Reports, Clear Time Filters, Per-User Attributes Page, Our First Spreadsheet App, and More
- [February 14, 2025](https://docs.omni.co/demos/2025/20250214.md): CSV Upload Soft Launch, Instant Filters, More Color Work, Better Chart Labels, and More
- [February 21, 2025](https://docs.omni.co/demos/2025/20250221.md): CSVs in the Data Warehouse (and Editable in a Spreadsheet!), Chart Color Promotion, and 13 More Demos
- [February 28, 2025](https://docs.omni.co/demos/2025/20250228.md): Lots of CSV Upload and Spreadsheets, Heatmaps, Color Promotion, and Lots More
- [March 7, 2025](https://docs.omni.co/demos/2025/20250307.md): Docs AI, Editing Visualizations Directly on the Dashboard, Unlimited Schedules and Downloads, dbt Environment Clean-up and More
- [March 14, 2025](https://docs.omni.co/demos/2025/20250314.md): Guest Vis Demo, Editing Vis from the Dashboard, CSV Upload Edit Workflows, a Slack Emoji App, and More
- [March 21, 2025](https://docs.omni.co/demos/2025/20250321.md): New Filter Controls, Dataset Builders, Lots of Custom Vis, and Plenty More
- [March 28, 2025](https://docs.omni.co/demos/2025/20250328.md): AI Progress Everywhere (Field Context, AI API, Training Docs), New DB Throttling Controls, Content in Branches, and More
- [April 4, 2025](https://docs.omni.co/demos/2025/20250404.md): Filter on Calcs, AI Retry, AI Evals, Query View UX, Google Sheets Export, and Much More
- [April 11, 2025](https://docs.omni.co/demos/2025/20250411.md): Dynamic Model Layers, Embed Nav Builder, Better AI Retry, and More Analytics
- [April 18, 2025](https://docs.omni.co/demos/2025/20250418.md): Lots of Mini Apps, Better IDE Search, Multi-tab Spreadsheets, Topic and View Visual Editor, More AI and More
- [April 25, 2025](https://docs.omni.co/demos/2025/20250425.md): AI Mode + More AI, dbt Description Push Down, IDE Search, Table Styling and More
- [May 2, 2025](https://docs.omni.co/demos/2025/20250502.md): More AI (Ai Mode Launch, New Slackbot), Custom Embed Nav, More API, and Handful of New Custom Vis
- [May 9, 2025](https://docs.omni.co/demos/2025/20250509.md): Blobby Mobile, An AI Demo on Our Actual Data, Front End Topic Building, API Mini Apps, Scheduler APIs, and Much More
- [May 16, 2025](https://docs.omni.co/demos/2025/20250516.md): Embedded AI, Tiny Grid Dashboard Launch, More AI (Chart Config, Field Descriptions), Or Access Grants, Complex Date Filters, and More
- [May 23, 2025](https://docs.omni.co/demos/2025/20250523.md): AI Field Creation, AI MCP v0, Streaming AI Results, Level of Detail Calculation, Lots of Dashboard Improvements, and More
- [May 30, 2025](https://docs.omni.co/demos/2025/20250530.md): dbt Tests in AI Context, Blobby Chrome Extension, Workbook Quick Starts, Embed Folder Naming, Performance Work, and More
- [June 6, 2025](https://docs.omni.co/demos/2025/20250606.md): Omni MCP 1.0, Spreadsheets Getting Closer to Release, New Model Debug Modes, Markdown Vis AI, and More
- [June 13, 2025](https://docs.omni.co/demos/2025/20250613.md): Omni MCP Getting Close, AI Summary Vis, Trellis Charts, Faster Workbooks, Custom Blobby, and More
- [June 20, 2025](https://docs.omni.co/demos/2025/20250620.md): EAV Modeling, AI with Subqueries, Paginated PDFs, Trellis Soon, MCP Soon, and Lots More
- [June 27, 2025](https://docs.omni.co/demos/2025/20250627.md): Automated Data Modeling from AI Sessions, Instant Dashboard Filters, Unlimited Paginated Data Tables, Unfurled Tables in Schedules, and 15 More!
- [July 3, 2025](https://docs.omni.co/demos/2025/20250703.md): Fill Gaps in Any Date Series, More AI Auto-Modeling, More Model Permissions, and More
- [July 11, 2025](https://docs.omni.co/demos/2025/20250711.md): DB OAuth Passthrough (soon), Lots of Spreadsheets, Unlimited Excel Downloads, More Better Vis, Embed Error Eventing, and More
- [July 18, 2025](https://docs.omni.co/demos/2025/20250718.md): Agent Blobby, Dashboard AI, Embedded AI Guest Demo, Topic Builder UI, Global Cache Busting Button, Plus Lots of Vis
- [July 25, 2025](https://docs.omni.co/demos/2025/20250725.md): A big pile of your most requested features this week!
- [August 1, 2025](https://docs.omni.co/demos/2025/20250801.md): dbt Exposures, New Embed Demo, Guest Learning Microsite, Dashboard Summarization, and More
- [August 8, 2025](https://docs.omni.co/demos/2025/20250808.md): Blobby Builds a Dashboard, More AI Everywhere, Snowflake Semantic Layer Sync, Top N + Other, and More
- [August 15, 2025](https://docs.omni.co/demos/2025/20250815.md): Blobby Learns Filtered Measures, Bunch of API (Including A+ Docs), New SQL Mode, Databricks Metrics Views, and Tons of Quality of Life Work
- [August 22, 2025](https://docs.omni.co/demos/2025/20250822.md): Dynamic Dashboard Spreadsheets, Spreadsheet Drill, Google Sheets Export, and lots of Blobby (Dashboard AI, Smart Filters, and Dash Search)
- [August 29, 2025](https://docs.omni.co/demos/2025/20250829.md): AI Session Saving, IDE Folders, New SQL Experience, and Lots More
- [September 5, 2025](https://docs.omni.co/demos/2025/20250905.md): Custom Permissions, YAML Editor Guest Demo, Independent Chart Stacking Controls, and More Quality of Life
- [September 12, 2025](https://docs.omni.co/demos/2025/20250912.md): A New User Attribute Debugger UI, MCP Oauth, Vis Reaggregation Alpha, and More
- [September 19, 2025](https://docs.omni.co/demos/2025/20250919.md): dbt Semantic Layer, MCP OAuth, Model Blame, AI Session URLs, Huge Performance Wins for Vis, and 11 More!
- [September 26, 2025](https://docs.omni.co/demos/2025/20250926.md): Fast Rendering of Giant Visualizations, New Schema Model Navigation, Mapping Result GeoJSON, and More
- [October 3, 2025](https://docs.omni.co/demos/2025/20251003.md): External Development IDE, Lots of Blobby, Moving Dashboard Filters, Localization, SQL Preamble, and 15 (!!!) More
- [October 10, 2025](https://docs.omni.co/demos/2025/20251010.md): Docs in the IDE, Cube Building, Lots of AI, External Model Dev Launch, dbt Metrics, Spreadsheet Export, and More
- [October 17, 2025](https://docs.omni.co/demos/2025/20251017.md): AI Workflows, ERD Diagrams, CSS Previews, New Filter UX, and More Blobbies Than You Can Handle
- [October 24, 2025](https://docs.omni.co/demos/2025/20251024.md): Tons of Dashboard Work, More AI, Better Conditional Formatting, and More
- [October 31, 2025](https://docs.omni.co/demos/2025/20251031.md): Tons of Dashboard Work (AI Summaries, Custom Errors, Localization, and More), More Cubes, and Getting Close on Custom Permissions
- [November 7, 2025](https://docs.omni.co/demos/2025/20251107.md): Stacked Bar Sorting, Deep Research Launch, Topic Scoped Fields in the UI, Lots of Performance Work and More
- [November 14, 2025](https://docs.omni.co/demos/2025/20251114.md): Dashboard View As, Dashboard Summary AI Getting Close, New Docs, Better Query Killing and More
- [November 21, 2025](https://docs.omni.co/demos/2025/20251121.md): Tons of New AI (Modeling, Visualization, User Attributes), Dynamic Top N, Pull Request Required Dashboards, Azure, and More!!
- [December 1, 2025](https://docs.omni.co/demos/2025/20251201.md): Blobby Learns to Search Google Drive, Tons of AI (Vis, Calcs, IDE), More Dash Containers, ADBC, and More
- [December 5, 2025](https://docs.omni.co/demos/2025/20251205.md): Tabbed Dash Beta, Per User AI, Lots More AI, Ridiculously Performant Giant Vis, Pie Rebuild Almost Launch, and More
- [December 12, 2025](https://docs.omni.co/demos/2025/20251212.md): Dashboard tabs, request access, filter layout, zoom, drag rebuild, complex filters, custom emojis, and 22 total demos.
- [December 19, 2025](https://docs.omni.co/demos/2025/20251219.md): BYOLLM, AI Slash Commands, SQL Totals, Duration Fields, Tabs Beta, Query Snowflake Semantic Views, and So Much More (22 Videos!)
- [2025 Demos](https://docs.omni.co/demos/2025/index.md): Browse all 2025 Omni product demo videos covering AI agents, MCP, spreadsheets, custom permissions, dashboards, and more.
- [January 2, 2026](https://docs.omni.co/demos/2026/20260102.md): Slackbot v0, Field Picker Multi-Level Nesting, Tons of Perf, SQL Ai Field Suggestions, Google Drive in Blobby (25 Demos to Start 2026)
- [January 9, 2026](https://docs.omni.co/demos/2026/20260109.md): Tons of AI (BYO LLM, Model Debugger, KPI Vis, Cron), and 23 Other Demos (Lots of Quality of Life)
- [January 16, 2026](https://docs.omni.co/demos/2026/20260116.md): Lots More AI (Homepage AI, Multi-Vis), Sankey Launch, Multi-Fact Topics, Paginated Subtotals and Huge Bucket of QOL Work
- [January 23, 2026](https://docs.omni.co/demos/2026/20260123.md): Selectable Table Cells, Dashboard Filter Buttons and Custom UX, Dashboard Tab Vanity URLs, and Plenty More
- [January 30, 2026](https://docs.omni.co/demos/2026/20260130.md): Blobby Builds a Dashboard, Better AI Streaming, Funnel Vis, and Way More AI + Everything Else
- [February 6, 2026](https://docs.omni.co/demos/2026/20260206.md): 34 Demos - A Peek into the Future of Omni (Hint, Lots of AI)
- [February 13, 2026](https://docs.omni.co/demos/2026/20260213.md): Blobby Joins the Modeling Team, Omni Becomes Your MCP, AI in All Views and Fields, Visual Drilling, New Dashboard Search, and More
- [February 20, 2026](https://docs.omni.co/demos/2026/20260220.md): Input Columns, Blobby Learns to Validate Work, AI Quickstarts, and More
- [February 27, 2026](https://docs.omni.co/demos/2026/20260227.md): AI Modeling, Cell-by-Cell Conditional Formatting, Dynamic Dashboard Table Height, Better AI Feedback, and More
- [March 6, 2026](https://docs.omni.co/demos/2026/20260306.md): AI dashboard building, forecasting, modeling, Salesforce MCP, treemaps, custom maps, button filters, and more new features.
- [March 13, 2026](https://docs.omni.co/demos/2026/20260313.md): Input Columns, Column Editing, GSheet Live Connect, and Tons of AI
- [March 20, 2026](https://docs.omni.co/demos/2026/20260320.md): Blobby was learning this week, plus custom formats, selective filter faceting, and more
- [March 27, 2026](https://docs.omni.co/demos/2026/20260327.md): Blobby Slackbot, Custom Modeled Formats (Conditional Formatting, Markdown, and HTML), HTML Dashboards, and More (Lots of AI)
- [April 3, 2026](https://docs.omni.co/demos/2026/20260403.md): Blobby Gets Unleashed, CLI + Some Use Cases, New Filter UX, Content Validator UX Lift, and Tons of Dashboard Work
- [April 10, 2026](https://docs.omni.co/demos/2026/20260410.md): A Model That Improves Itself, Topic ERDs, Blobby Build Dashboard Filters, Named Formats, Gigantic, Formatted Spreadsheets, and Lots More AI
- [April 17, 2026](https://docs.omni.co/demos/2026/20260417.md): Vis Layers, AI Analytics and Cost Data, dbt APIs, and Bunch of AI Improvements
- [April 24, 2026](https://docs.omni.co/demos/2026/20260424.md): Blobby Vibe Codes an AI App (HTML Dashboards), Tons of Content Validator, Dynamic Session Length, and Tons of Vis (AI Vision, Slackbot Vis, and More Layers Work
- [2026 Demos](https://docs.omni.co/demos/2026/index.md): Browse all 2026 Omni product demo videos covering AI modeling, input columns, custom formats, CLI tools, and more features.
- [Omni Demos](https://docs.omni.co/demos/index.md): Watch weekly video demos of new and upcoming Omni features, including AI, dashboards, modeling, embedding, and platform updates.
- [Omni agent skills](https://docs.omni.co/developers/agent-skills/index.md): Extend your IDE with Omni analytics skills for building models, running queries, managing content, and more.
- [Installing Omni agent skills](https://docs.omni.co/developers/agent-skills/install.md): Install Omni agent skills in Claude Code, Cursor, Cortex Code, and skills.sh-compatible agents.
- [Omni agent skills reference](https://docs.omni.co/developers/agent-skills/skills.md): Reference for all Omni agent skills, agents, and Cursor rules included in the plugin.
- [Updating Omni agent skills](https://docs.omni.co/developers/agent-skills/update.md): Update Omni agent skills and troubleshoot cached or stale plugin versions.
- [Commands](https://docs.omni.co/developers/cli/commands.md): Reference for all Omni CLI commands, including configuration, API operations, and global flags.
- [Omni CLI](https://docs.omni.co/developers/cli/index.md): Manage your Omni instance from the terminal — query data, manage models, administer users, and automate workflows.
- [Installing the Omni CLI](https://docs.omni.co/developers/cli/install.md): Install the Omni CLI on macOS, Linux, or Windows.
- [Omni CLI quickstart](https://docs.omni.co/developers/cli/quickstart.md): Configure the Omni CLI and run your first commands.
- [Configuring embed integrations](https://docs.omni.co/embed/admin/integrations.md): Configure third-party integrations like FullStory and LogRocket for your embedded Omni instance.
- [Managing embed secrets](https://docs.omni.co/embed/admin/secrets.md): Create, view, edit, and delete embed secrets for your organization.
- [Managing user sessions](https://docs.omni.co/embed/admin/sessions.md): View and delete Omni embed user sessions.
- [Managing embed users](https://docs.omni.co/embed/admin/users.md): View, manage, and impersonate users in your embedded Omni application.
- [Embedding Omni best practices](https://docs.omni.co/embed/best-practices.md): Learn how to develop a secure, enjoyable embedded Omni experience for your users.
- [Embedding the Omni Agent](https://docs.omni.co/embed/customization/ai-chat.md): Integrate a whitelabeled version of the Omni Agent directly into your embedded application.
- [Create Mode for embedded analytics](https://docs.omni.co/embed/customization/create-mode.md): Enable the full Omni experience - creating, sharing, and navigating content - for your embedded users.
- [Configuring email deliveries in embedded Omni](https://docs.omni.co/embed/customization/deliveries.md): Allow users in your embedded Omni instance to schedule or set alerts on documents.
- [Linking to other content in embedded Omni](https://docs.omni.co/embed/customization/link-content.md): Add interactivity to your embedded Omni application by linking to other content.
- [Applying custom themes to your embedded Omni instance](https://docs.omni.co/embed/customization/themes.md): Create a seamless, cohesive analytics experience for your users by applying custom themes.
- [Setting up custom domains for embed](https://docs.omni.co/embed/customization/vanity-domains.md): Set up custom vanity domains for embedded Omni dashboards to enable first-party cookies and cohesive branding across content.
- [ai:chat-start embed event](https://docs.omni.co/embed/events/ai-chat-start.md): Emitted by Omni when an AI chat session begins.
- [appearance:mode embed event](https://docs.omni.co/embed/events/appearance-mode.md): Triggers a color scheme change of the embedded Omni session.
- [Consuming embed events sent by Omni](https://docs.omni.co/embed/events/consume.md): Consume events emitted by Omni to trigger interactions in your application.
- [dashboard:download embed event](https://docs.omni.co/embed/events/dashboard-download.md): Emitted by Omni when a user downloads an embedded dashboard.
- [dashboard:filter-change-by-url-parameter embed event](https://docs.omni.co/embed/events/dashboard-filter-change-by-url-parameter.md): Triggers the change of a filter value on an embedded dashboard.
- [dashboard:filter-changed embed event](https://docs.omni.co/embed/events/dashboard-filter-changed.md): Emitted by Omni when a user adds, removes, or updates a filter on an embedded document.
- [dashboard:filters embed event](https://docs.omni.co/embed/events/dashboard-filters.md): Emitted by Omni when a user applies a filter to an embedded document.
- [dashboard:tile-download embed event](https://docs.omni.co/embed/events/dashboard-tile-download.md): Emitted by Omni when a user downloads a given tile on a dashboard.
- [dashboard:tile-drill embed event](https://docs.omni.co/embed/events/dashboard-tile-drill.md): Emitted by Omni when a user performs a drill action on a dashboard tile.
- [error embed event](https://docs.omni.co/embed/events/error.md): Emitted by Omni when a detectable error occurs on an embedded page.
- [Embed events](https://docs.omni.co/embed/events/index.md): Build interactive experiences in your embedded Omni application with JavaScript events.
- [navigate embed event](https://docs.omni.co/embed/events/navigate.md): Triggers a redirect to the path specified in the payload.
- [navigation:home embed event](https://docs.omni.co/embed/events/navigation-home.md): Emitted by Omni when a user clicks the logo or home link in the navigation header.
- [page-changed embed event](https://docs.omni.co/embed/events/page-changed.md): Emitted by Omni when the URL of a page changes.
- [Sending embed events to Omni](https://docs.omni.co/embed/events/send.md): Trigger actions in an embedded Omni application by sending events into the Omni iframe.
- [sidebar:open embed event](https://docs.omni.co/embed/events/sidebar-open.md): Emitted by Omni when a user clicks the mobile menu button.
- [size embed event](https://docs.omni.co/embed/events/size.md): Emitted by Omni on dashboard load to give the size of the frame, allowing users to dynamically size the iframe.
- [status embed event](https://docs.omni.co/embed/events/status.md): Emitted by Omni to indicate the status of the dashboard to the parent frame.
- [Sending embed events from Omni visualizations](https://docs.omni.co/embed/events/visualizations.md): Trigger actions in your application by emitting events from embedded Omni table and Markdown visualizations.
- [Embedding Omni in external applications](https://docs.omni.co/embed/index.md): Embed Omni dashboards and analytics in external applications with row-level permissions, SSO, and full theme customization.
- [Embedding limitations](https://docs.omni.co/embed/limitations.md): Understand current limitations of Omni embedding, including session length, supported browsers, content types, and feature gaps.
- [Embedding Omni quickstart](https://docs.omni.co/embed/quickstart.md): Get up and running with your embedded Omni application.
- [Customizing embed users and sessions with URL parameters](https://docs.omni.co/embed/setup/customize.md): Customize embed users and sessions with Omni embed parameters.
- [Generating embedded user sessions](https://docs.omni.co/embed/setup/index.md): Set up your embedding infrastructure and generate user sessions.
- [Setting up embed with standard SSO](https://docs.omni.co/embed/setup/standard-sso.md): Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.
- [Testing embed URL parameters with the URL builder](https://docs.omni.co/embed/setup/test-urls.md): Use the embed URL builder to test and generate embed URLs for internal use.
- [Setting up embed with 2-step SSO](https://docs.omni.co/embed/setup/two-step-sso.md): Set up 2-step SSO for Omni embedding using a POST request to generate a session token, then redeem it via a login URL.
- [accessBoost](https://docs.omni.co/embed/setup/url-parameters/accessBoost.md): Enables AccessBoost for the embedded dashboard.
- [connectionRoles](https://docs.omni.co/embed/setup/url-parameters/connectionRoles.md): Specifies the level of access users will have to all models associated with a connection.
- [contentPath](https://docs.omni.co/embed/setup/url-parameters/contentPath.md): Defines the starting page when the embed user logs into the iframe.
- [customTheme](https://docs.omni.co/embed/setup/url-parameters/customTheme.md): Defines custom theme properties for styling embedded dashboards.
- [customThemeId](https://docs.omni.co/embed/setup/url-parameters/customThemeId.md): Specifies the custom theme to use in the resulting embed session. Used to apply your own custom styles.
- [email](https://docs.omni.co/embed/setup/url-parameters/email.md): Populates the from email for entity users when sharing content or sending deliveries.
- [entity](https://docs.omni.co/embed/setup/url-parameters/entity.md): Defines a user group identifier used to associate the resulting embed user with a larger group.
- [entityFolderContentRole](https://docs.omni.co/embed/setup/url-parameters/entityFolderContentRole.md): Specifies the content role the embed user will be given to their shared entity folder.
- [entityFolderGroupContentRole](https://docs.omni.co/embed/setup/url-parameters/entityFolderGroupContentRole.md): Specifies the content role the embed entity group will be given to their shared entity folder.
- [entityFolderLabel](https://docs.omni.co/embed/setup/url-parameters/entityFolderLabel.md): Updates the embed user's associated entity folder label.
- [entityGroupLabel](https://docs.omni.co/embed/setup/url-parameters/entityGroupLabel.md): Updates the embed user's associated entity group label.
- [externalId](https://docs.omni.co/embed/setup/url-parameters/externalId.md): Creates a unique ID for the embed user.
- [filterSearchParam](https://docs.omni.co/embed/setup/url-parameters/filterSearchParam.md): Specifies the filters to apply for the embedded content.
- [groups](https://docs.omni.co/embed/setup/url-parameters/groups.md): Associates the resulting embed user with existing user groups in your Omni instance.
- [Embed URL parameters reference](https://docs.omni.co/embed/setup/url-parameters/index.md): Create and customize user sessions by including URL parameters in your embed requests.
- [linkAccess](https://docs.omni.co/embed/setup/url-parameters/linkAccess.md): Controls which Omni dashboards can be linked to from the embedded dashboard.
- [mode](https://docs.omni.co/embed/setup/url-parameters/mode.md): Defines the type of access users will have to Omni in the iframe.
- [modelRoles](https://docs.omni.co/embed/setup/url-parameters/modelRoles.md): Defines the level of access users will have for individual models in a connection.
- [name](https://docs.omni.co/embed/setup/url-parameters/name.md): Defines a non-unique name for the embed user's name property.
- [nonce](https://docs.omni.co/embed/setup/url-parameters/nonce.md): A unique 32-character string that defines the embed login URL.
- [prefersDark](https://docs.omni.co/embed/setup/url-parameters/prefersDark.md): Controls whether the resulting embed session has a light or dark mode appearance.
- [preserveEntityFolderContentRole](https://docs.omni.co/embed/setup/url-parameters/preserveEntityFolderContentRole.md): Retains the embed user's existing entity folder content role.
- [theme](https://docs.omni.co/embed/setup/url-parameters/theme.md): Customizes the styles of the resulting embed session with a built-in Omni application theme.
- [uiSettings](https://docs.omni.co/embed/setup/url-parameters/uiSettings.md): Controls general settings of the application in embed.
- [userAttributes](https://docs.omni.co/embed/setup/url-parameters/userAttributes.md): Applies user attributes to the embed user.
- [Omni Best Practices](https://docs.omni.co/getting-started/best-practices.md): A checklist for building clean, performant, and user-friendly Omni environments.
- [From workbook to modeling: Setting up Omni](https://docs.omni.co/getting-started/developers.md): Intended for developers, this five-part video series will show you how to start building content and models in Omni.
- [Keyboard shortcuts](https://docs.omni.co/getting-started/keyboard-shortcuts.md): A compiled list of shortcuts throughout the app.
- [Onboarding to Omni as a Viewer](https://docs.omni.co/getting-started/viewers.md): Intended for viewers, this six-part video series will help you get started with viewing dashboard content in Omni.
- [Improving AI answer quality](https://docs.omni.co/guides/ai/improve-ai-answer-quality.md): Learn practical steps to improve AI answer quality in Omni by optimizing data modeling, testing AI responses, and monitoring usage patterns.
- [Tuning Omni AI for cost and quality](https://docs.omni.co/guides/ai/tuning-cost-quality.md): Balance AI cost and quality for your organization by combining ai_settings parameters into profiles that fit your use cases.
- [Set up connection environments with the API](https://docs.omni.co/guides/api/connection-environments.md): Configure dev and prod connection environments with the API.
- [Build a data lineage integration with the Omni API](https://docs.omni.co/guides/api/data-lineage-integration.md): Build OpenMetadata / DataHub integrations using the Omni REST API
- [Port SQL queries into an Omni workbook via API](https://docs.omni.co/guides/api/port-sql-queries-omni-api.md): Use a bash script to build Omni tabs and tiles via the Omni API.
- [Run document queries with the Query API](https://docs.omni.co/guides/api/run-document-queries.md): Programmatically run document queries with the Omni API.
- [Enforce database RBAC in Omni with connection environments](https://docs.omni.co/guides/connections/enforce-database-rbac.md): Use database-level roles to manage data access, audit logging, and resource allocation in Omni.
- [Filter dashboard charts with calculated fields](https://docs.omni.co/guides/dashboards/calculated-field-filter.md): Create a dashboard filter using a calculated field in the underlying query.
- [Dashboard best practices](https://docs.omni.co/guides/dashboards/dashboarding-best-practices.md): Tips and patterns from the Omni team to help you build dashboards your whole org actually wants to use.
- [Connect a chat agent to Omni AI for embed experiences](https://docs.omni.co/guides/embed/ai-chat-agent.md): Use the Omni AI API or MCP Server to connect a custom chat agent that queries data on behalf of embed users, scoped to each user's permissions.
- [Embedding Omni into internal applications](https://docs.omni.co/guides/embed/omni-in-internal-app.md): Embed Omni into internal apps such as wikis, Salesforce, Notion, or any other website that supports iframes.
- [Embedding Omni in your Notion instance](https://docs.omni.co/guides/embed/omni-in-notion.md): Embed Omni dashboards in Notion documents using iframes.
- [Embedding Omni in your Salesforce instance](https://docs.omni.co/guides/embed/omni-in-salesforce.md): Embed static and dynamic Omni dashboards in Salesforce using Visualforce pages and tabs.
- [Resolve 'Join fans out data without primary key' errors](https://docs.omni.co/guides/errors/fan-out-without-pk.md): Learn to account for fan out in table joins.
- [Guides](https://docs.omni.co/guides/index.md): Step-by-step tutorials and best practices for getting the most out of Omni.
- [Improving date flexibility with templated filters](https://docs.omni.co/guides/modeling/date-flexibility-templated-filters.md): A guide to going beyond the out of the box controls to give users more flexibility to manipulate dates by utilizing templated filters.
- [Join to the same table twice](https://docs.omni.co/guides/modeling/join-to-same-table.md): Use aliases to build tables named with language already familiar to your users.
- [Local development with the model editor CLI](https://docs.omni.co/guides/modeling/local-development.md): Edit Omni model YAML files locally in your preferred editor with real-time sync back to Omni.
- [Organize fields with nested groups](https://docs.omni.co/guides/modeling/nested-field-groups.md): Keep workbook field browsers navigable by grouping related fields.
- [Push Omni topics to Databricks as metric views](https://docs.omni.co/guides/modeling/push-to-databricks-metric-views.md): Use the Omni Python SDK to generate Databricks metric view DDL from an Omni topic.
- [Deploying Omni at scale with shared model extensions](https://docs.omni.co/guides/modeling/scaled-deployments-shared-model-extensions.md): Learn how to use Shared Model Extensions to manage large Omni deployments across multiple data teams.
- [Apply a filter to a single measure](https://docs.omni.co/guides/modeling/single-field-filter.md): Add a filter to just one measure in a given query.
- [Using Level of Detail functions for cohorting analysis](https://docs.omni.co/guides/patterns/build-cohort-analysis-using-level-of-detail.md): Utilize Level of Detail fields to create a cohort analysis for determining how different cohorts of user perform over time.
- [Using AI to build a cohort analysis with month offset](https://docs.omni.co/guides/patterns/cohort-analysis-month-offset-ai.md): Use the Omni Agent to create a cohort analysis that tracks user behavior over time using monthly offsets.
- [Optimizing AI context for fintech and banking](https://docs.omni.co/guides/patterns/optimizing-ai-context-for-fintech.md): A hands-on guide to configuring AI context at the model, topic, and view levels using a fintech example.
- [Optimizing AI context for retail and ecommerce](https://docs.omni.co/guides/patterns/optimizing-ai-context-for-retail-and-ecommerce.md): A hands-on guide to configuring AI context at the model, topic, and view levels using a retail and ecommerce example.
- [Optimizing AI context for SaaS and sales operations](https://docs.omni.co/guides/patterns/optimizing-ai-context-for-saas-and-sales-operations.md): A hands-on guide to configuring AI context at the model, topic, and view levels using a SaaS and Salesforce example.
- [Optimizing AI context for support operations](https://docs.omni.co/guides/patterns/optimizing-ai-context-for-support-operations.md): Configure AI context across model, topic, and view levels to optimize Omni's AI for support operations.
- [Optimizing AI context for Media and AdTech](https://docs.omni.co/guides/patterns/optimizing-ai-context-media-and-adtech.md): A hands-on guide to configuring AI context at the model, topic, and view levels using a Media and AdTech example.
- [Building a basic cohort analysis with pivots](https://docs.omni.co/guides/patterns/simple-cohort-analysis-pivot.md): Build a cohort analysis using pivots in Omni to track user retention, engagement, and behavior over time.
- [Cohort analysis using a thin spine](https://docs.omni.co/guides/patterns/spine-cohort-analysis.md): Build cohort analyses using thin dimensional spines.
- [Thin dimensional spine for multi-fact event analysis](https://docs.omni.co/guides/patterns/thin-dimension-spine.md): Analyze multiple event streams together without fanout using a thin dimensional spine.
- [Previewing dbt Changes in Omni before Merging](https://docs.omni.co/guides/previewing-dbt-changes.md): This guide explains how to preview dbt model changes, including net-new tables and views, within an Omni development environment. By decoupling the Omni git branch from the dbt branch selector, you can safely validate data and assess downstream impacts before merging changes to your production branc…
- [Add links to visualizations](https://docs.omni.co/guides/visualizations/add-links.md): Encourage self-service data exploration by adding links to other dashboards to your visualizations.
- [Customize drill fields](https://docs.omni.co/guides/workbooks/custom-drill-fields.md): Curate the columns displayed to users when drilling.
- [Point-in-time snapshots with parameters](https://docs.omni.co/guides/workbooks/snapshots-with-parameters.md): How to use Mustache syntax to dynamically modify a query view
- [Welcome to the Omni docs!](https://docs.omni.co/index.md): Omni is the BI platform that combines a shared data model with the flexibility of SQL for governed, self-service analytics.
- [GitHub AI integration](https://docs.omni.co/integrations/ai/github.md): Extend the Omni Agent with code search and file retrieval from your GitHub repositories.
- [Google Calendar AI integration](https://docs.omni.co/integrations/ai/google-calendar.md): Extend the Omni Agent with context from your Google Calendar, so you can reference events and meetings alongside your data analysis.
- [Google Drive AI integration](https://docs.omni.co/integrations/ai/google-drive.md): Extend the Omni Agent with search and file retrieval from your Google Drive, so you can reference documents and spreadsheets alongside your data analysis.
- [Setting up Google AI integrations](https://docs.omni.co/integrations/ai/google-setup.md): Create a shared Google Cloud project and OAuth client to enable Omni's Google Calendar and Google Drive AI integrations.
- [Connecting AI integrations](https://docs.omni.co/integrations/ai/index.md): Enable, disable, and remove AI integrations that extend the Omni Agent with context from Google Calendar, Google Drive, GitHub, and Slack.
- [Slack AI integration](https://docs.omni.co/integrations/ai/slack.md): Extend the Omni Agent with Slack messages, threads, and files so you can reference team discussions and shared documents alongside your data analysis.
- [Pushing exposures to dbt](https://docs.omni.co/integrations/dbt/exposures.md): Author new dbt models from Omni queries, edit existing models in the dbt IDE, and push exposures back to your dbt repository.
- [Working with dbt and Git](https://docs.omni.co/integrations/dbt/git-workflows.md): Manage Omni model changes using dbt and Git workflows, including branches, pull requests, and dynamic environments.
- [Debugging with Health Check](https://docs.omni.co/integrations/dbt/health-check.md): Debug your missing dbt models with Omni's dbt health check.
- [Integrating dbt](https://docs.omni.co/integrations/dbt/index.md): Integrate dbt Core or dbt Cloud with Omni to sync metadata, author models, push exposures, and connect your semantic layer.
- [Pulling dbt metadata into Omni](https://docs.omni.co/integrations/dbt/metadata.md): Understand what metadata Omni pulls from dbt and how to stay in sync
- [Working with dbt models](https://docs.omni.co/integrations/dbt/models.md): Author new dbt models from Omni queries, and edit existing models in the dbt IDE
- [Understanding Omni schema refreshes and dbt syncing](https://docs.omni.co/integrations/dbt/schema-refresh.md): How Omni schema refreshes and dbt syncing work together to keep your data warehouse, transformation logic, and BI layer in sync.
- [Integrate dbt's semantic layer with Omni](https://docs.omni.co/integrations/dbt/semantic-layer.md): Learn how Omni integrates with dbt's semantic layer to pull dimensions, measures, metrics, and entities into your Omni model.
- [Connecting dbt to Omni](https://docs.omni.co/integrations/dbt/setup.md): Set up Omni's dbt integration by connecting a dbt repository to an Omni database connection.
- [git integration best practices](https://docs.omni.co/integrations/git/best-practices.md): Best practices for working with Omni's git integration, including branch strategy, conflict resolution, and common pitfalls.
- [git follower mode best practices](https://docs.omni.co/integrations/git/follower-mode/best-practices.md): Best practices for managing git follower mode deployments in Omni, including sync strategies and conflict prevention tips.
- [git follower mode](https://docs.omni.co/integrations/git/follower-mode/index.md): Centralize model development and deploy to multiple regions or environments using Omni's git follower mode with leader/follower sync.
- [Configuring git follower mode](https://docs.omni.co/integrations/git/follower-mode/setup.md): Set up git follower mode in Omni by designating leader and follower models for centralized development and multi-environment sync.
- [Integrate git for model version control](https://docs.omni.co/integrations/git/index.md): Omni's git integration allows you to sync an Omni shared model to a git repository. This is done on the model level.
- [Configuring git integration settings](https://docs.omni.co/integrations/git/settings.md): Manage git integration settings for your Omni model, including branch defaults, push behavior, and conflict resolution options.
- [Azure DevOps](https://docs.omni.co/integrations/git/setup/azure-devops.md): Connect an Azure DevOps repository to an Omni model
- [Bitbucket Cloud](https://docs.omni.co/integrations/git/setup/bitbucket-cloud.md): Connect a Bitbucket Cloud repository to an Omni model
- [Bitbucket Data Center](https://docs.omni.co/integrations/git/setup/bitbucket-data-center.md): Connect a self-hosted Bitbucket Data Center or Server repository to an Omni model
- [GitHub](https://docs.omni.co/integrations/git/setup/github.md): Connect a GitHub repository to an Omni model using SSH deploy keys or HTTPS token authentication
- [GitLab](https://docs.omni.co/integrations/git/setup/gitlab.md): Connect a GitLab repository to an Omni model using SSH deploy keys or HTTPS token authentication
- [Setting up the git integration](https://docs.omni.co/integrations/git/setup/index.md): Connect a git repository to an Omni model
- [Troubleshooting the git integration](https://docs.omni.co/integrations/git/troubleshooting.md): Resolve common git integration issues in Omni, including authentication failures, push errors, and token configuration problems.
- [Omni Slack Agent](https://docs.omni.co/integrations/omni-slack-agent.md): Ask data questions directly in Slack and get AI-powered answers, charts, and tables from your Omni semantic model.
- [Optimize models for Omni AI](https://docs.omni.co/modeling/develop/ai-optimization.md): Use context to curate your models and improve the accuracy & relevance of Omni's AI.
- [Validating model changes with the Content Validator](https://docs.omni.co/modeling/develop/content-validator.md): Keep your content accurate and up-to-date as your data model evolves with the Content Validator.
- [Controlling data access using the modeling layer](https://docs.omni.co/modeling/develop/data-access-control.md): Control how data is accessed through the modeling layer.
- [Developing in Omni: Advanced modeling concepts](https://docs.omni.co/modeling/develop/guides/advanced-concepts.md): Advanced modeling topics for admins and developers, including row-level security, access grants, templated filters, and dbt integration.
- [Developing in Omni: Model IDE](https://docs.omni.co/modeling/develop/guides/model-ide.md): Navigate the Omni Model IDE to edit auto-generated schema files, define views and fields, and manage your data model structure.
- [Developing in Omni: Permissions & content organization](https://docs.omni.co/modeling/develop/guides/permissions-content-org.md): Configure data and content permissions in Omni across connection, model, and folder levels to control who can see and edit what.
- [Developing in Omni: Modeling in workbooks](https://docs.omni.co/modeling/develop/guides/workbook-modeling.md): Get started building and contributing to your Omni data model from workbooks and the IDE, including field promotion and governance.
- [Viewing and restoring model versions in the model IDE](https://docs.omni.co/modeling/develop/history.md): Model history in the developer IDE allows users to see the changes made to the model and restore to an older version.
- [Model generation](https://docs.omni.co/modeling/develop/model-generation.md): Models are automatically generated after a connection is added. Each model is divided into two layers:
- [Managing your models](https://docs.omni.co/modeling/develop/model-management.md): Manage Omni models through the workbook layer or IDE, including promoting changes between workbook and shared model layers.
- [Promoting workbook changes to the shared model](https://docs.omni.co/modeling/develop/promotion.md): Shared model promotion pushes changes made in the workbook layer into the model layer so the changes are reusable and available in all workbooks.
- [Incorporating database changes with schema refreshes](https://docs.omni.co/modeling/develop/schema-refreshes.md): Trigger manual or scheduled schema refreshes to keep your Omni model in sync when database tables, columns, or schemas change.
- [Using isolated branches with extension models](https://docs.omni.co/modeling/develop/shared-extensions/extension-branches.md): Extension models can have their own independent branches that are isolated from the parent shared model.
- [Shared extension models](https://docs.omni.co/modeling/develop/shared-extensions/index.md): Create an inheritance model for multi-tenant environments with shared extension models.
- [Managing extension model settings](https://docs.omni.co/modeling/develop/shared-extensions/settings.md): Update the settings on a shared extension model, including Allow exploration and isolated branches.
- [Table migration](https://docs.omni.co/modeling/develop/table-migration.md): Use table migration to update table references in Omni when table names change in your database, without breaking downstream content.
- [Dimensions](https://docs.omni.co/modeling/dimensions/index.md): A dimension is an attribute that describes a row of data.
- [ai_context](https://docs.omni.co/modeling/dimensions/parameters/ai-context.md): Provides context to the Omni Agent for better understanding of field usage.
- [aliases](https://docs.omni.co/modeling/dimensions/parameters/aliases.md): Create aliases for renamed dimensions to prevent existing Omni content from breaking when field names change in the data model.
- [all_values](https://docs.omni.co/modeling/dimensions/parameters/all-values.md): Provides the complete list of possible values to the Omni Agent for dimensions with a fixed set of values.
- [bin_boundaries](https://docs.omni.co/modeling/dimensions/parameters/bin-boundaries.md): Specifies bins or tiers for a given numeric field.
- [colors](https://docs.omni.co/modeling/dimensions/parameters/colors.md): Defines colors to map to specific dimension values.
- [convert_tz](https://docs.omni.co/modeling/dimensions/parameters/convert-tz.md): Controls whether a field should be converted to the query/user timezone.
- [custom_primary_key_sql_for_quick_aggs](https://docs.omni.co/modeling/dimensions/parameters/custom-primary-key-sql-for-quick-aggs.md): Defines a custom primary key for aggregate measures where a primary key is applicable.
- [description](https://docs.omni.co/modeling/dimensions/parameters/description.md): Provides metadata about the dimension, made available in the workbook UI.
- [display_order](https://docs.omni.co/modeling/dimensions/parameters/display-order.md): Overrides the sort order for the field picker within a view.
- [drill_fields](https://docs.omni.co/modeling/dimensions/parameters/drill-fields.md): Enables hierarchical drilling inside a row of the result set.
- [duration](https://docs.omni.co/modeling/dimensions/parameters/duration.md): Calculates the time difference between two timestamp fields in various intervals.
- [dynamic_top_n](https://docs.omni.co/modeling/dimensions/parameters/dynamic-top-n.md): Generates dimensions that automatically filter to the top N or bottom N values based on a measure.
- [extends](https://docs.omni.co/modeling/dimensions/parameters/extends.md): Inherits configuration from a dimension defined in another view.
- [faceting](https://docs.omni.co/modeling/dimensions/parameters/faceting.md): Controls how a dimension's filter suggestions are affected by other active filters.
- [filter_single_select_only](https://docs.omni.co/modeling/dimensions/parameters/filter-single-select-only.md): Restricts a dimension to only allow single-value style filters.
- [format](https://docs.omni.co/modeling/dimensions/parameters/format.md): Sets default formatting for number and date dimensions—named formats, Excel-style strings, conditional formats, model constants, and Markdown table cells.
- [group_label](https://docs.omni.co/modeling/dimensions/parameters/group-label.md): Group related dimensions together under a label in the workbook field browser for cleaner organization and easier discovery.
- [groups](https://docs.omni.co/modeling/dimensions/parameters/groups.md): Buckets results with CASE-like logic by filtering field values into labeled groups.
- [hidden](https://docs.omni.co/modeling/dimensions/parameters/hidden.md): Hide a dimension from the workbook field browser while keeping it available for model references, joins, and calculations.
- [ignore_from_extended](https://docs.omni.co/modeling/dimensions/parameters/ignore-from-extended.md): Controls whether a field should be omitted during explicit extensions of a view.
- [ignored](https://docs.omni.co/modeling/dimensions/parameters/ignored.md): Removes a field from the UI and prevents references to it.
- [All dimension parameters](https://docs.omni.co/modeling/dimensions/parameters/index.md): Dimensions are attributes that describe a row of data.
- [label](https://docs.omni.co/modeling/dimensions/parameters/label.md): Overrides the field name for all UI appearances.
- [level_of_detail](https://docs.omni.co/modeling/dimensions/parameters/level-of-detail.md): Creates a Level of Detail field, which controls the granularity at which an aggregation is computed.
- [links](https://docs.omni.co/modeling/dimensions/parameters/links.md): Add templated URL links to dimension drill menus, enabling cross-linking to external tools and dashboards from query results.
- [markdown](https://docs.omni.co/modeling/dimensions/parameters/markdown.md): Mustache template that renders dimension values as Markdown in data table columns.
- [mask_unless_access_grants](https://docs.omni.co/modeling/dimensions/parameters/mask-unless-access-grants.md): Masks dimension values with MD5 hash when users don't meet specified access grants.
- [order_by_field](https://docs.omni.co/modeling/dimensions/parameters/order-by-field.md): Sets a field to be sorted by another field's values.
- [parent_field](https://docs.omni.co/modeling/dimensions/parameters/parent-field.md): Declares a dimension as a child of another dimension for nested field display.
- [primary_key](https://docs.omni.co/modeling/dimensions/parameters/primary-key.md): Sets the primary key on a view for preventing fan outs in calculations.
- [required_access_grants](https://docs.omni.co/modeling/dimensions/parameters/required-access-grants.md): Defines a list of access grants for the dimension, which are used to control access.
- [sample_values](https://docs.omni.co/modeling/dimensions/parameters/sample-values.md): Provides sample values to the Omni Agent to better understand field content and usage.
- [skip_parent_label](https://docs.omni.co/modeling/dimensions/parameters/skip-parent-label.md): Controls whether child dimension labels are prepended with the parent field label in grouped dimensions.
- [sql](https://docs.omni.co/modeling/dimensions/parameters/sql.md): The core declaration of the field definition using SQL.
- [suggest_from_field](https://docs.omni.co/modeling/dimensions/parameters/suggest-from-field.md): Specifies an alternative field to use for filter suggestions.
- [suggest_from_topic](https://docs.omni.co/modeling/dimensions/parameters/suggest-from-topic.md): Explicitly sets the topic to use for filter suggestions.
- [suggestion_list](https://docs.omni.co/modeling/dimensions/parameters/suggestion-list.md): Explicitly sets the list of filter options, bypassing default behavior.
- [synonyms](https://docs.omni.co/modeling/dimensions/parameters/synonyms.md): Alternative names and terms for a dimension that help the Omni Agent match user queries to the correct field.
- [tags](https://docs.omni.co/modeling/dimensions/parameters/tags.md): Apply tags to dimensions for searchable metadata in workbooks and use tag syntax to curate topic fields and drill field lists.
- [timeframes](https://docs.omni.co/modeling/dimensions/parameters/timeframes.md): Sets the default time segments available for date/time fields in workbooks.
- [view_label](https://docs.omni.co/modeling/dimensions/parameters/view-label.md): Move a dimension under a different view in the field browser for better organization, such as grouping user_facts under users.
- [Filter examples](https://docs.omni.co/modeling/filters/examples.md): Ready-to-use YAML examples for common Omni model filter patterns, including time-based, string, numeric, and compound filters.
- [Filter syntax](https://docs.omni.co/modeling/filters/index.md): Write and structure filter definitions in your Omni model YAML using operators, negation, and compound filter expressions.
- [before](https://docs.omni.co/modeling/filters/operators/before.md): Filters time fields for dates before a specified date.
- [between](https://docs.omni.co/modeling/filters/operators/between.md): Filters numeric fields for values within a specified range.
- [between_dates](https://docs.omni.co/modeling/filters/operators/between-dates.md): Filters time fields for dates falling within a specified range.
- [cancel_query_filter](https://docs.omni.co/modeling/filters/operators/cancel-query-filter.md): Creates a measure that ignores the value of a filter in the user query in favor of the filter on the measure itself.
- [case_insensitive](https://docs.omni.co/modeling/filters/operators/case-insensitive.md): Modifies string filter operators to perform case-insensitive matching.
- [contains](https://docs.omni.co/modeling/filters/operators/contains.md): Filters string fields for values that contain a specified substring.
- [date_offset_from_query](https://docs.omni.co/modeling/filters/operators/date-offset-from-query.md): Specifies a filter dynamically relative to the date filter applied to a workbook query.
- [day_of_month](https://docs.omni.co/modeling/filters/operators/day-of-month.md): Filters time fields by the day of the month.
- [day_of_quarter](https://docs.omni.co/modeling/filters/operators/day-of-quarter.md): Filters time fields by the day of the quarter.
- [day_of_week](https://docs.omni.co/modeling/filters/operators/day-of-week.md): Filters time fields by the day of the week.
- [day_of_year](https://docs.omni.co/modeling/filters/operators/day-of-year.md): Filters time fields by the day of the year.
- [ends_with](https://docs.omni.co/modeling/filters/operators/ends-with.md): Filters string fields for values that end with a specified substring.
- [field_name_in_query](https://docs.omni.co/modeling/filters/operators/field-name-in-query.md): Include only rows whose values appear in the results of another query.
- [field_name_not_in_query](https://docs.omni.co/modeling/filters/operators/field-name-not-in-query.md): Exclude rows whose values appear in the results of another query.
- [greater_than](https://docs.omni.co/modeling/filters/operators/greater-than.md): Filters numeric fields for values greater than a specified number.
- [greater_than_or_equal_to](https://docs.omni.co/modeling/filters/operators/greater-than-or-equal-to.md): Filters numeric fields for values greater than or equal to a specified number.
- [hour_of_day](https://docs.omni.co/modeling/filters/operators/hour-of-day.md): Filters time fields by the hour of the day.
- [Filter operators](https://docs.omni.co/modeling/filters/operators/index.md): Reference for all Omni model filter operators, including conditional, date, number, text, and advanced cross-query operators.
- [is](https://docs.omni.co/modeling/filters/operators/is.md): Filters for exact equality.
- [less_than](https://docs.omni.co/modeling/filters/operators/less-than.md): Filters numeric fields for values strictly less than a specified number.
- [less_than_or_equal_to](https://docs.omni.co/modeling/filters/operators/less-than-or-equal-to.md): Filters numeric fields for values less than or equal to a specified number.
- [month_of_year](https://docs.omni.co/modeling/filters/operators/month-of-year.md): Filters time fields by the month of the year.
- [not](https://docs.omni.co/modeling/filters/operators/not.md): Filters for inequality.
- [on_or_after](https://docs.omni.co/modeling/filters/operators/on-or-after.md): Filters time fields for dates on or after a specified date.
- [quarter_of_year](https://docs.omni.co/modeling/filters/operators/quarter-of-year.md): Filters time fields by the quarter of the year.
- [starts_with](https://docs.omni.co/modeling/filters/operators/starts-with.md): Filters string fields for values that start with a specified substring.
- [time_for_duration](https://docs.omni.co/modeling/filters/operators/time-for-duration.md): Filters time fields for a specific duration starting from a given point in time.
- [Modeling in Omni](https://docs.omni.co/modeling/index.md): Understand Omni's three-layer modeling approach: schema model, shared data model, and workbook model for governed analytics.
- [Measures](https://docs.omni.co/modeling/measures/index.md): Define measures in your Omni model to compute sums, counts, averages, and custom aggregations across rows of data in queries.
- [aggregate_type](https://docs.omni.co/modeling/measures/parameters/aggregate-type.md): Defines the aggregation method for an underlying dimension.
- [ai_context](https://docs.omni.co/modeling/measures/parameters/ai-context.md): Free text that can provide context about a measure to the Omni Agent.
- [aliases](https://docs.omni.co/modeling/measures/parameters/aliases.md): Create aliases for renamed measures to prevent existing Omni content from breaking when field names change in the data model.
- [all_values](https://docs.omni.co/modeling/measures/parameters/all-values.md): Provides the complete list of possible values to the Omni Agent for measures with a fixed set of values.
- [colors](https://docs.omni.co/modeling/measures/parameters/colors.md): Maps a color to the measure when used as a series in a visualization.
- [custom_primary_key_sql](https://docs.omni.co/modeling/measures/parameters/custom-primary-key-sql.md): Defines a custom aggregation level for deduplication.
- [description](https://docs.omni.co/modeling/measures/parameters/description.md): Provides metadata about the measure, made available in the workbook UI.
- [display_order](https://docs.omni.co/modeling/measures/parameters/display-order.md): Overrides the sort order for the field picker within the field's grouping.
- [drill_fields](https://docs.omni.co/modeling/measures/parameters/drill-fields.md): Curates the drilling behavior for a measure.
- [drill_queries](https://docs.omni.co/modeling/measures/parameters/drill-queries.md): Defines multiple drill query options, with full control over the underlying query.
- [filters](https://docs.omni.co/modeling/measures/parameters/filters.md): Applies filters to a measure for filtered aggregations.
- [format](https://docs.omni.co/modeling/measures/parameters/format.md): Sets default formatting for measures—named formats, Excel-style strings, conditional formats, model constants, and Markdown table cells.
- [group_label](https://docs.omni.co/modeling/measures/parameters/group-label.md): Group related measures together under a label in the workbook field browser for cleaner organization and easier discovery.
- [hidden](https://docs.omni.co/modeling/measures/parameters/hidden.md): Hide a measure from the workbook field browser while keeping it available for model references and derived calculations.
- [ignored](https://docs.omni.co/modeling/measures/parameters/ignored.md): Removes the field from the UI and prevents references to the field.
- [Measure parameters](https://docs.omni.co/modeling/measures/parameters/index.md): Reference for all measure YAML parameters in Omni, including aggregate type, SQL, format, filters, drill fields, and visibility.
- [label](https://docs.omni.co/modeling/measures/parameters/label.md): Overrides the field name for all UI appearances of the field.
- [links](https://docs.omni.co/modeling/measures/parameters/links.md): Add templated URL links to measure drill menus, enabling cross-linking to external tools and dashboards from aggregated results.
- [markdown](https://docs.omni.co/modeling/measures/parameters/markdown.md): Mustache template that renders measure values as Markdown in data table columns.
- [required_access_grants](https://docs.omni.co/modeling/measures/parameters/required-access-grants.md): Defines a list of access grants for the measure, which are used to control access.
- [sample_values](https://docs.omni.co/modeling/measures/parameters/sample-values.md): Provides sample values to the Omni Agent to better understand measure magnitude and usage.
- [sql](https://docs.omni.co/modeling/measures/parameters/sql.md): The core declaration of the field definition.
- [suggest_from_field](https://docs.omni.co/modeling/measures/parameters/suggest-from-field.md): Suggests filter values from an alternative field's distinct values.
- [suggestion_list](https://docs.omni.co/modeling/measures/parameters/suggestion-list.md): Explicitly sets the list of filter options, bypassing the default behavior.
- [synonyms](https://docs.omni.co/modeling/measures/parameters/synonyms.md): Alternative names and terms for a measure that help the Omni Agent understand user intent.
- [tags](https://docs.omni.co/modeling/measures/parameters/tags.md): Apply tags to measures for searchable metadata in workbooks and use tag syntax to curate topic fields and drill field lists.
- [view_label](https://docs.omni.co/modeling/measures/parameters/view-label.md): Move a measure under a different view in the field browser for better organization, such as grouping aggregates with their source.
- [access_grants](https://docs.omni.co/modeling/models/access-grants.md): Limits user access to a particular field (dimension or measure) through user attributes.
- [ai_chat_topics](https://docs.omni.co/modeling/models/ai-chat-topics.md): Controls the topics that are available to the Omni Agent, Dashboard Agent, MCP, and embedded chat instances.
- [ai_context](https://docs.omni.co/modeling/models/ai-context.md): Sets context for the Omni Agent that is applicable for the entire model.
- [ai_settings](https://docs.omni.co/modeling/models/ai-settings.md): Configure AI behavior for the model, including query scope, analysis validation, context management, and AI model and thinking settings.
- [auto_run](https://docs.omni.co/modeling/models/auto-run.md): Forces all queries using the connection to require a run click to return new results.
- [cache_policies](https://docs.omni.co/modeling/models/cache-policies.md): Defines cache policies for the model.
- [constants](https://docs.omni.co/modeling/models/constants.md): Define reusable string values that can be referenced throughout your model.
- [custom_formats](https://docs.omni.co/modeling/models/custom-formats.md): Define reusable format objects that can be referenced in dimension and measure format parameters.
- [default_cache_policy](https://docs.omni.co/modeling/models/default-cache-policy.md): Defines the default cache policy for the model.
- [default_numeric_locale](https://docs.omni.co/modeling/models/default-numeric-locale.md): Defines global number formatting in the model.
- [default_row_limit](https://docs.omni.co/modeling/models/default-row-limit.md): Sets the default row limit for new queries within the model.
- [default_timeframes](https://docs.omni.co/modeling/models/default-timeframes.md): Sets the default timeframes available for date and time fields across the model.
- [default_topic_access_filters](https://docs.omni.co/modeling/models/default-topic-access-filters.md): Defines default access filters for topics in the model.
- [default_topic_required_access_grants](https://docs.omni.co/modeling/models/default-topic-required-access-grants.md): Defines a default required access grant for all topics contained in a model.
- [dynamic_schemas](https://docs.omni.co/modeling/models/dynamic-schemas.md): Creates a copy of the specified schema as a virtual schema.
- [extends](https://docs.omni.co/modeling/models/extends.md): Enables extending a model.
- [facet_workbook_filters](https://docs.omni.co/modeling/models/facet-workbook-filters.md): Facets all filter suggestions in the workbook to the current filter selections.
- [fiscal_month_offset](https://docs.omni.co/modeling/models/fiscal-month-offset.md): Sets a fiscal calendar in Omni and enables adding fiscal time metrics to time dimension groups and filters in the UI.
- [Formatting values](https://docs.omni.co/modeling/models/format-values.md): Format dimension and measure values with named formats, Excel-style strings, conditional formats, model constants, locale settings, and Markdown table cells.
- [ignored_schemas](https://docs.omni.co/modeling/models/ignored-schemas.md): Excludes a list of schemas from workbooks.
- [ignored_views](https://docs.omni.co/modeling/models/ignored-views.md): Excludes specific views from use in workbooks.
- [included_schemas](https://docs.omni.co/modeling/models/included-schemas.md): Includes only the listed schemas for use in workbooks.
- [included_views](https://docs.omni.co/modeling/models/included-views.md): Defines a list of views from the database schema to include in the model.
- [Configuring your models](https://docs.omni.co/modeling/models/index.md): Model files are used to define configuration for the analytical environment (topics, views, and so on) associated with a specific model.
- [sample_queries](https://docs.omni.co/modeling/models/sample-queries.md): Defines a list of sample queries that could be performed using the topics in the model.
- [sets](https://docs.omni.co/modeling/models/sets.md): Defines a list of fields that can be referenced in parameters that accept lists of fields.
- [skills](https://docs.omni.co/modeling/models/skills.md): Defines a set of instructions for the Omni AI that users can trigger with a button click.
- [slot_reservation](https://docs.omni.co/modeling/models/slot-reservation.md): Specifies a dedicated slot for queries in a Google BigQuery-backed model to use.
- [sql_preamble](https://docs.omni.co/modeling/models/sql-preamble.md): Runs a setup query before executing SQL statements against a model.
- [template](https://docs.omni.co/modeling/models/template.md): Disables the content validator for an abstract model.
- [topic_group_descriptions](https://docs.omni.co/modeling/models/topic-group-descriptions.md): Defines descriptions for topic groups.
- [topics](https://docs.omni.co/modeling/models/topics.md): Define topics within model files.
- [warehouse_override](https://docs.omni.co/modeling/models/warehouse-override.md): Specifies a different warehouse to use for a given workbook or branch.
- [week_start_day](https://docs.omni.co/modeling/models/week-start-day.md): Defines the day that weeks start on.
- [Configuring query views](https://docs.omni.co/modeling/query-views/index.md): Query views are workbook queries that have been saved to the model as a view.
- [base_view](https://docs.omni.co/modeling/query-views/parameters/base-view.md): References the view that is used in the FROM of the generated SQL.
- [bind](https://docs.omni.co/modeling/query-views/parameters/bind.md): Passes filter values from other fields into the subquery defined in a query view.
- [bind_all_filters](https://docs.omni.co/modeling/query-views/parameters/bind-all-filters.md): Passes all chosen filters from the outer query into the query view definition.
- [calculations](https://docs.omni.co/modeling/query-views/parameters/calculations.md): Lists the calculations defined in the query.
- [default_group_by](https://docs.omni.co/modeling/query-views/parameters/default-group-by.md): Enables or disables a GROUP BY in the query.
- [dimensions](https://docs.omni.co/modeling/query-views/parameters/dimensions.md): Lists all fields selected in the query, making them into dimensions to allow for aggregation in another query.
- [fields](https://docs.omni.co/modeling/query-views/parameters/fields.md): Lists the fields in the query.
- [fill_fields](https://docs.omni.co/modeling/query-views/parameters/fill-fields.md): Ensures that the query returns continuous values for specific dimensions, even when no underlying rows exist.
- [filters](https://docs.omni.co/modeling/query-views/parameters/filters.md): Defines the filters applied in the query.
- [Query view parameters](https://docs.omni.co/modeling/query-views/parameters/index.md): Reference for all query view YAML parameters in Omni, including base_view, filters, sorts, fields, and query configuration.
- [join_via_map](https://docs.omni.co/modeling/query-views/parameters/join-via-map.md): Maps joins when the query view is based on SQL and the joins are non-default joins.
- [limit](https://docs.omni.co/modeling/query-views/parameters/limit.md): Defines the row limit of the query if a limit is set on the query in the workbook.
- [measures](https://docs.omni.co/modeling/query-views/parameters/measures.md): Describes how to aggregate data in the query.
- [query](https://docs.omni.co/modeling/query-views/parameters/query.md): Defines the underlying query for the query view.
- [schema](https://docs.omni.co/modeling/query-views/parameters/schema.md): References the query's underlying schema name from the associated database connection.
- [sorts](https://docs.omni.co/modeling/query-views/parameters/sorts.md): Defines the field(s) that the query is sorted by.
- [sql](https://docs.omni.co/modeling/query-views/parameters/sql.md): Defines the SQL query used by the query view.
- [topic](https://docs.omni.co/modeling/query-views/parameters/topic.md): Specifies the topic used by the query.
- [Creating table joins](https://docs.omni.co/modeling/relationships/build.md): Create table joins in Omni workbooks or the model IDE, configure join types and conditions, and promote joins to the shared model.
- [Relationships and joins](https://docs.omni.co/modeling/relationships/index.md): Define relationships between views in your Omni model to enable automatic SQL joins, cross-table exploration, and data analysis.
- [id](https://docs.omni.co/modeling/relationships/parameters/id.md): Omni-generated identifier for duplicate joins.
- [Relationship file parameters](https://docs.omni.co/modeling/relationships/parameters/index.md): Reference for all relationship YAML parameters in Omni, including join type, cardinality, on_sql conditions, and reversibility.
- [join_from_view](https://docs.omni.co/modeling/relationships/parameters/join-from-view.md): Defines the source view from which the join originates.
- [join_from_view_as](https://docs.omni.co/modeling/relationships/parameters/join-from-view-as.md): Aliases the source view with a new name.
- [join_from_view_as_label](https://docs.omni.co/modeling/relationships/parameters/join-from-view-as-label.md): Controls the display name of the source view in the UI when using the join.
- [join_to_view](https://docs.omni.co/modeling/relationships/parameters/join-to-view.md): Specifies the view to join to the source view.
- [join_to_view_as](https://docs.omni.co/modeling/relationships/parameters/join-to-view-as.md): Aliases the joined view with a new name.
- [join_to_view_as_label](https://docs.omni.co/modeling/relationships/parameters/join-to-view-as-label.md): Controls the display name of the joined view in the UI when using the join.
- [join_type](https://docs.omni.co/modeling/relationships/parameters/join-type.md): Specifies the type of SQL join to perform.
- [on_sql](https://docs.omni.co/modeling/relationships/parameters/on-sql.md): Specifies the SQL condition that determines how to perform the join.
- [relationship_type](https://docs.omni.co/modeling/relationships/parameters/relationship-type.md): Defines the cardinality relationship between joined tables.
- [reversible](https://docs.omni.co/modeling/relationships/parameters/reversible.md): Controls whether the join can function bi-directionally for topics.
- [where_sql](https://docs.omni.co/modeling/relationships/parameters/where-sql.md): Adds a WHERE clause to the generated SQL when a join is established.
- [Templated filters](https://docs.omni.co/modeling/templated-filters/index.md): Use Mustache template syntax to inject dynamic, user-driven values into SQL definitions for views and fields in your Omni model.
- [Topic best practices](https://docs.omni.co/modeling/topics/best-practices.md): Best practices for designing topics in Omni that balance usability, performance, and maintainability for self-service analytics.
- [Topic design inspiration](https://docs.omni.co/modeling/topics/examples.md): Real-world topic design examples from Omni users to inspire how you structure curated datasets for your business use cases.
- [Curating datasets with topics](https://docs.omni.co/modeling/topics/index.md): Create curated topics in Omni to give non-technical users a self-service way to explore data and build visualizations.
- [access_filters](https://docs.omni.co/modeling/topics/parameters/access-filters.md): Limits access to rows in a dataset based on user attributes.
- [ai_context](https://docs.omni.co/modeling/topics/parameters/ai-context.md): Free text that can provide context about a topic to the Omni Agent.
- [ai_fields](https://docs.omni.co/modeling/topics/parameters/ai-fields.md): Curates the fields in the topic that are provided to the Omni Agent.
- [always_having_filters](https://docs.omni.co/modeling/topics/parameters/always-having-filters.md): Applies a filter to aggregated results (measures) in a query using filter syntax.
- [always_having_sql](https://docs.omni.co/modeling/topics/parameters/always-having-sql.md): Applies a filter to aggregated results in a query using SQL.
- [always_where_filters](https://docs.omni.co/modeling/topics/parameters/always-where-filters.md): Applies a filter to all rows in a query using filter syntax.
- [always_where_sql](https://docs.omni.co/modeling/topics/parameters/always-where-sql.md): Applies a filter to all rows in a query using SQL.
- [auto_run](https://docs.omni.co/modeling/topics/parameters/auto-run.md): Forces all queries using the topic to require a run click to return new results.
- [base_view](https://docs.omni.co/modeling/topics/parameters/base-view.md): Defines the base view for the topic.
- [base_view_label](https://docs.omni.co/modeling/topics/parameters/base-view-label.md): Defines the display name of the table in the workbook when it is accessed from the topic.
- [cache_policy](https://docs.omni.co/modeling/topics/parameters/cache-policy.md): Defines the cache policy for the topic.
- [default_filters](https://docs.omni.co/modeling/topics/parameters/default-filters.md): Applies a filter to all rows in a topic.
- [default_row_limit](https://docs.omni.co/modeling/topics/parameters/default-row-limit.md): Sets the default row limit for new queries using the topic.
- [description](https://docs.omni.co/modeling/topics/parameters/description.md): Free text that describes the topic.
- [display_order](https://docs.omni.co/modeling/topics/parameters/display-order.md): Defines the order that topics display in the field picker.
- [extends](https://docs.omni.co/modeling/topics/parameters/extends.md): Allows for inheriting and overriding another topic inside of Omni.
- [fields](https://docs.omni.co/modeling/topics/parameters/fields.md): Curates the fields available in the topic.
- [group_label](https://docs.omni.co/modeling/topics/parameters/group-label.md): Defines the group the topic belongs to.
- [hidden](https://docs.omni.co/modeling/topics/parameters/hidden.md): Removes the topic from the workbook.
- [Topic file parameters](https://docs.omni.co/modeling/topics/parameters/index.md): Topic files are used to define configuration for individual topics.
- [joins](https://docs.omni.co/modeling/topics/parameters/joins.md): Declares other views as part of the topic.
- [label](https://docs.omni.co/modeling/topics/parameters/label.md): Defines a display name for the topic.
- [owners](https://docs.omni.co/modeling/topics/parameters/owners.md): A list of email addresses indicating who the owners of the topic are.
- [relationships](https://docs.omni.co/modeling/topics/parameters/relationships.md): Defines a list of topic-level joins.
- [required_access_grants](https://docs.omni.co/modeling/topics/parameters/required-access-grants.md): Defines a list of access grants for the topic, which are used to control access.
- [sample_queries](https://docs.omni.co/modeling/topics/parameters/sample-queries.md): Defines a list of sample queries that could be performed on the topic.
- [tags](https://docs.omni.co/modeling/topics/parameters/tags.md): Organizes topics by category.
- [template](https://docs.omni.co/modeling/topics/parameters/template.md): Marks a topic as a template only accessible through `extends` and disables model validation.
- [views](https://docs.omni.co/modeling/topics/parameters/views.md): Allows customization of views only in the context of the topic.
- [warehouse_override](https://docs.omni.co/modeling/topics/parameters/warehouse-override.md): Specifies a different warehouse to use for a specific topic.
- [Creating topics with AI quickstart](https://docs.omni.co/modeling/topics/quickstart.md): Use AI to create your first topic by describing your business questions. Omni generates a complete topic with joins, fields, and context.
- [Creating topics](https://docs.omni.co/modeling/topics/setup.md): Omni offers two ways to develop topics: visually (in workbooks) or using code (in the model IDE).
- [Configuring database views](https://docs.omni.co/modeling/views/index.md): Views represent the tables in your database.
- [ai_context](https://docs.omni.co/modeling/views/parameters/ai-context.md): Free text that can provide context about a view to the Omni Agent.
- [aliases](https://docs.omni.co/modeling/views/parameters/aliases.md): Map old table names to updated table names to preserve content.
- [catalog](https://docs.omni.co/modeling/views/parameters/catalog.md): Specifies the database catalog (or database name) for a table.
- [custom_compound_primary_key_sql](https://docs.omni.co/modeling/views/parameters/custom-compound-primary-key-sql.md): Defines an array of field names that make up a view's compound primary key.
- [default_drill_fields](https://docs.omni.co/modeling/views/parameters/default-drill-fields.md): Sets the default drill set for all measures in a view.
- [default_drill_query](https://docs.omni.co/modeling/views/parameters/default-drill-query.md): Set the default drill query for all measures in a view.
- [description](https://docs.omni.co/modeling/views/parameters/description.md): Free text that describes the view.
- [display_order](https://docs.omni.co/modeling/views/parameters/display-order.md): Overrides the sort order for views in the field browser.
- [extends](https://docs.omni.co/modeling/views/parameters/extends.md): Inherit attributes from another view inside of Omni.
- [fill_fields](https://docs.omni.co/modeling/views/parameters/fill-fields.md): Fills an enumerated list to ensure all values are represented in the dataset.
- [folder](https://docs.omni.co/modeling/views/parameters/folder.md): Nest views in a folder in the model IDE for better organization.
- [hidden](https://docs.omni.co/modeling/views/parameters/hidden.md): Removes a view from the workbook UI while keeping it referenceable in the model.
- [ignored](https://docs.omni.co/modeling/views/parameters/ignored.md): Soft-deletes a view in the model.
- [All View file parameters](https://docs.omni.co/modeling/views/parameters/index.md): View files are used to define configuration, fields, and relationships for individual views.
- [label](https://docs.omni.co/modeling/views/parameters/label.md): Overrides the name of the view in the UI.
- [materialized_query](https://docs.omni.co/modeling/views/parameters/materialized-query.md): Configures aggregate awareness between two views.
- [name](https://docs.omni.co/modeling/views/parameters/name.md): Reference name for the view, implicit in the file name.
- [query](https://docs.omni.co/modeling/views/parameters/query.md): Defines a view from a workbook query.
- [required_access_grants](https://docs.omni.co/modeling/views/parameters/required-access-grants.md): Limits a user's ability to query a view based on assigned user attributes.
- [schema](https://docs.omni.co/modeling/views/parameters/schema.md): Specifies the database schema for a table.
- [schema_label](https://docs.omni.co/modeling/views/parameters/schema-label.md): Defines a display label for the database schema.
- [sql](https://docs.omni.co/modeling/views/parameters/sql.md): Defines a view from a SQL query.
- [table_name](https://docs.omni.co/modeling/views/parameters/table-name.md): Specifies the database table name underlying the view.
- [tags](https://docs.omni.co/modeling/views/parameters/tags.md): Curates view and field groups for organizing and grouping views in the UI.
- [template](https://docs.omni.co/modeling/views/parameters/template.md): Marks a view as a template only accessible through `extends` and disables model validation.
- [uploaded_table_name](https://docs.omni.co/modeling/views/parameters/uploaded-table-name.md): Unique identifier for views created from uploaded CSV/XLSX files.
- [Delivering Omni content to Amazon S3](https://docs.omni.co/share/deliveries/amazon-s3.md): Deliver scheduled reports and dashboards to an Amazon S3 bucket using cross-account IAM role assumption.
- [Creating dynamic delivery content with Mustache](https://docs.omni.co/share/deliveries/dynamic-content.md): Create dynamic content for your deliveries with Mustache syntax.
- [Delivering Omni content via email](https://docs.omni.co/share/deliveries/email.md): With email deliveries, you can automatically schedule sending dashboards and individual tiles to your team.
- [Delivering Omni content to Google Sheets](https://docs.omni.co/share/deliveries/google-sheets.md): With Google Sheets deliveries, you can automatically schedule sending individual tiles to Google Sheets.
- [Sharing content with schedules & alerts](https://docs.omni.co/share/deliveries/index.md): Keep your team informed by automating the delivery of dashboards and tiles.
- [Delivering Omni content to an SFTP server](https://docs.omni.co/share/deliveries/sftp.md): Omni supports delivery data through SFTP as a robust and secure method for transferring files.
- [Delivering Omni content to Slack](https://docs.omni.co/share/deliveries/slack.md): With Slack deliveries, you can automatically schedule sending dashboards and individual tiles to your team as channel or direct messages.
- [Troubleshooting failed deliveries](https://docs.omni.co/share/deliveries/troubleshooting.md): Monitor the status of the deliveries in your instance and learn how to investigate failures.
- [Webhook deliveries](https://docs.omni.co/share/deliveries/webhooks.md): Customize your Omni deliveries with webhooks.
- [Content sharing](https://docs.omni.co/share/index.md): Share Omni dashboards and workbooks with your team using links, folder permissions, and access controls for governed collaboration.
- [Visualization showcase](https://docs.omni.co/showcase/index.md): Check out these examples to see what's possible in Omni!
- [Calendar heatmaps](https://docs.omni.co/showcase/visualizations/calendar-heatmaps.md): The code for these examples can be used in the Markdown visualization to create different styles of calendars with cells colored by a value.
- [Card with criteria checklist](https://docs.omni.co/showcase/visualizations/card-criteria-checklist.md): The code for this example can be used in the Markdown visualization to create a card with a list of criteria:
- [Card grid](https://docs.omni.co/showcase/visualizations/card-grid.md): The code for this example can be used in the Markdown visualization to create a grid of responsive cards with metrics and images:
- [Card with target candlesticks](https://docs.omni.co/showcase/visualizations/card-target-candlesticks.md): The code for this example can be used in the Markdown visualization to create cards with conditional coloring, based on the current value versus the target.
- [Card with strip plot](https://docs.omni.co/showcase/visualizations/card-with-strip-plot.md): The code for this example can be used in the Markdown visualization to create a card with a strip plot:
- [Cohort table](https://docs.omni.co/showcase/visualizations/cohort-table.md): The code for this example can be used in the Markdown visualization to create a more condensed and styled cohort table for a year's worth of monthly cohorts.
- [Colored progress bars](https://docs.omni.co/showcase/visualizations/colored-progress-bars.md): Create color-sectioned progress bar visualizations using Markdown in Omni to display current state with visual color cues.
- [Dashboard tabs](https://docs.omni.co/showcase/visualizations/dashboard-tabs.md): Markdown tiles can be used to create tabs in dashboards, allowing users to jump from one dashboard to another in internal or embedded scenarios.
- [Dashboard tile anchors (table of contents)](https://docs.omni.co/showcase/visualizations/dashboard-tile-anchors.md): This example can be used in the Markdown visualization to create a linked table of contents.
- [Data readout](https://docs.omni.co/showcase/visualizations/data-readout.md): Build a sparkline with descriptive text using Markdown visualization in Omni, referencing live query values in the results set.
- [Dumbbell plot](https://docs.omni.co/showcase/visualizations/dumbbell-plot.md): The code for this example can be used in the Markdown visualization to create a table of dumbbell charts.
- [Gauges](https://docs.omni.co/showcase/visualizations/gauge.md): Create gauge and speedometer chart visualizations using Markdown in Omni to show where a value falls within a defined range.
- [Gradient card with metrics](https://docs.omni.co/showcase/visualizations/gradient-card.md): The code for this example can be used in the Markdown visualization to create a full-width card with a gradient background and multiple metrics.
- [Honeycomb categorical chart](https://docs.omni.co/showcase/visualizations/honeycomb-categorical.md): The code for this example can be used in the Markdown visualization to create a hexagonal grid with a label and value in each cell.
- [Honeycomb map](https://docs.omni.co/showcase/visualizations/honeycomb-map.md): The code for this example can be used in the Markdown visualization to create a stylized map of the United States.
- [Image grid](https://docs.omni.co/showcase/visualizations/image-grid.md): The code for this example can be used in the Markdown visualization to create a grid of images, each of which contains a description and metric.
- [Invoice report](https://docs.omni.co/showcase/visualizations/invoice-report.md): The code for these examples can be used in the Markdown visualization to create a structured invoice, complete with contact information and order details.
- [Kanban](https://docs.omni.co/showcase/visualizations/kanban.md): The code for this example can be used in the Markdown visualization to create a Kanban-style project board.
- [KPI conditional colors](https://docs.omni.co/showcase/visualizations/kpi-conditional-colors.md): The code for this example can be used in the Markdown visualization to apply conditional color styling to KPI charts.
- [KPI table](https://docs.omni.co/showcase/visualizations/kpi-table.md): The code for this example can be used in the Markdown visualization to create a table of KPIs.
- [KPI with sparkline](https://docs.omni.co/showcase/visualizations/kpi-with-sparkline.md): The code for this example can be used in the Markdown visualization to create a KPI-style visualization with a sparkline and change arrow.
- [Card list](https://docs.omni.co/showcase/visualizations/list-view.md): The code for this example can be used in the Markdown visualization to card list view:
- [Metric tree](https://docs.omni.co/showcase/visualizations/metric-tree.md): The code for this example can be used in the Markdown visualization to create a tree of interdependent metrics.
- [Pie or donut with custom legend](https://docs.omni.co/showcase/visualizations/pie-donut-custom-legend.md): The code for this example can be used in the Markdown visualization to create a pie or donut chart with a customized legend.
- [Record lookup](https://docs.omni.co/showcase/visualizations/record-lookup.md): The code for this example can be used in the Markdown visualization to create a card that contains details for a single record, such as a user profile.
- [Repeating pie charts](https://docs.omni.co/showcase/visualizations/repeating-pie-chart.md): The code for this example can be used in the Markdown visualization to create a series of pie charts, one for each row in your results.
- [Repeating square fill charts](https://docs.omni.co/showcase/visualizations/repeating-square-fill-chart.md): The code for this example can be used in the Markdown visualization to create a series of percentage-filled squares, one for each row in your results.
- [Repeating waffle charts](https://docs.omni.co/showcase/visualizations/repeating-waffle-chart.md): The code for this example can be used in the Markdown visualization to create a series of percentage-filled waffle charts, one for each row in your results.
- [Fancy subtotal table](https://docs.omni.co/showcase/visualizations/simple-subtotal-table.md): The code for this example can be used in the Markdown visualization to create different styles for displaying a simple table with subtotals.
- [Symmetric funnel](https://docs.omni.co/showcase/visualizations/symmetric-funnel.md): The code for this example can be used in the Markdown visualization to create a funnel with multiple sequential steps.
- [Table with tiny bar charts](https://docs.omni.co/showcase/visualizations/table-with-tiny-bars.md): The code for this example can be used in the Markdown visualization to create a styled table with a small bar chart in each row.
- [Team progress tracker](https://docs.omni.co/showcase/visualizations/team-progress-tracker.md): The code for this example can be used in the Markdown visualization to create a progress chart for multiple individuals on the same timeline.
- [Test result cards](https://docs.omni.co/showcase/visualizations/test-results-cards.md): Build test result card visualizations using Markdown in Omni to display consistently sized charts across tests with varying ranges.
- [Thermometer progress indicator](https://docs.omni.co/showcase/visualizations/thermometer.md): The code for these examples can be used in the Markdown visualization to create a fundraising-style thermometer progress indicator.
- [Uptime heatmaps](https://docs.omni.co/showcase/visualizations/uptime-heatmaps.md): The code for these examples can be used in the Markdown visualization to heatmap that colors each time slot based on a percentage value.
- [Word cloud](https://docs.omni.co/showcase/visualizations/word-cloud.md): The code for these examples can be used in the Markdown visualization to create word cloud. In this example, text is horizontal and loosely spaced.
- [Designing dashboards with advanced layout](https://docs.omni.co/visualize-present/dashboards/advanced-layout.md): Use containers, grids, tabs, and stacks to design precise dashboard layouts with full control over tile arrangement and spacing.
- [Working with dashboard charts](https://docs.omni.co/visualize-present/dashboards/charts.md): Add, edit, duplicate, hide, and configure chart tiles on Omni dashboards, including filter connections and background settings.
- [Dynamically displaying tile fields with controls](https://docs.omni.co/visualize-present/dashboards/controls.md): Let dashboard viewers switch which fields appear in a tile using controls, enabling period-over-period comparisons and field swaps.
- [Creating & designing dashboards](https://docs.omni.co/visualize-present/dashboards/create-design.md): Create new dashboards in Omni workbooks and design them by adding tiles, arranging layouts, and configuring visual presentation.
- [Defining custom dashboard error and empty results messages](https://docs.omni.co/visualize-present/dashboards/custom-state-message.md): Customize the messages that display on dashboards when queries encounter errors or don't return results.
- [Removing a dashboard from a document](https://docs.omni.co/visualize-present/dashboards/delete.md): Learn how to remove a dashboard from an Omni workbook document and what happens to associated schedules.
- [Downloading dashboards](https://docs.omni.co/visualize-present/dashboards/download.md): Download Omni dashboards as PDF or image files with options for paper size, orientation, zoom, and page layout customization.
- [Working with dashboard filters](https://docs.omni.co/visualize-present/dashboards/filters.md): Add advanced and single-select filters to Omni dashboards, connect them to tiles, set defaults, and configure filter visibility.
- [Dashboards](https://docs.omni.co/visualize-present/dashboards/index.md): Present Omni workbook queries as interactive dashboards with filters, charts, and tiles arranged on a unified visual canvas.
- [Migrating dashboards](https://docs.omni.co/visualize-present/dashboards/migrate.md): Change the connection a dashboard is based on using Omni's APIs.
- [Analyzing dashboard performance](https://docs.omni.co/visualize-present/dashboards/performance-profiler.md): The Performance Profiler helps you analyze how a dashboard executes queries and identify potential performance bottlenecks.
- [Managing dashboard settings](https://docs.omni.co/visualize-present/dashboards/settings.md): Configure dashboard settings such as auto-refresh, crossfiltering, faceted filters, and collapsible filters.
- [Adding text with Markdown tiles](https://docs.omni.co/visualize-present/dashboards/text-markdown.md): Add styled text, images, and links to your Omni dashboards using Markdown tiles for annotations, headers, and descriptions.
- [Applying themes to dashboards](https://docs.omni.co/visualize-present/dashboards/theming.md): Apply reusable document themes to customize the appearance of Omni dashboards, including fonts, colors, and tile backgrounds.
- [Creating dynamic dashboard content with Mustache](https://docs.omni.co/visualize-present/dynamic-content.md): Omni supports Mustache syntax in Markdown visualizations and dashboard Markdown tiles, making it easy to add dynamic content to your dashboards.
- [Visualize & present](https://docs.omni.co/visualize-present/index.md): Turn query results into charts, build interactive dashboards, and use AI to surface insights from your data.
- [Mustache cheatsheet](https://docs.omni.co/visualize-present/mustache-cheatsheet.md): Quick reference for Omni's supported Mustache tags
- [Mustache syntax reference](https://docs.omni.co/visualize-present/mustache-reference.md): Complete reference for Mustache template syntax in Omni, including tags, keys, sections, and dynamic content for dashboards.
- [Color by / Stacking](https://docs.omni.co/visualize-present/visualizations/configuration/color.md): Configure color-by dimensions and stacking options to create multi-series charts with distinct visual groupings in Omni workbooks.
- [Series configuration](https://docs.omni.co/visualize-present/visualizations/configuration/series-configuration.md): Configure individual chart series in Omni, including chart type, axis assignment, label formatting, and data display options.
- [Series mapping](https://docs.omni.co/visualize-present/visualizations/configuration/series-mapping.md): Rearrange dimensions, measures, and pivots across chart axes and facets to build different visualization types from the same data.
- [Size by](https://docs.omni.co/visualize-present/visualizations/configuration/size.md): For scatterplots, fields can be mapped to control the size of each bubble.
- [Tooltips](https://docs.omni.co/visualize-present/visualizations/configuration/tooltips.md): Customize chart tooltips in Omni by adding fields, reordering series, and controlling which data values appear on hover.
- [X-axis configuration](https://docs.omni.co/visualize-present/visualizations/configuration/x-axis.md): To access the configuration options for the X-axis, click the (configuration options) icon to the right of the label:
- [Y-axis (left axis / right axis)](https://docs.omni.co/visualize-present/visualizations/configuration/y-axis.md): To access the configuration options for the Y-axis, click the (configuration options) icon to the right of the label:
- [Visualize data in Omni](https://docs.omni.co/visualize-present/visualizations/index.md): Turn query results into charts, tables, KPIs, and custom visualizations in Omni workbooks.
- [AI summary visualization](https://docs.omni.co/visualize-present/visualizations/types/ai-summary.md): Generate a summary of the current query's results with the AI summary visualization type.
- [Area charts](https://docs.omni.co/visualize-present/visualizations/types/area.md): Basic Area:
- [Bar charts](https://docs.omni.co/visualize-present/visualizations/types/bar.md): Basic Bar:
- [Boxplots](https://docs.omni.co/visualize-present/visualizations/types/boxplot.md): Create boxplot (box and whiskers) charts in Omni to visualize data distributions with quartiles, medians, and outliers.
- [Custom visualizations](https://docs.omni.co/visualize-present/visualizations/types/custom.md): Omni supports the most common visualization types and settings out of the box. However, if your business needs customization, you can:
- [Funnel charts](https://docs.omni.co/visualize-present/visualizations/types/funnel.md): Funnel charts visualize sequential stages in a process, showing conversion rates and drop-off between each step.
- [Heatmap Charts](https://docs.omni.co/visualize-present/visualizations/types/heatmap.md): Create heatmap visualizations in Omni to display data density and patterns using color gradients across two-dimensional grids.
- [Overview](https://docs.omni.co/visualize-present/visualizations/types/index.md): Browse all built-in Omni visualization types, including bar, line, area, map, pie, KPI, table, and custom Vega-Lite charts.
- [KPI](https://docs.omni.co/visualize-present/visualizations/types/kpi.md): KPI Tiles help highlight important data points and key performance indicators. KPIs offer a rich layer for more customized presentation and configuration.
- [Line charts](https://docs.omni.co/visualize-present/visualizations/types/line.md): Build line chart visualizations in Omni to display trends, time series, and comparisons with multi-series and stacking options.
- [Maps](https://docs.omni.co/visualize-present/visualizations/types/map.md): Omni currently supports point and region map types.
- [Markdown visualizations](https://docs.omni.co/visualize-present/visualizations/types/markdown.md): Build custom Markdown visualizations in Omni that combine text, images, links, iframes, and live query data in a single tile.
- [Pie & Donut charts](https://docs.omni.co/visualize-present/visualizations/types/pie.md): Pie:
- [Sankey charts](https://docs.omni.co/visualize-present/visualizations/types/sankey.md): Sankey charts visualize flows and relationships between stages, showing how values move through different phases of a process.
- [Scatterplots and bubble charts](https://docs.omni.co/visualize-present/visualizations/types/scatterplot.md): Create scatterplot and bubble chart visualizations in Omni to explore correlations, distributions, and data point clusters.
- [Single record tables](https://docs.omni.co/visualize-present/visualizations/types/single-record.md): Display a single data row as a pivoted column view in Omni using the single record visualization for compact data presentation.
- [Table visualizations](https://docs.omni.co/visualize-present/visualizations/types/table.md): Configure table visualizations in Omni with conditional formatting, in-line charts, layout controls, and data display options.
## OpenAPI Specs
- [openapi](https://docs.omni.co/api/openapi.yaml)