Documentation Index
Fetch the complete documentation index at: https://docs.omni.co/llms.txt
Use this file to discover all available pages before exploring further.
Common questions
Does Omni automatically add page navigation to dashboards?
Does Omni automatically add page navigation to dashboards?
Are new pages automatically added to page navigation?
Are new pages automatically added to page navigation?
Can a page have multiple navigation items?
Can a page have multiple navigation items?
Can multiple navigation tabs point to the same page?
Can multiple navigation tabs point to the same page?
How many pages can a dashboard have?
How many pages can a dashboard have?
Requirements
To follow this guide, you’ll need:- A dashboard using advanced layouts. See Enabling advanced layout for more information.
- Content permissions that allow you to edit dashboards
Manually adding page navigation
Omni will automatically add navigation in certain scenarios. To manually add page navigation to a page, click Add > Layout > Page navigation, then place it in a container where you want the page tabs to appear. Once added, page switchers offer rich editing capabilities to customize how viewers navigate between pages.Adding navigation tabs
Tabs for new pages are added to navigation items automatically, but you can also add tabs manually to include custom URLs or link multiple tabs to one page.
- Pages - Choose an existing page or add a new page. Pages already included in the navigation will be disabled. Adding a new page will automatically add it to the navigation.
- Custom - Add a tab that navigates to an internal path or external URL. See Custom URL tabs for more information.
Editing navigation tabs
To edit an existing tab:
- Page - Allows you to select a dashboard page to link to.
- Custom - Allows you to specify a custom URL. See Custom URL tabs for more information.
Labeling navigation tabs
Each tab in a page navigation item has a label that viewers see in the switcher. Labels can be connected to the linked page’s title — so they track renames automatically — or disconnected to display custom text. Disconnected labels also support dynamic references that pull in the current page name.Selecting a label mode
When you create or edit a navigation tab, you can use the icon next to the Label field to select how the label should behave:| Label type | Description | Useful for |
|---|---|---|
| Connected | Syncs the label with the connected page’s title | Consistent naming across the dashboard |
| Disconnected | Allows you to specify a custom label that’s independent of the connected page’s name. Required to use dynamic page names in the label. | Multiple tabs pointing to the same page with different labels |
Using dynamic page names in labels
{{page.<PAGE_KEY>.name}} to create custom labels that automatically track page renames. This allows you to add custom text to page labels while keeping them synchronized with the actual page names.
<PAGE_KEY> with the unique key of the page you want to reference. For example, to create a label that displays “Overview — ” followed by the page name:
Supported properties
Only the.name property is supported. If you use other properties like {{page.KEY.description}}, the reference will be displayed as literal text rather than being expanded.
Linking multiple tabs to one page
Page switchers support multiple tabs pointing to the same page, each with its own label. This is useful when you want to provide different entry points or contexts for the same content. For example, you might have:- “Overview” and “Summary” tabs both linking to your main dashboard page
- Multiple entry points labeled for different user roles or workflows
Custom URL tabs
Custom URL tabs let you add navigation to internal dashboard paths or external resources directly from your page switcher.Creating a custom URL tab
To add a custom URL tab:- Link to - This should be set to Custom
- Label - Enter the display text for the tab. Custom URL tabs are automatically created in disconnected mode.
- URL - Enter the destination URL. See URL support for support information for different URL types.
-
Target - Choose how the URL opens:
- Same tab - Default. Navigate in the current browser tab.
- New tab - Open in a new browser tab.
- Custom - Specify a custom window name for advanced window management.
-
Forward params - Optional. Toggle on to append the current URL’s query string to the destination URL. This is useful for carrying over filter values or other parameters.
The Forward params option only appends query parameters when the destination URL is same-origin (same domain). This prevents leaking filter or token state to external sites.
URL support
| Type | Supported? | Notes |
|---|---|---|
Relative paths (e.g., /dashboard/reports) | Yes | |
External URLs with http:// or https:// | Yes | |
Email links with mailto: | Yes | |
Anchor links (e.g., #overview) | Yes | |
javascript: URLs | No | Not permitted due to security |
data: URLs | No | Not permitted due to security |
Reordering tabs
Tabs can be reordered using drag-and-drop to match your preferred navigation flow:
Removing tabs
Tabs can be removed from the page switcher without deleting the underlying page:Troubleshooting
Why is {{page.KEY.name}} showing as literal text instead of the page name?
Why is {{page.KEY.name}} showing as literal text instead of the page name?
- The property isn’t
.name- Only.nameis supported. Properties like{{page.KEY.description}}won’t be expanded. - The page key doesn’t exist - For example,
{{page.nonexistent-page.name}}will display as-is. The dashboard won’t crash, but the reference won’t expand. - The label is in connected mode - References only work on custom (disconnected) labels. Connected labels automatically use the page name and can’t include references.
Why isn't Forward params adding query parameters to my external URL?
Why isn't Forward params adding query parameters to my external URL?
Next steps
- Learn to build dashboard layouts with containers and items like charts, text, filters, and controls.
- Use pages to create multi-page dashboards, where each page has its own layout, items, and filters.
- Configure advanced filters to display filters as button toggles, multi-select dropdowns, single-day pickers, and timeframe controls.