ReportList
A request or response body; the type column links to the schemas it refers to.
ReportList
| Field | Type | Required | Description |
|---|---|---|---|
| reports | array of Report | yes | By name. |
jsonExample
{
"reports": [
{
"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"
}
]
}