Report schedules
Make a snapshot report on a regular interval, and email it to people.
A report schedule makes a snapshot report on a regular interval, from a report template and a context, and emails it to its subscribers: users and roles in the account, and any other email addresses. Each email links to the new snapshot.
How often it runs is a schedule: scheduleInterval, schedulePeriod and scheduleFromDate. How far back each snapshot looks is durationInterval and durationPeriod, counted back from when it runs.
Each snapshot appears in List reports with the schedule's reportScheduleId, and stays there after the schedule is deleted.
- GETList report schedules
/v1/report-schedulesReturns every report schedule the API key's user can see, with no paging. - GETGet a report schedule and who it emails
/v1/report-schedules/{reportScheduleId}Returns one report schedule and who it emails. - POSTCreate a report schedule
/v1/report-schedulesCreates a report schedule: on each run it makes a snapshot from a report template and emails it to its subscribers. - PUTUpdate a report schedule or who it emails
/v1/report-schedules/{reportScheduleId}Changes a report schedule, who it emails, or both. - DELDelete a report schedule
/v1/report-schedules/{reportScheduleId}Deletes a report schedule at once, so it makes no more snapshots and sends no more emails.