A schedule runs the same load test again every day, week or month and compares each run with the earlier ones. It is how a site getting slower is noticed before visitors notice. The examples use the made-up site example.com, and the values in them are invented to show the shape of an answer.

Accessibility checks are scheduled with their own command, schedule_accessibility_check. The three other commands on this page work on both kinds of schedule.

schedule_load_test

Sets up a load test that runs by itself: daily, weekly or monthly, at an hour in the site’s time zone. Every run uses the same number of users, so the runs can be compared. An agent offers this at the end of a tuning session, to catch the site getting slower again.

  • Inputs: max_users and frequency (daily, weekly or monthly) are required, and so is one of url, journey_id or mix, as in start_load_test. hour is the hour of the day, 3 if left out. weekday is for weekly schedules, from 0 for Sunday to 6 for Saturday, Monday if left out. day_of_month is for monthly schedules, from 1 to 28. time_zone is a name such as Europe/Helsinki, UTC if left out. notify_emails lists up to five addresses that get the emails. If left out, it is the person who signed the agent in.
  • Returns: the schedule: its schedule_id, when in words, the next run time, credits_per_run and the settings you gave.
  • Cost and effect: each run costs credits when it starts, at the price of an automatic load test: 1 credit per 10 users. A run without enough credits is skipped, and the recipients are told by email. Regressions are emailed too. The domain must be verified, and an organization can have at most 10 schedules. It sends real traffic on a schedule, so the agent should ask you first and pick an hour with little traffic.

Example

“Test example.com with 100 users every Monday at 3 in the morning, Helsinki time.”

{
  "schedule_id": "22222222-3333-4444-8555-666666666666",
  "kind": "load_test",
  "domain": "example.com",
  "when": "weekly on Monday at 03:00 Europe/Helsinki",
  "max_users": 100,
  "notify_emails": ["owner@example.com"],
  "enabled": true,
  "next_run_at": "2026-11-23T01:00:00Z",
  "credits_per_run": 10
}

list_schedules

Lists the schedules of your organization, both load tests and accessibility checks. An agent calls it to find a schedule’s id before changing it, or to tell you what runs when.

  • Inputs: none.
  • Returns: schedules, each with its kind (load_test or accessibility), site, when in words, user count, whether it is enabled, the next and the last run time, and last_skip_reason if the latest run was skipped.
  • Cost and effect: free. It only reads.

Example

“What tests run automatically on my sites?”

{
  "schedules": [
    {
      "schedule_id": "22222222-3333-4444-8555-666666666666",
      "kind": "load_test",
      "domain": "example.com",
      "when": "weekly on Monday at 03:00 Europe/Helsinki",
      "max_users": 100,
      "enabled": true,
      "next_run_at": "2026-11-23T01:00:00Z",
      "last_run_at": "2026-11-16T01:00:00Z"
    }
  ]
}

update_schedule

Changes a schedule. Only the values you give change, and the rest stay as they were. An agent uses it to move the hour, change who gets the emails, or pause a schedule for a while.

  • Inputs: schedule_id is required. Any of the values of schedule_load_test can follow, and enabled: false pauses the schedule and true resumes it. The list of notify_emails cannot be made empty.
  • Returns: the schedule as it is after the change.
  • Cost and effect: free. Changing max_users makes later runs hard to compare with earlier ones, because a test with more users is a different test.

Example

“Pause the weekly test over the holidays.”

{
  "schedule_id": "22222222-3333-4444-8555-666666666666",
  "when": "weekly on Monday at 03:00 Europe/Helsinki",
  "enabled": false
}

delete_schedule

Removes a schedule, so its test no longer runs. An agent uses it when you no longer want the test, or to make room when the organization already has 10 schedules.

  • Inputs: schedule_id.
  • Returns: the id of the deleted schedule.
  • Cost and effect: free. The results of the runs it already made stay in the site’s history, where get_site_history shows them.

Example

“We do not need the weekly test any more. Remove it.”

{ "deleted": "22222222-3333-4444-8555-666666666666" }