← API reference
CANONICAL TYPE REFERENCE

ReportSchedule

An enabled or paused schedule for executing a pinned report version.

Opaque identifier of this resource.

Immutable report version whose definition will execute.

User whose permissions are applied while querying report data.

enabledBoolean!

Whether the scheduler may start new runs for this schedule.

nextAtString

Next scheduled execution time, or null when no firing is pending.

Persisted schedule configuration as a JSON object.

View exact SDL
"""An enabled or paused schedule for executing a pinned report version."""
type ReportSchedule {
  """Opaque identifier of this resource."""
  id: ReportScheduleID!
  """Immutable report version whose definition will execute."""
  versionId: ReportVersionID!
  """User whose permissions are applied while querying report data."""
  principalId: UserID!
  """Whether the scheduler may start new runs for this schedule."""
  enabled: Boolean!
  """Next scheduled execution time, or null when no firing is pending."""
  nextAt: String
  """Persisted schedule configuration as a JSON object."""
  definition: JSON!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.