← All types
ReportingIn Input object

ReportScheduleInput

Create or update a report schedule with a timezone and execution principal.

Fields

Schedule to update; omit to create a new schedule.

Immutable report version whose definition will execute.

User whose permissions are applied while querying report data.

cron

StringOptional

Cron expression for recurring execution; mutually exclusive with runAt.

runAt

StringOptional

ISO 8601 execution time for a one-time schedule; mutually exclusive with cron.

IANA timezone used for schedule evaluation and calendar period boundaries.

Optional notification destination for scheduled report results.

Optional completed calendar period to use for scheduled parameters.

Possible values (3)
PREVIOUS_DAY

The previous complete calendar day.

PREVIOUS_WEEK

The previous complete calendar week.

PREVIOUS_MONTH

The previous complete calendar month.

Values for the parameters declared by the report definition.

Whether a firing may start while a prior run of this schedule is still active.

Whether the scheduler may start new runs for this schedule.

Referenced by (1)
Exact type SDL
"""
Create or update a report schedule with a timezone and execution principal.
"""
input ReportScheduleInput {
  """Schedule to update; omit to create a new schedule."""
  id: ReportScheduleID
  """Immutable report version whose definition will execute."""
  versionId: ReportVersionID!
  """User whose permissions are applied while querying report data."""
  principalId: UserID!
  """
  Cron expression for recurring execution; mutually exclusive with runAt.
  """
  cron: String
  """
  ISO 8601 execution time for a one-time schedule; mutually exclusive with cron.
  """
  runAt: String
  """
  IANA timezone used for schedule evaluation and calendar period boundaries.
  """
  timezone: String!
  """Optional notification destination for scheduled report results."""
  notificationRecipientId: NotificationRecipientID
  """Optional completed calendar period to use for scheduled parameters."""
  period: ReportSchedulePeriod
  """Values for the parameters declared by the report definition."""
  parameters: JSON
  """
  Whether a firing may start while a prior run of this schedule is still active.
  """
  allowOverlap: Boolean
  """Whether the scheduler may start new runs for this schedule."""
  enabled: Boolean!
}