learner_report
Progress reports: view data · Read only
Let the connected AI app read the data behind a learner’s progress report — attendance and every live class, test scores with rank and class average, marks by subject, study time and what was studied, course progress next to the batch average, assignments with feedback, doubts with their replies and the analysis of each attempt — plus the reports already generated in the dashboard, so it can write the report for you. Read-only. The AI app writes the report itself, so it uses no AI credits.
Parameters
Parameters
string
required
The action to run:
guide, data, saved_reports, saved_report.string
The learner’s learner_id (from learners find).
string
data: window start, YYYY-MM-DD.
string
data: window end, YYYY-MM-DD (inclusive).
string
data: one of the learner’s batch_ids (from learners get) to scope progress / assignments. Default: their latest batch.
string[]
data: report sections to include. Default: all.
string[]
data: detail parts to include. Default: all but attempt_details (the per-question input of each attempt — large). [‘none’] = no detail.
integer
data: newest attempts to include in attempt_insights (default 10, max 50; attempt_details max 15).
string
saved_report: a report_id from saved_reports.
integer
saved_reports: page, from 0.
What your AI app is told about this tool
What your AI app is told about this tool