scheduled-reports

PUT /api/v1/scheduled-reports/{pk}/

Update a scheduled report

Request

Path parameters

pkstring required

Request body

pkinteger
urlstring
sla_reportstring nullable

Select an SLA report to send on this schedule

recipient_usersstring[]

Select the users that should receive this report

created_atstring date-time
namestring required

Name of this scheduled report

file_type'PDF' | 'XLS'
recurrence'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY'

How often to deliver this report

default_date_range_override'TODAY' | 'YESTERDAY' | 'LAST_7D' | 'LAST_30D' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_QUARTER' | 'LAST_QUARTER' | 'THIS_YEAR' | 'LAST_YEAR'

Override default date range for this report

on_weekday1 | 2 | 3 | 4 | 5 | 6 | 7

Weekly reports will be sent on this day

at_time0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23

Reports will be sent at this time (local time)

is_enabledboolean
recipient_emailsobject

Additional emails that will receive this report

Response

pkinteger
urlstring
sla_reportstring nullable

Select an SLA report to send on this schedule

recipient_usersstring[]

Select the users that should receive this report

created_atstring date-time
namestring required

Name of this scheduled report

file_type'PDF' | 'XLS'
recurrence'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY'

How often to deliver this report

default_date_range_override'TODAY' | 'YESTERDAY' | 'LAST_7D' | 'LAST_30D' | 'THIS_WEEK' | 'LAST_WEEK' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_QUARTER' | 'LAST_QUARTER' | 'THIS_YEAR' | 'LAST_YEAR'

Override default date range for this report

on_weekday1 | 2 | 3 | 4 | 5 | 6 | 7

Weekly reports will be sent on this day

at_time0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23

Reports will be sent at this time (local time)

is_enabledboolean
recipient_emailsobject

Additional emails that will receive this report

Changes

No recorded changes to this operation across all 1 revision of this API.