status embed event - Omni Docs

Payload

{
  "status": "string",
  "dashboardId": "string"
}

Properties

string

Status of the dashboard in the iframe. One of loading, running, or done.Omni sends loading when the dashboard page renders, running when the dashboard starts to run queries, and done when all queries finish. 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.

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

{
  "status": "loading",
  "dashboardId": "dashboard-123abc"
}