SavedReportOutput

One saved report.

id is the report, and is what rename, schedule, run and remove address. originMessageId is the chart the user saved (M0): the run path replays it and the preview renders its attachment. A client that keys on it instead of on id will collide the moment two reports are saved from one chart.

The preview fields are null together once M0's attachment is deleted. The report is still saved, still named and still runnable; there is simply nothing to show until its next delivery, which lastReportAttachmentId then carries.

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • id
    Type: string
    required
  • isReplayable
    Type: boolean
    required
  • isScheduled
    Type: boolean
    read-only
    required
  • name
    Type: string
    required
  • originMessageId
    Type: string
    required
  • scheduleConfig
    Type: nullable
    read-only
    required

    Client-facing structured schedule shape. Shared type for the wire contract — accountsession defines it; the reporting service (or any other consumer producing schedules) translates between this and the flat storage columns (cron-or-token + interval + frequency_unit + timezone).

    accountsession does NOT use this directly on the storage Input/Output models — those stay flat to mirror the DB. Consumers build their own request/response Pydantic models using this type.

    Field semantics per frequency_unit:

    • DAY: day_of_period must be None.
    • WEEK: day_of_period must be a non-empty list of full weekday names (monday, tuesday, wednesday, thursday, friday, saturday, sunday). Multi-select.
    • MONTH: day_of_period must be a numeric string (e.g. "15"); coerced to int 1..31 by the validator.
    • QUARTER: day_of_period must be "first", "last", "fiscal-first", or "fiscal-last". Fiscal anchors are routed to the @fiscal-quarterly token path by the translator.
    • YEAR: day_of_period must be "first", "last", "fiscal-first", or "fiscal-last". Fiscal anchors are routed to the @fiscal-yearly token path by the translator.
    • FISCAL_QUARTER: day_of_period must be "fiscal-first" or "fiscal-last". Resolved against the account's fiscal_year_start at fire time.
    • FISCAL_YEAR: day_of_period must be "fiscal-first" or "fiscal-last".

    delivery_time is an ISO datetime string with offset (e.g. "2026-05-19T08:00:00+03:00"). The server extracts time-of-day (in UTC) for the cron, and the IANA timezone field carries the user's local tz for round-trip + DST-correct firing.

    Properties: 5
  • displayType
    Type: enumnullable

    How the client renders the tabular dataset as a whole.

    values
    gridbarstacked_barlinemulti_linepiegauge
  • lastReportAttachmentId
    Type: stringnullable
  • lastReportMessageId
    Type: stringnullable
  • nextRunAt
    Type: stringFormat: date-timenullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • originAttachmentId
    Type: stringnullable