ReportContents
A request or response body; the type column links to the schemas it refers to.
ReportContents
What the report's email, notification and page show.
| Field | Type | Required | Description |
|---|---|---|---|
| overview | boolean | yes | The share of requirements complete across everyone the report counts, with a chart of how many people stand where. |
| roles | boolean | yes | Each role's progress in words, with a chart comparing the roles (two roles or more). |
| role_charts | boolean | yes | Each role's requirements by state — complete, overdue, not certified — as a pie chart, with the share of its holders fully certified in the middle. |
| trainees | boolean | yes | Under each role, a line per holder: their share of the role's requirements complete, how many are overdue, and a bar of the three states, as the trainer dashboard lists them. |
| most_overdue | boolean | yes | The people with the most certifications overdue. |
| pathways | boolean | yes | Each learning pathway's levels as milestones; only while the learning pathways feature is shown. |
| sign_ins | boolean | yes | The period's sign-ins and active accounts, with a chart of each day. Off, the report reads no sign-ins at all, and its page leaves out the sign-in statistics. |
{
"overview": true,
"roles": true,
"role_charts": true,
"trainees": true,
"most_overdue": true,
"pathways": true,
"sign_ins": true
}