Skip to main content

Scheduled report attributes for recurring report delivery. Note: reports to generate, email recipients, and FTP recipients are specified in the 'relationships' object (not in attributes) — see ScheduledReportRelationships.

frequency
enum<string>
required

Schedule frequency. Day = days of the week (1=Mon to 7=Sun). Month = days of the month (1-31).

Available options:
Day,
Month
name
string
required

Schedule name for identification

Maximum string length: 50
numbers
integer[]
required

Day numbers when the schedule runs. For Day frequency: 1-7 (Mon-Sun). For Month frequency: 1-31.

time
string
required

Time of day to run the schedule (e.g., 09:00)

body
string | null

Email body text included with the scheduled report delivery

subject
string | null

Email subject line for the scheduled delivery

Maximum string length: 256