Get Enrollment Statistics
Returns enrollment statistics per course for a date range: enquiries, registrations, paid enrollments and revenue. This is the data behind the Course Enrollment report.
GET
/report/packagesGet Enrollment Statistics
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/report/packages?start=1661970600&end=1664562599&organization_id=2&page=1&per_page=25' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"package_performance": [
{
"0": "99",
"1": "Test Package 6",
"2": 0,
"3": 0,
"4": "1",
"6": 0,
"7": 0
},
{
"0": "111",
"1": "Test Pkg",
"2": 0,
"3": 0,
"4": "1",
"6": 0,
"7": 0
},
{
"0": "114",
"1": "test13",
"2": 0,
"3": 0,
"4": "1",
"6": 0,
"7": 0
},
{
"0": "129",
"1": "March&Course",
"2": 0,
"3": 0,
"4": "2",
"6": 0,
"7": 0
},
{
"0": "615",
"1": "13/09/2022 Purchase",
"2": 0,
"3": 0,
"4": "1",
"6": 0,
"7": 0
}
],
"enquiries": [
null,
0,
0
],
"page_context": {
"page": 1,
"per_page": 25,
"has_more_page": false,
"total_rows": 5
}
}Access: Institute admins and tutors, plus custom roles that can view or export the course-enrollment report.
Query parameters
startUnix timestamp
Start of the period. Default 0 (all time).
endUnix timestamp
End of the period. Default now.
organization_idinteger
Organization to report on. Defaults to your
ORGID organization.institution_idinteger
Institution to report on. Defaults to the institution of
organization_id.owner_idinteger
Only count enquiries, registrations and enrollments of learners whose enquiry is owned by this counsellor.
searchstring
Matches part of the course name.
filtersstring (JSON)
{"currency_id": N} limits revenue to payments in that currency.sort_columnstring
Sort by
enquiry, registered, admitted, total_revenue, pretty_name or created_at.sort_orderstring
A ascending; anything else sorts descending.page / per_pageinteger
Echoed in
page_context. All rows are returned in one response.Response
codeinteger
Example:
200messagestring
Example:
Successpackage_performanceobject[]
One array per course
Show child attributesHide child attributes
package_performance.0string
Example:
99package_performance.1string
Example:
Test Package 6package_performance.2integer
Example:
0package_performance.3integer
Example:
0package_performance.4string
Example:
1package_performance.6integer
Example:
0package_performance.7integer
Example:
0enquiriesnull[]
page_contextobject
Show child attributesHide child attributes
page_context.pageinteger
Example:
1page_context.per_pageinteger
Example:
25page_context.has_more_pageboolean
Example:
falseNotes: Free enrollments are not counted. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.