---
title: "Create a report schedule"
method: POST
path: "/{workspace}/reports/{report}/schedules"
---

# Create a report schedule

`POST /{workspace}/reports/{report}/schedules`

## Request

- Base URL: `https://modeanalytics.com/api`
- URL: `https://modeanalytics.com/api/{workspace}/reports/{report}/schedules`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/thoughtspot/apis/mode/docs/:workspace/reports/:report/schedules/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a `Report` `Schedule`

## Path parameters

- `workspace` string, required
- `report` string, required

## Request body

- CreateReportScheduleRequestBody
  - `cron` ReportScheduleRequestBodyCronProperty, required: CronLine attributes to determine your scheduled runtime.
    - `freq` 'every_15_minutes' | 'every_30_minutes' | 'hourly' | 'daily' | 'weekly' | 'monthly': How often this schedule repeats
    - `day_of_month` unknown
    - `day_of_week` unknown
    - `hour` unknown
    - `minute` unknown
    - `time_zone` 'International Date Line West' | 'Midway Island' | 'American Samoa' | 'Hawaii' | 'Alaska' | 'Pacific Time (US & Canada)' | 'Tijuana' | 'Mountain Time (US & Canada)' | 'Arizona' | 'Chihuahua' | 'Mazatlan' | 'Central Time (US & Canada)' | 'Saskatchewan' | 'Guadalajara' | 'Mexico City' | 'Monterrey' | 'Central America' | 'Eastern Time (US & Canada)' | 'Indiana (East)' | 'Bogota' | 'Lima' | 'Quito' | 'Atlantic Time (Canada)' | 'Caracas' | 'La Paz' | 'Santiago' | 'Newfoundland' | 'Brasilia' | 'Buenos Aires' | 'Montevideo' | 'Georgetown' | 'Puerto Rico' | 'Greenland' | 'Mid-Atlantic' | 'Azores' | 'Cape Verde Is.' | 'Dublin' | 'Edinburgh' | 'Lisbon' | 'London' | 'Casablanca' | 'Monrovia' | 'UTC' | 'Belgrade' | 'Bratislava' | 'Budapest' | 'Ljubljana' | 'Prague' | 'Sarajevo' | 'Skopje' | 'Warsaw' | 'Zagreb' | 'Brussels' | 'Copenhagen' | 'Madrid' | 'Paris' | 'Amsterdam' | 'Berlin' | 'Bern' | 'Zurich' | 'Rome' | 'Stockholm' | 'Vienna' | 'West Central Africa' | 'Bucharest' | 'Cairo' | 'Helsinki' | 'Kyiv' | 'Riga' | 'Sofia' | 'Tallinn' | 'Vilnius' | 'Athens' | 'Istanbul' | 'Minsk' | 'Jerusalem' | 'Harare' | 'Pretoria' | 'Kaliningrad' | 'Moscow' | 'St. Petersburg' | 'Volgograd' | 'Samara' | 'Kuwait' | 'Riyadh' | 'Nairobi' | 'Baghdad' | 'Tehran' | 'Abu Dhabi' | 'Muscat' | 'Baku' | 'Tbilisi' | 'Yerevan' | 'Kabul' | 'Ekaterinburg' | 'Islamabad' | 'Karachi' | 'Tashkent' | 'Chennai' | 'Kolkata' | 'Mumbai' | 'New Delhi' | 'Kathmandu' | 'Astana' | 'Dhaka' | 'Sri Jayawardenepura' | 'Almaty' | 'Novosibirsk' | 'Rangoon' | 'Bangkok' | 'Hanoi' | 'Jakarta' | 'Krasnoyarsk' | 'Beijing' | 'Chongqing' | 'Hong Kong' | 'Urumqi' | 'Kuala Lumpur' | 'Singapore' | 'Taipei' | 'Perth' | 'Irkutsk' | 'Ulaanbaatar' | 'Seoul' | 'Osaka' | 'Sapporo' | 'Tokyo' | 'Yakutsk' | 'Darwin' | 'Adelaide' | 'Canberra' | 'Melbourne' | 'Sydney' | 'Brisbane' | 'Hobart' | 'Vladivostok' | 'Guam' | 'Port Moresby' | 'Magadan' | 'Srednekolymsk' | 'Solomon Is.' | 'New Caledonia' | 'Fiji' | 'Kamchatka' | 'Marshall Is.' | 'Auckland' | 'Wellington' | 'Nuku'alofa' | 'Tokelau Is.' | 'Chatham Is.' | 'Samoa': The name of the time zone in which to evaluate the scheduled time to run
  - `name` string: The name of the schedule
  - `timeout` integer: How long, in seconds, the system should wait before it decides the schedule should run again even if the last run has not completed
  - `params` ReportScheduleRequestBodyParamsProperty: A set of key/value pairs that match report parameter names and values, if the report for this schedule has any and you would like to schedule it with specific values

## Response `200`

Report `Schedule` response

- ReportSchedule
  - `name` string, required
  - `token` string, required
  - `parameters` string, required
  - `created_at` string, required
  - `updated_at` string, required
  - `retry_state` string, required
  - `retry_count` string, required
  - `retry_delay` string, required
  - `timeout` string, required
  - `last_run_at` string, required
  - `last_succeeded_at` string, required
  - `last_scheduled_run` string, required
  - `next_scheduled_run` string, required
  - `report_name` string, required
  - `delivery` string, required
  - `report_token` string, required
  - `report_type` string, required
  - `subscribed` string, required
  - `subscriber_count` string, required
  - `_links` ReportScheduleLinks, required
    - `account` Link, required
      - `href` string, required
      - `templated` boolean
    - `creator` Link
      - `href` string, required
      - `templated` boolean
    - `self` Link, required
      - `href` string, required
      - `templated` boolean
    - `report` Link, required
      - `href` string, required
      - `templated` boolean
    - `report_web` Link, required
      - `href` string, required
      - `templated` boolean
    - `report_runs` Link, required
      - `href` string, required
      - `templated` boolean
    - `report_subscriptions` Link, required
      - `href` string, required
      - `templated` boolean
  - `_embedded` unknown

## Other responses

- `401`: Unauthorized
- `404`: `Report` not found

---

[API](https://skmtc.dev/thoughtspot/apis/mode.md) - [All operations](https://skmtc.dev/thoughtspot/apis/mode/llms.txt) - [OpenAPI document](https://skmtc.dev/thoughtspot/apis/mode/revisions/4c694c3fdeb1?raw)