Reference
Live events
The live events endpoints of the HTTP API.
GET /dashboards/{id}/events
Stream live events for one dashboard as Server-Sent Events.
The stream starts with retry: 3000 and an event: ready whose data is {"dashboard_id","latest_version"}. After that each frame is event: <type> with the event JSON as data: version.created carries type, dashboard_id, version, parent_version, restored_from (only when the version is a restore), summary, author and created_at. comment.created and comment.updated carry type, dashboard_id, comment_id, status and author, plus panel_id for a comment on a panel and parent_id for a reply, never the comment text. comment.updated names the thread’s first comment. revision.updated is sent on every status change of a revision and carries type, dashboard_id, revision_id, status, version (the saved version, once the status is succeeded) and comment_id (for a revision requested by a comment); the saved version’s version.created arrives before the revision.updated whose status is succeeded, and clients must not depend on the order between the two. dashboard.deleted is sent once when the dashboard is deleted and carries type, dashboard_id and author (who deleted it), never the title; the stream ends at its next ping. event: resync with data {"dashboard_id"} means events may have been missed. A : ping comment arrives every 15 seconds, and the server ends the stream after 30 minutes. Clients refetch stale data on every ready and resync; events are never replayed, so Last-Event-ID is ignored. A caller may hold 20 streams and the process 1000.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id (required) |
path | string (uuid) |
Responses
| Status | Description | Body |
|---|---|---|
200 |
An open text/event-stream. |
text/event-stream |
400 |
The request is malformed or fails validation. | Error |
401 |
Authentication is missing or invalid. | Error |
403 |
The caller is not allowed to perform the request; a role that is too low is code forbidden_role. |
Error |
404 |
The resource does not exist. | Error |
429 |
The caller already holds the maximum number of open streams (too_many_streams). |
Error |
500 |
The server failed to handle the request. | Error |
503 |
The process holds the maximum number of open streams (too_many_streams) or is shutting down (shutting_down). |
Error |
Generated from api/openapi.yaml at bac0fe39. Report a problem.