Docs home

Organization Based Data Extract

Exports raw data for one organization, one data set at a time and one page at a time: courses, batches, tests, exercises, learner progress statistics and more. Use it for a bulk data extract into your own warehouse.

GET/institution/dataexport
Organization Based Data Extract
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/institution/dataexport?type=1&page=10&per_page=2&organization_id=2&start_date=1629728773&bundleId=688' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "success",
  "resource": [
    {
      "bundle_id": 5,
      "bundle_name": "IIT-JAM Maths",
      "is_archived": 1
    },
    {
      "bundle_id": 7,
      "bundle_name": "CET",
      "is_archived": 1
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 2
  }
}

Access: The institute admin only (the main admin account of the institute).

Query parameters
typeintegerrequired
Which data set to export (see below).
organization_idintegerrequired
Organization to export.
pageintegerrequired
Page number, starting at 1.
per_pageintegerrequired
Rows per page. At most 1000 for types 5, 6, 7 and 10.
bundleIdintegerFor types 11, 17, 18
Course ID (get it from type 1).
start_dateUnix timestampFor type 8
Start of a 5-day window. Defaults to now.

type values:

Type Data set
1 Course list: bundle_id, bundle_name, is_archived (courses you created or created in your organizations)
2 Course modules created in the organization: course_id, name
3 Batches: batch_id, batch_name, bundle_id, tutor_id, is_default_batch, is_archived, start_date, end_date
4 Curriculum tests: quiz_id, quiz_name, course_id, test_id, points, test_time, passing_mark, create_date
5 Learner overall statistics, with registration_number
6 Learner test statistics, with registration_number (slow; use a small per_page)
7 Learner section statistics, with registration_number
8 Learner material views in the 5 days from start_date (not paginated)
9 Exercises, assignments and programming assignments, with course_id
10 Learner exercise statistics, with registration_number
11 Teaching materials of a course (bundleId) (not paginated)
12 Classes: bundle_id, batch_id, class_id, course_id, ClassName, tutor_id, archived
13 Course to course-module links: bundle_id, course_id
14 Course module statistics
15 Learners who completed a batch: batch_id, user_id, start and end dates
16 YouTube links used in course materials
17 Teaching materials of a course (bundleId) with file names (not paginated)
18 Attendance sessions of a course (bundleId): batch, class and attendance_id, class_date (not paginated; scheduled classes are not included)
Response200application/json
codeinteger
Example: 200
messagestring
Example: success
resourceobject[]
Show child attributesHide child attributes
Example: 5
Example: IIT-JAM Maths
Example: 1
Show child attributesHide child attributes
Example: 1
Example: 2

Notes: Statistics types return the stored rows as they are, so their columns may change. Errors: "Not Authorized" (you are not the institute admin), "For Type N, Maximum Per Page is 1000", "Bundle Id Required For N". Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI