Report

A request or response body; the type column links to the schemas it refers to.

Report

Field	Type	Required	Description
id	string (uuid)	yes	—
name	string	yes	—
enabled	boolean	yes	Whether the cron tick sends it on schedule.
cadence	string	yes	`daily`: every day at `hour`. `weekly`: on `weekday` at `hour`. `monthly`: on the first of each month at `hour`. Hours are on the deployment's clock (`time_zone`). one of "daily" \| "weekly" \| "monthly"
weekday	integer	yes	Day of the week, 0 = Sunday … 6 = Saturday; read only when weekly. minimum 0 · maximum 6
hour	integer	yes	Hour of the day, 0–23, on the deployment's clock. minimum 0 · maximum 23
time_zone	string	yes	The deployment's timezone (`DEFAULT_TIMEZONE`), which `hour` is read on.
roles	array of TeamRoleRef	yes	—
recipients	array of ReportRecipient	yes	—
exclusions	array of string	no	Accounts left out of the report's people, in byte order: email domains (`@example.com`) and whole addresses, lowercased. Served to superusers only: a recipient reads the report as it is, without the accounts it leaves out named.
contents	ReportContents	yes	—
next_due_at	string (date-time) \| null	yes	When the tick next sends it; null while disabled.
last_due_at	string (date-time) \| null	yes	The latest occurrence a tick claimed, or the one current when it was scheduled.
last_run	ReportRun	yes	—
created_at	string (date-time)	yes	—
updated_at	string (date-time)	yes	—

jsonExample

{
  "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "name": "string",
  "enabled": true,
  "cadence": "weekly",
  "weekday": 1,
  "hour": 7,
  "time_zone": "America/New_York",
  "roles": [
    {
      "role_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "role_slug": "string",
      "role_name": "string",
      "department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "department_slug": "string",
      "department_name": "string",
      "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "organization_slug": "string",
      "organization_name": "string"
    }
  ],
  "recipients": [
    {
      "user_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "display_name": "string",
      "email": "string"
    }
  ],
  "exclusions": [
    "@botreeinc.com"
  ],
  "contents": {
    "overview": true,
    "roles": true,
    "role_charts": true,
    "trainees": true,
    "most_overdue": true,
    "pathways": true,
    "sign_ins": true
  },
  "next_due_at": "2026-01-01T00:00:00.000Z",
  "last_due_at": "2026-01-01T00:00:00.000Z",
  "last_run": {
    "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "report_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "trigger": "scheduled",
    "due_at": "2026-01-01T00:00:00.000Z",
    "period_from": "2026-10-19",
    "period_to": "2026-10-19",
    "status": "running",
    "started_at": "2026-01-01T00:00:00.000Z",
    "finished_at": "2026-01-01T00:00:00.000Z",
    "sent_count": 0,
    "skipped_count": 0,
    "failed_count": 0,
    "detail": "string",
    "triggered_by": "1b671a64-40d5-491e-99b0-da01ff1f3341"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}