Create a schedule for a report workbook

Body Params
string
required

Schedule frequency in cron format.

Needs to match the following pattern:

(0)\                                                                        # minutes ~ 0
(\*|([0-9]|1[0-9]|2[0-3])|\*)\                                              # hours ~ * OR 0-23
(\*|([1-9]|[1-2][0-9]?|3[0-1]))?(,(\*|([1-9]|[1-2][0-9]?|3[0-1]))){0,30}\   # day of month ~ * OR 1-31
(\*|([1-9]|1[0-2]?))?(,(\*|([1-9]|1[0-2]?))){0,12}\                         # month ~ * OR 1-12
(\*|[0-6])(,(\*|[0-6])){0,7}                                                # day of week ~ * OR 0-6
$                                                                           # matches the end of the string
  • 0 10 * * 0,1,2,4,5 - At 10:00 on Sunday, Monday, Tuesday, Thursday, and Friday
  • 0 10 * * 2 - At 10:00 on Tuesday
  • 0 23 * 12 * - At 23:00 in December
  • 0 23 1,31 1,2,5,6,7,10,11 1,3 - At 08:00 on day-of-month 1 and 31 and on Monday and Wednesday in January, February, May, June, July, October, and November
string
enum
Defaults to formatted

Scheduled report view. Should be either 'formatted' or 'details'

Allowed:
string
enum
Defaults to xlsx

Scheduled report format. Should be either 'xlsx', 'csv' or 'json'

Allowed:
string

Subject of the email

recipients
array of strings
required
length between 1 and 15

List of emails that will receive the report

recipients*
report_ids
array of integers
length ≤ 15

Report schedule ids

report_ids
settings
object
Headers
integer
required
≥ 1

Property id of the client

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json