Schedule report
schedule_reportSchedule one saved analysis to be emailed as a digest (CSV attached) to workspace members (a dashboard cannot be scheduled; choose or save one panel as an analysis first) on a daily / weekly / monthly cadence (UTC). One schedule per report — calling again updates it (every field is replaced, so re-pass conditions/recipients to keep them). day_of_week (0=Sun) applies to weekly; day_of_month (1-28) to monthly. Recipients default to you. Returns the schedule. CONDITIONS (email only when it's worth it): pass conditions to hold the digest unless the data warrants sending — an array (≤5) of { target, op, value }. target is "row_count" (the number of rows) or one of the report's aggregation aliases; op is one of gt|gte|lt|lte|eq|neq; value is a number. The digest sends when ANY condition is met, evaluated against that run's result (mode "any"); otherwise it's silently skipped that occurrence. E.g. email a "tasks overdue" report only when there are any: [{ target:"row_count", op:"gt", value:0 }]; or an aggregated report only when a measure alias "overdue_count" clears a threshold: [{ target:"overdue_count", op:"gte", value:5 }]. Omit conditions (or pass none) to always send — today's behavior.
When to use: Deliver one saved analysis on a schedule — 'email me this every Monday'. For a dashboard, choose or save one panel as an analysis first. Recipients are workspace members.
Example: Email the pipeline report to the sales team every Monday at 8am.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hour | No | Hour of day to send, 0–23 in UTC (default 8). | |
| enabled | No | Whether the schedule is active (default true); pass false to keep the schedule but stop sending. | |
| frequency | Yes | Cadence of the digest: daily, weekly (with day_of_week) or monthly (with day_of_month); every run fires at `hour` UTC. | |
| report_id | Yes | The saved analysis to schedule, by id (uuid); one schedule per report, so calling again replaces it. Dashboards and segments are refused. | |
| conditions | No | Up to 5 {target, op, value} send conditions — target is "row_count" or an aggregation alias, op is gt|gte|lt|lte|eq|neq, value a number; omit to always send. | |
| recipients | No | Workspace member user ids (uuids) to email; defaults to just you, and any id that is not a member is refused. | |
| day_of_week | No | Weekly only: day to send, 0=Sunday … 6=Saturday; defaults to Monday when omitted. Ignored for daily and monthly. | |
| day_of_month | No | Monthly only: day to send, 1–28 (so every month has it); defaults to the 1st when omitted. Ignored for daily and weekly. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schedule | No |