Docs home

Enrollment Report

Returns course enrollments in your organization for a date range, either as counts per day, week, month, quarter or year, or as a detailed list of enrollments with student details. Use it to track new enrollments or to copy them into a CRM.

GET/reports/enrollment
Enrollment Report
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/reports/enrollment?course=1399&start_date=29-04-2025&end_date=28-05-2025&time_step=1&report_details_type=3&page=1&per_page=20' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Enrollment Report Details",
  "result": {
    "studentlist": [
      {
        "enrollment_id": 2335471,
        "bundle_id": 1399,
        "user_id": 91788423,
        "name": "new",
        "email": "dfsdf@edmingle.com",
        "contact_number": "9803948822",
        "state": "",
        "contact_number_country_id": 103,
        "enrollment_day": "15-05-2025",
        "registration_number": "78979723242",
        "enrollment_mode": "Online",
        "enrollment_status": "Enrolled",
        "learner_type": "Returning",
        "bundle_name": "आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया",
        "batch_ids": "64016",
        "batches": "आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया",
        "shipping_details_json": "[]",
        "contact_number_dial_code": "+91",
        "customfield_data": [
          {
            "field_id": 233825,
            "user_id": 91788423,
            "field_display_name": "Driving Licence No.",
            "field_type": 1,
            "possible_values": "",
            "field_value": "",
            "system_field_setting": 0
          },
          {
            "field_id": 164701,
            "user_id": 91788423,
            "field_display_name": "Discription",
            "field_type": 1,
            "possible_values": "",
            "field_value": "",
            "system_field_setting": 0
          }
        ]
      },
      {
        "enrollment_id": 2335678,
        "bundle_id": 1399,
        "user_id": 91829216,
        "name": "gsdfds asd",
        "email": "saddsa@dsdasd.fasdasd",
        "contact_number": "8900934856",
        "state": "JAMMU AND KASHMIR",
        "contact_number_country_id": 103,
        "enrollment_day": "15-05-2025",
        "registration_number": "78979723249",
        "enrollment_mode": "Online",
        "enrollment_status": "Enrolled",
        "learner_type": "New",
        "bundle_name": "आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया",
        "batch_ids": "64016",
        "batches": "आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया",
        "shipping_details_json": "[]",
        "contact_number_dial_code": "+91",
        "customfield_data": []
      },
      {
        "enrollment_id": 2335679,
        "bundle_id": 1399,
        "user_id": 91829217,
        "name": "sfd asd",
        "email": "sdfsda@sfdas.sfasd",
        "contact_number": "8902345789",
        "state": "HIMACHAL PRADESH",
        "contact_number_country_id": null,
        "enrollment_day": "15-05-2025",
        "registration_number": "78979723250",
        "enrollment_mode": "Online",
        "enrollment_status": "Enrolled",
        "learner_type": "New",
        "bundle_name": "आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया",
        "batch_ids": "64016",
        "batches": "आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया",
        "shipping_details_json": "[]",
        "contact_number_dial_code": "",
        "customfield_data": []
      },
      {
        "enrollment_id": 2335686,
        "bundle_id": 1399,
        "user_id": 91829221,
        "name": "sadsa asd",
        "email": "adad@sads.adsasa",
        "contact_number": "8902348903",
        "state": "JAMMU AND KASHMIR",
        "contact_number_country_id": null,
        "enrollment_day": "15-05-2025",
        "registration_number": "78979723251",
        "enrollment_mode": "Online",
        "enrollment_status": "Enrolled",
        "learner_type": "New",
        "bundle_name": "आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया",
        "batch_ids": "64016",
        "batches": "आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया",
        "shipping_details_json": "[]",
        "contact_number_dial_code": "",
        "customfield_data": []
      }
    ]
  },
  "page_context": {
    "page": 1,
    "per_page": 25,
    "has_more_page": false,
    "total_rows": 4
  }
}

Access: Institute admins, plus custom roles with dashboard, course enrollment or enrollments report access.

Query parameters
report_details_typeintegerrequired
1 counts per period (chart), 2 counts per period (table), 3 enrollment list.
First day, as DD-MM-YYYY.
end_datestring
Last day (whole day included), as DD-MM-YYYY. At most 2 years after start_date. Send both dates: the defaults don't form a valid range.
time_stepinteger
Period for types 1 and 2: 1 day (default), 2 week, 3 month, 4 quarter, 5 year.
courseinteger
Only enrollments in this course.
pageinteger
Page number. Default 1.
per_pageinteger
Rows per page, up to 200. Default 200.
full_pageinteger
1 returns all rows without paging.
sort_bystring
TP.date_of_enrolment (enrollment time, default) or enrollment_day.
A oldest first or D newest first (default).
filtersJSON string
Optional filters (fields below).
is_exportinteger
With type 3, 1 downloads the list as a CSV file instead of JSON.
Used with is_export; purpose unclear from code.
With is_export, 1 exports only the columns of your saved view.

Fields in the filters object:

Name Required Type Description
bundle_ids No array or comma-separated string Only these courses.
batch_ids No array or comma-separated string Only these batches.
enrollment_status No integer 1 Enrolled, 2 Cancelled, 5 Expired.
enrollment_mode No integer Only enrollments from this source (online, offline and so on).
learner_type No string New (first enrollment) or Returning.
platform_type No integer Only enrollments made on this platform.
institution_stream_id No array or comma-separated string Only students who chose these streams.
product_type No array or comma-separated string Only these product types.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Enrollment Report Details
resultobject
Show child attributesHide child attributes
Show child attributesHide child attributes
Example: 2335471
Example: 1399
Example: 91788423
Example: new
Example: dfsdf@edmingle.com
Example: 9803948822
The period label
Example: 15-05-2025
Example: 78979723242
For example Online
Example: Online
Enrolled, Cancelled, Expired
Example: Enrolled
New or Returning
Example: Returning
Example: आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया
Example: 64016
Example: आचार्यात् पादमादत्ते पादं शिष्यः स्वमेधया
Your custom fields, each with field_id, field_display_name, field_type, field_value
Show child attributesHide child attributes
Show child attributesHide child attributes
Example: 1
Example: 25
Example: false
Example: 4

Notes: Dates must be DD-MM-YYYY, otherwise "Invalid Date Input You have Passed". A range over 2 years fails with "Max processing can be upto 2 years...". More than 200 per page fails with "You Only Get 200 Records Per Page". Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI