- 01
/plugin marketplace add exploreomni/omni-agent-skills - 02
/plugin install omni-analytics@omni-analytics
Finds and organizes existing dashboards and workbooks in Omni — searching by name, browsing folders and labels, and pulling up a direct link to what it finds.
WHEN TO USE
USE FOR
- Find the dashboard that already answers a question before building a new one.
- List every dashboard in a folder to see what already exists.
- Download a dashboard as a PDF to send to someone outside the team.
- Tag a group of related dashboards with the same label for easy filtering.
- Pull up the queries behind a dashboard's tiles to see what they actually compute.
This is a saved copy of the skill's SKILL.md instructions. It may differ from the upstream file or the version you install.
Omni Content Explorer
Find, browse, and organize Omni content — dashboards, workbooks, and folders — through the Omni CLI.
Prerequisites
# Verify the Omni CLI is installed — if not, ask the user to install it
# See: https://github.com/exploreomni/cli#readme
command -v omni >/dev/null || echo "ERROR: Omni CLI is not installed."# Show available profiles and select the appropriate one
omni config show
# If multiple profiles exist, ask the user which to use, then switch:
omni config use <profile-name>
# Confirm the active profile is authenticated and inspect your permissions:
omni whoami whoamiAuth: a profile authenticates with an API key or OAuth. If
whoami(or any call) returns 401, hand off — ask the user to run! omni config login <profile>(OAuth 2.1 browser flow; it blocks ~2 min on the browser). Don't runconfig loginyourself in a headless/CI session (no browser → timeout); on a local interactive machine you may. See theomni-api-conventionsrule for profile setup (omni config init --auth oauth) and discovering command and request-body shapes with--schema.
Discovering Commands
omni content --help # Content operations
omni documents --help # Document operations
omni folders --help # Folder operationsTip: Use
-o jsonto force structured output for programmatic parsing, or-o humanfor readable tables. The default isauto(human in a TTY, JSON when piped).
Known Issues & Safe Defaults
omni content listdoes not currently support a--labelsfilter. For dashboards,omni content search --q <labelName>matches labels. For an exhaustive by-label listing (including workbook-only documents), useomni documents list --include labels -o json, paginate with--cursor, then filter records whoselabelsarray contains the target label.- Some dashboard exports can fail before a job is created, for example with
Cannot use 'in' operator to search for 'query_id' in .... Ifomni dashboards downloadreturns an error and no job ID, do not calldownload-statusor claim the export completed. Report the dashboard identifier, the exact API error, and that no downloadable job was created.
Searching Content
For "find the dashboard about X", reach for free-text search first (CLI ≥ 1.1.2):
omni content search --q "revenue" --limit 25--q keywords are matched against dashboard names, descriptions, query names, folder names, labels, and creator names. --limit caps results at 1–25. Each result carries identifier, name, description, folderPath, tileNames, verified, and a ready-made url — link the user straight to it. Search covers dashboards only — workbook-only documents don't surface here, so fall back to omni content list / omni documents list filtering when the target may not have a dashboard.
Browsing Content
List All Content
omni content listWith Counts and Labels
omni content list --include '_count,labels'Filter and Sort
# By label: list documents with labels, then filter the JSON results client-side.
# Paginate with --cursor until pageInfo.hasNextPage is false.
omni documents list --include labels -o json
# By scope
omni content list --scope organization
# Sort by popularity or recency
omni content list --sort-field favorites
omni content list --sort-field updatedAtPagination
Responses include pageInfo with cursor-based pagination. Fetch next page:
omni content list --cursor <nextCursor>Working with Documents
List Documents
omni documents list
# Filter by creator
omni documents list --creator-id <userId>Each document includes: identifier, name, type, scope, owner, folder, labels, updatedAt, hasDashboard.
Important: Always use the
identifierfield for API calls, notid. Theidfield is null for workbook-type documents and will cause silent failures.
Get Document Queries
Retrieve query definitions powering a dashboard's tiles:
omni documents get-queries <identifier>Useful for understanding what a dashboard computes and re-running queries via omni-query.
Folders
# List
omni folders list
# Create
omni folders create "Q1 Reports" --scope organizationLabels
# List labels
omni labels list
# Find documents with a label
omni documents list --include labels -o json
# Add label to document
omni documents add-label <identifier> <labelName>
# Remove label
omni documents remove-label <identifier> <labelName>
# Add/remove labels on a folder in one atomic call (CLI ≥ 1.1.2).
# Labels must already exist in the organization.
omni folders bulk-update-labels <folderId> --body '{ "add": ["Q1"], "remove": ["Draft"] }'Favorites
# Favorite
omni documents add-favorite <identifier>
# Unfavorite
omni documents remove-favorite <identifier>Dashboard Downloads
# Start download (async)
omni dashboards download <identifier> --body '{ "format": "pdf" }'
# Poll job status only after the start command returns a job ID
omni dashboards download-status <identifier> <jobId>Formats: pdf, png
URL Patterns
Construct direct links to content:
Dashboard: {OMNI_BASE_URL}/dashboards/{identifier}
Workbook: {OMNI_BASE_URL}/w/{identifier}The identifier comes from the document's identifier field in API responses. Always provide the user a clickable link after finding content.
Search Patterns
When scanning all documents for field references (e.g., for impact analysis), paginate with cursor and call omni documents get-queries <identifier> for each document. Launch multiple query-fetch calls in parallel for efficiency. For field impact analysis, prefer the content-validator approach in omni-model-explorer.
Docs Reference
Related Skills
- omni-query — run queries behind dashboards you've found
- omni-content-builder — create or update dashboards
- omni-embed — embed dashboards you've found in external apps
- omni-admin — manage permissions on documents and folders
Account or credentials required
1 FOR YOU- 01Install and connect the Omni CLI
Install the Omni CLI and authenticate a profile against your Omni instance before searching or browsing content.
- Listed as free
- Connected services may require an account or charge fees.
This skill ships inside the Omni Analytics Agent Skills plugin. Listed package contents include 3 agents. Installed components and skill versions may vary by AI tool.
Install as a Claude Code plugin
Typed inside the agent's own prompt, not in a terminal. This skill uses files kept elsewhere in its plugin, so install the whole plugin — on its own the skill would be missing them.
