Schedules

How often something repeats, such as a website's retests or a scheduled report, as an interval and a period.

Things that repeat, such as a website's retests and a report schedule, say how often with the same fields: an interval, a period, and the date the schedule counts from.

{
  "scheduleInterval": "day",
  "schedulePeriod": 5,
  "scheduleFromDate": 1767225600
}

Field	What it is
`scheduleInterval`	The unit, such as `day`, `week`, `month` or `year`.
`schedulePeriod`	How many of them apart each run is. `day` and `5` runs every five days.
`scheduleFromDate`	When the schedule counts from, as a timestamp. Each run falls a whole number of periods after it, so a weekly schedule from a Monday runs on Mondays.

Website retests#

A website's schedule, on Get a website and Update a website, adds two fields:

Field	What it is
`schedulePreset`	A named schedule in place of the three fields above: `five-daily` (every five days, Silktide's default), `weekly` (Mondays), `monthly` (the first of the month), or `none` for no retests. Empty when the interval and period were set directly.
`isActive`	`false` keeps the schedule but stops it running.

An empty scheduleInterval means the website is not retested on a schedule.

Report schedules#

A report schedule uses only the three shared fields. Its scheduleInterval is one of day, week, month or year and defaults to week, and its schedulePeriod is from 1 to 90.