CreateReportRequest
A request or response body; the type column links to the schemas it refers to.
CreateReportRequest
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | yes | What the report is called, in its emails and on its page. 1–120 characters |
| enabled | boolean | no | Defaults to true. |
| 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 | no | Defaults to 1 (Monday). minimum 0 · maximum 6 |
| hour | integer | no | Defaults to 7. minimum 0 · maximum 23 |
| role_ids | array of string (uuid) | yes | The department roles the report covers: its people are everyone currently holding one of them. 1–100 items |
| recipient_ids | array of string (uuid) | yes | The accounts the report goes to. Each may also open the report's page, whether or not they manage the roles it covers. at most 50 items |
| exclusions | array of string | no | Defaults to the trainer dashboard's default exclusions, as they stand when the report is created; `[]` leaves nobody out. at most 20 items |
| contents | ReportContentsChanges | no | — |
{
"name": "Weekly forklift operator progress",
"enabled": true,
"cadence": "weekly",
"weekday": 1,
"hour": 7,
"role_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"recipient_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
],
"exclusions": [
"@botreeinc.com"
],
"contents": {
"overview": true,
"roles": true,
"role_charts": true,
"trainees": true,
"most_overdue": true,
"pathways": true,
"sign_ins": true
}
}