Read Automation Dashboard Data
readAutomationDashboardDataThe figures a Module automation's Pulse dashboards show, computed server-side the same way the dashboard computes them: each tile's label, value, unit and display (the value as the dashboard prints it), with a description where the label alone leaves the figure unclear and a note for what the tile shows besides it. Call this for any number on a Module dashboard instead of reading the dashboard's HTML (getPulseDashboardHtml refuses Module dashboards for size) or paging through Cases: a recount can disagree with the tile the user sees. Pass dashboard_id for one dashboard, or leave it out for every dashboard of the automation the caller may open. range applies to dashboards with a time range control; the result names the range it read. Pass time_zone with the user's IANA zone so a day starts at their midnight, as their dashboard's do; without it days start at midnight UTC, and range.time_zone says which zone was used. Quote display, say the period it covers, and name and link the dashboard with its link. A dashboard whose figures are not declared, or that was changed since it was installed, comes back unsupported; one that could not be read comes back error; both carry a hint. Needs Queues on the team's plan. Each link is a path in the Duvo web app; give the user the full URL beside it (url).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| range | No | today, yesterday, week, month, ytd or all, for dashboards with a time range control; leave out for the range the dashboard opens on | |
| time_zone | No | IANA zone the range's days start in, such as Europe/Prague. Pass the user's own zone so Today matches their dashboard; UTC when left out | |
| dashboard_id | No | One of the automation's Module dashboards; leave out to read every one | |
| automation_id | Yes | Automation ID |