ReportSchedule

object

idrequired: Id
Opaque record id.
report_idrequired: Id
Opaque record id.
frequencyrequired: "daily" | "weekly" | "monthly"
timerequired: string
weekdayrequired: integer or null
month_dayrequired: integer or null
periodrequired: "report" | "yesterday" | "last_7_days" | "last_week" | "last_month" | "last_30_days"
channelsrequired: array of "email" | "whatsapp"
membersrequired: array of object
members[].idrequired: Id
Opaque record id.
members[].namerequired: string
external_emailsrequired: array of object
external_emails[].emailrequired: string
external_emails[].unsubscribedrequired: boolean
statusrequired: "active" | "paused"
descriptionrequired: string
next_run_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
last_run_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
last_statusrequired: string or null
failure_countrequired: integer
created_byrequired: object or null
created_by.idrequired: Id
Opaque record id.
created_by.namerequired: string
editablerequired: boolean
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "report_id": "cmusrceel0000q7kaafxqi1om",
  "frequency": "daily",
  "time": "string",
  "weekday": 0,
  "month_day": 0,
  "period": "report",
  "channels": [
    "email"
  ],
  "members": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    }
  ],
  "external_emails": [
    {
      "email": "string",
      "unsubscribed": true
    }
  ],
  "status": "active",
  "description": "string",
  "next_run_at": "2026-10-06T05:30:00.000Z",
  "last_run_at": "2026-10-06T05:30:00.000Z",
  "last_status": "string",
  "failure_count": 0,
  "created_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "editable": true,
  "created_at": "2026-10-06T05:30:00.000Z"
}