Schedule report
schedule_reportSchedule one saved analysis to be emailed as a digest (CSV attached) to workspace members on a daily / weekly / monthly cadence (UTC); a dashboard cannot be scheduled — choose or save one panel as an analysis first. One schedule per report: calling again replaces every field, so re-pass conditions and recipients to keep them. day_of_week (0=Sun) applies weekly, day_of_month (1–28) monthly; recipients default to you. With conditions the digest sends only when ANY is met by that run's result, else that occurrence is skipped. Returns the schedule. List schedules with search_records(report_schedule); delete one with delete_record(report_schedule).
When to use: The user wants a saved analysis emailed on a schedule — 'email me this every Monday'.
Example: Email the pipeline report to the sales team every Monday at 8am.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"report_id": "<report_id>",
"frequency": "<frequency>"
},
"name": "schedule_report"
}
}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 |