v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Schedules

Get schedule

get/api/v1/schedules/{scheduleId}

Path parameters

scheduleIdstring uuid required

The UUID of the scheduled task. Can be found in the schedule's URL after /schedules/.

Example:123e4567-e89b-12d3-a456-426614174000

The UUID of the scheduled task. Can be found in the schedule's URL after /schedules/.

Query parameters

userIdstring uuid

Membership ID of the user whose access should be checked (org API keys only). When provided, the endpoint checks if that user has permission to view the schedule. User-scoped API keys cannot use this parameter.

Example:987fcdeb-51a2-43d7-9b56-254415f67890

Response

Schedule details

conditionQueryMapKeystring nullable required

Query key used for alert condition (null for standard schedules)

conditionTypestring nullable required

Alert condition type: RESULTS_CHANGED, RESULTS_PRESENT, RESULTS_MISSING

createdAtstring date-time required

Creation timestamp

disabledAtstring date-time nullable required

Timestamp when the schedule was paused (null if active)

entityIdstring required

ID of the associated dashboard

fanOutboolean required

Whether personalized fan-out delivery is enabled

{"stackTrail":"components:schemas:SchedulesGetResponse:properties:filterConfig","oasType":"schema","type":"unknown","description":"The effective dashboard filter configuration that the schedule will run with: the dashboard's current default filters merged under the schedule's persisted overrides, with any keys no longer present on the dashboard dropped. This matches what is shown when the schedule is opened in the Edit Delivery panel, and may differ from the schedule's persisted filter configuration."}

idstring uuid required

Schedule UUID

killJobsOnFailureboolean required

Whether to stop the job if any queries fail

{"stackTrail":"components:schemas:SchedulesGetResponse:properties:metadata","oasType":"schema","type":"unknown","description":"Schedule metadata including format options and delivery settings. Includes `timezoneOverride` (IANA timezone applied to query execution at render time, or null when no override is set)."}

namestring required

Schedule name

organizationIdstring uuid required

Organization UUID

ownerIdstring uuid required

User ID of the schedule owner

schedulestring required

AWS EventBridge cron expression (minute hour day-of-month month day-of-week year)

systemDisabledAtstring date-time nullable required

Timestamp when the system disabled the schedule

systemDisabledReasonstring nullable required

Reason for system disabling: missingQuery, noAccess, orphanedFilterConfigKeys

timezonestring required

IANA timezone for the schedule

updatedAtstring date-time required

Last update timestamp

Example response

{
  "destinations": [
    {
      "format": "pdf"
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Weekly Sales Report",
  "schedule": "0 9 ? * MON *",
  "timezone": "America/New_York"
}