Batch Performance
Returns a performance summary for each active batch in your organization: students, content progress, attendance, sessions held, ratings and average assessment score. Use it to build a batch performance dashboard or export.
GET
/report/batch/overviewBatch Performance
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/report/batch/overview?report_type=batch_overview_report&page=1&per_page=50' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"batch_details": [
{
"organization_id": 5131,
"num_studs": 16,
"c_attempts": 2,
"c_perfect": 1,
"class_progress": "5",
"master_batch_name": "wallet testing-1",
"bundle_id": 31995,
"mb_start_date": 1689724800,
"mb_end_date": 1689724800,
"master_batch_id": 82290,
"mb_archived": 0,
"mb_tutor_id": 90929319,
"master_market_place": 1,
"batch_manager": "nainsi",
"bundle_name": "wallet testing",
"avg_ratings": 0,
"master_batch_status": "Active",
"batch_time_status": "Old",
"average_assessment_score": 100,
"avg_attendance": 4,
"scheduled_sessions": "387",
"conducted_sessions": "204",
"avg_session_rating": 3.88
},
{
"organization_id": 5131,
"num_studs": 12,
"c_attempts": 0,
"c_perfect": 0,
"class_progress": "0",
"master_batch_name": "nainsi",
"bundle_id": 31996,
"mb_start_date": 1696377600,
"mb_end_date": 1696377600,
"master_batch_id": 82305,
"mb_archived": 0,
"mb_tutor_id": 89364032,
"master_market_place": 1,
"batch_manager": "Enterprise Plan",
"bundle_name": "wallet installment",
"avg_ratings": 5,
"master_batch_status": "Active",
"batch_time_status": "Old",
"average_assessment_score": null,
"avg_attendance": 4,
"scheduled_sessions": "360",
"conducted_sessions": "194",
"avg_session_rating": 3.91
}
],
"page_context": {
"page": 1,
"per_page": 50,
"has_more_page": true,
"total_rows": 127
}
}Access: Institute admins, plus custom roles with batch performance, attendance, rating or module progress report access. Custom roles without access to all batches only see batches they manage or teach.
Query parameters
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Results per page. Default 50.
searchstring
Matches part of the batch name.
sort_bystring
num_studs, class_progress, avg_ratings or average_assessment_score. Default: newest batch first.sort_orderstring
A ascending or D descending (default).filtersJSON string
Optional filters (fields below).
get_progress_columnsboolean
1 adds how many students fall in each progress band.1 adds how many students fall in each attendance band.is_exportinteger
1 queues the report as a file export instead of returning rows.report_typestring
Report type used to add your custom-field columns. Purpose of values unclear from code.
Fields in the filters object:
| Name | Required | Type | Description |
|---|---|---|---|
| batch_ids | No | array of integers | Only these batches. |
| course_ids | No | array of integers | Only batches of these courses. |
| tutor_ids | No | array of integers | Only batches managed by these tutors. |
| batch_rating | No | array | [min, max] course rating. |
| batch_time_status | No | string | old (ended), running (ongoing) or upcoming. |
| start_date | No | string or Unix timestamp | With end_date: batches starting on or after this date and ending on or before end_date. |
| end_date | No | string or Unix timestamp | See start_date. |
| product_type | No | array or comma-separated string | Only courses of these product types. |
Response
codeinteger
Example:
200messagestring
Example:
Successbatch_detailsobject[]
Show child attributesHide child attributes
Example:
5131batch_details.num_studsinteger
Example:
16batch_details.c_attemptsinteger
Example:
2batch_details.c_perfectinteger
Example:
1Example:
wallet testing-1batch_details.bundle_idinteger
Example:
31995batch_details.mb_start_dateinteger
Example:
1689724800Example:
82290batch_details.mb_archivedinteger
Example:
0batch_details.mb_tutor_idinteger
Example:
90929319Example:
1Example:
nainsiExample:
100Example:
387Example:
204Example:
3.88page_contextobject
Show child attributesHide child attributes
page_context.pageinteger
Example:
1page_context.per_pageinteger
Example:
50page_context.has_more_pageboolean
Example:
truepage_context.total_rowsinteger
Example:
127Notes: With is_export=1 the response only confirms the export was queued ("Batch Overview report export has been added to queue."). Rate limit: 30 requests per minute; going over locks you out for 30 minutes.