Report page
A report opens at /workspace/$workspaceId/reports/$reportId. Every workspace member,
including View only, can open it. The page shows the report title and description, the time
window controls, the views placed in the report layout, and the comments footer.
Reports are created and edited under Setup → Reports (Editor, Admin and Owner); the editor’s settings are in Report settings. There is no Reports list outside Setup: editors open reports from the Setup list by title, Quick report opens its report directly, and other members use a direct link or a dashboard that embeds the report.
History availability
Section titled “History availability”Views that group readings by interval show only intervals that have ended; the interval still in progress is left out. An interval appears shortly after it ends. Readings that arrive late, for example after a device reconnects, are added to the intervals they belong to within a few minutes, including older ones.
Time window
Section titled “Time window”| Control | Behavior |
|---|---|
| From / To | Always shown, as YYYY-MM-DD HH:mm:ss in the report timezone. Disabled when the report has Lock time range on. |
| Reset | Returns to the report’s Default time range. Hidden when the time range is locked. |
| Quick ranges | 1m, 1h, 8h, 24h, 7d, Today, This week, Whole range, on the row with the Timezone label. Hidden when the time range is locked. Rolling ranges, Today, and This week end now and follow the current time. Whole range runs from the first to the last reading of the report parameters; it is disabled while that range is unknown, empty, or failed to load. |
| Parameters | Shown when the report has parameters. Shows or hides parameters in every view. |
The report opens with its Default time range, in the report timezone; with Browser timezone, that is the viewer’s timezone. If First reading until now finds no readings, the page shows the last 24 hours and the note No readings found. Showing the last 24 hours.
Following the current time
Section titled “Following the current time”When the window ends at the current time (after Reset, a quick range, or a default range that ends now), the report follows new readings: the end of the window moves forward each time a chart with Realtime update on receives a new live reading. A report without such a chart, for example one with only tables or with Realtime update off, keeps its window until Reset or a quick range brings it up to the current time. Editing From or To, panning, zooming, or selecting on a navigation strip stops following. With Lock time range on, a default range that ends now keeps following.
What the browser remembers
Section titled “What the browser remembers”Each browser remembers the window and the visible parameters per report, so reopening the report restores them. Reloading a report keeps it following the current time only when the remembered window ends within five seconds of now; otherwise the report stays on that window until you select Reset or a quick range. Live points received by charts are not remembered. With Lock time range on, the remembered window is ignored and the default range applies every time; the visible parameters are still restored. A dashboard tile can keep its own window separate from the report page.
Page controls
Section titled “Page controls”| Control | When shown |
|---|---|
| Title and description | Always |
| Edit (pencil) | After the title, for editors, admins and owners, when Show edit report button is on. Opens the report editor over the page. |
| Back to reports | Editors, admins and owners, on saved reports. Opens the Setup list. |
| Save | Editors, admins and owners, on an unsaved quick report. Opens the editor to save it as a regular report. |
| Back to parameters | Editors, admins and owners, on an unsaved quick report. |
| CSV | Operators, editors, admins, and owners, when Show CSV export button is on. Left of Parameters on the time window row. |
| Share snapshot | Operators, editors, admins, and owners, when Show snapshot sharing button is on. After CSV. See Report snapshots. |
| Comment / Sign | In the footer below the views. See Comments. |
The On the report switches only hide controls; they are not permissions.
Export CSV
Section titled “Export CSV”CSV downloads the readings of the current window. The export uses the parameters selected in CSV export settings that are currently visible, the current window, and the report timezone, as they are at the moment of the click. While the file is prepared, CSV turns into a progress bar with a cancel button (Cancel CSV export). Canceling or leaving the page stops the export without a file.
The file is comma-separated, UTF-8 with a byte order mark (RFC 4180). It covers the same completed intervals as a table with the export Time interval:
- With an interval, each row is one completed interval, using Numeric aggregation, Integer aggregation, and String aggregation.
- With
precise, each row is a reading timestamp from any exported parameter, and the aggregations are not used.
The time column comes first, as YYYY-MM-DD HH:mm:ss (precise adds milliseconds, .SSS). There
are no subtotals and no live points. A window without data still downloads the header row. When no
visible parameter is selected for export, or loading fails, the page shows an error and no file.
Header and text cells that begin with =, +, -, or @ get a leading apostrophe so spreadsheet
applications treat them as text, not formulas. Numeric cells, including negative numbers, stay
numeric.
Share snapshot
Section titled “Share snapshot”Share snapshot saves a fixed copy of the report as it appears now, with a public link. The button, the snapshot contents, its files, and its lifetime are in Report snapshots. The steps are in Share a report snapshot.
Views and layout
Section titled “Views and layout”Views appear in the rows and cells of the report Layout, in a grid. All views share one time window and one set of visible parameters. A layout without rows shows No views are placed in this report layout. A cell whose view no longer exists, or whose view type this app version cannot show, shows the view key and This view is not available.
Each view type is described on its own page:
Comments
Section titled “Comments”Comments belong to a report and are shared with everyone who can open it. A comment covers a time range, either for the whole report or for one report parameter; a range whose start and end are the same time marks a single moment. A signature is a special comment that confirms someone reviewed the readings. Comments appear in the footer below the report views on the report page, in dashboards that embed the report, and in shared snapshots. Comments cannot be edited. The API is in Report comment API.
Who can comment, sign, and delete
Section titled “Who can comment, sign, and delete”| Action | Who |
|---|---|
| See comments and signatures | Every workspace member |
| Comment | Operators, editors, admins, and owners, when the report has Add comments on |
| Sign | Operators, editors, admins, and owners, when the report has Sign report on |
| Delete | Editors, admins and owners: any comment or signature. Operators: their own comments (not signatures) added after the latest signature |
Add comments and Sign report are switches under On the report. They hide the buttons; they are not permissions. Unsaved quick reports do not accept comments or signatures.
Comment and signature forms
Section titled “Comment and signature forms”Comment opens a form with the text under Comment, From and To (starting with the current report window), and Parameter (None (whole report) or one report parameter). Add saves it.
Sign opens a form with a required Comment and the read-only Range: from the first reading of any report parameter until now. Sign is unavailable while that first reading is unknown: while it loads, or when the report has no readings. A signature does not lock the report, which can still be edited. After a signature, operators can no longer delete comments that were added before it.
Footer lists
Section titled “Footer lists”The footer lists Signatures and Comments as separate cards. Each card shows the range
(YYYY-MM-DD HH:mm:ss in the report timezone), the parameter label when the comment is for one
parameter, the text, and the author and time it was added. A colored edge matches the parameter’s
color, or slate for whole-report comments and signatures. Signatures are marked Signed.
- Signatures lists every signature, whatever the current window.
- Comments lists comments that overlap the current window and are either for the whole report or for a visible parameter. It appears only when the report has Comments summary on.
The footer is hidden when there is nothing to show and no button to offer. If the list cannot be loaded, the footer shows an error; the views and CSV export keep working.
Authors are shown by name, or as User when the name is not available. Comments from the in-app assistant show Assistant, and system comments show System. Comments by a deleted account show Deleted user.
Zoom and delete
Section titled “Zoom and delete”The zoom icon (Zoom) on a card sets the report window to the comment’s range. A range shorter than 10 seconds becomes a 10-second window centered on it. Zoom is hidden when the report has Lock time range on, and shared snapshots have no Zoom.
The trash icon (Delete comment) appears only on comments the viewer is allowed to delete. It asks Permanently delete this comment? before deleting.
Comment markers
Section titled “Comment markers”Some views also show comments on the data:
| View | Markers |
|---|---|
| Chart | Stripes above the plot, when Show comments is on |
| Time bars | Stripes above the plot, always |
| Table | Corner marks on cells, when Show comments is on |
New charts and tables have Show comments off.
Stripes show comments that overlap the window and are for the whole report or a visible parameter; signatures are not shown. Overlapping comments stack in separate lanes. Each stripe has the parameter’s color, or slate for whole-report comments. Hovering shows the author and text. Clicking a stripe zooms to the comment, as Zoom does, unless the time range is locked.
Corner marks in a table appear on the value cells of the comment’s parameter; whole-report comments do not mark cells. With a row interval, a cell is marked when the comment overlaps that row’s interval; with Each reading, when the reading time is inside the comment’s range. Hovering lists the comments.
Shared snapshots show the footer lists but no markers on views.