Skip to main content
Emitted by Omni to indicate the status of the dashboard to the parent frame.

​
Payload

​
Properties

​
string
Status of the dashboard in the iframe. One of:
  • loading - Sent when the dashboard page renders
  • running - Sent when the dashboard starts to run queries
  • done - Sent when the dashboard stops running queries - whether the queries finished, a user stopped them, or a tile failed. Omni only sends done after running.
​
string
The identifier of the dashboard that emitted the status event. This allows embedded dashboard consumers to identify which dashboard is reporting its status.
​
string
Why the dashboard reached done; only sent with done. One of:
  • completed - Every query finished without an error
  • canceled - A user stopped the running queries
  • completed_with_errors - At least one tile is showing an error
This event does not report errors. To detect errors, listen for the error event. A page that renders instead of the dashboard, such as the error page for an expired embed session, emits the error event but no status event.

​
Example

A dashboard that finishes after a user stops its queries: