rocketkind
Analytics

Omni

Omni is a business intelligence platform: models define the metrics, workbooks and dashboards present them, and schedules deliver them.

Authentication

  • API token

Actions

Generic API request. Call any Omni API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Create folderCreate a folder in Omni, optionally nested under an existing one, and get its new id back so a later step can file documents into it.
  • Get documentRead one Omni document's published state — its name, description, the model it is built on, its query tabs, dashboard controls, layout containers and display settings.
  • List database connectionsList the warehouses and databases this Omni organization queries, with each connection's id, display name, dialect, database, default schema and base role.
  • List document queriesRead every saved query in an Omni document, in tab order, each with the query JSON object in exactly the shape omni:runquery takes.
  • List documentsPage through the workbooks and dashboards in this Omni organization, optionally narrowed to a folder, to a set of labels, or to a sort order.
  • List foldersPage through this Omni organization's folder tree, optionally narrowed by path prefix, label or visibility scope.
  • List labelsRead every content label defined in this Omni organization, with each label's name, colour, description, usage count and whether it is verified or pinned to the homepage.
  • List modelsPage through this Omni organization's models — the semantic layers a query runs against.
  • List schedules and alertsPage through Omni's scheduled deliveries and alerts, with each one's cron expression, timezone, destination, owner, last run time and last status.
  • Run queryExecute a query against an Omni model and get the rows back — the action that actually moves data out of Omni.
  • Search dashboardsFind dashboards by keyword, matched against dashboard names, descriptions and tile titles, ranked most relevant first.
  • Trigger scheduleDestructiveSend an existing Omni delivery or alert now, outside its cron schedule, to the recipients it is already configured for.
  • Wait for query resultsCollect the results of query jobs that were still running when omni:runquery returned.
  • Who am IRead who this Omni connection authenticates as, which kind of key it holds, and what it is allowed to do — before a workflow tries an operation and finds out from a 403.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.