Data Export
Organization Administrators can download performance reports from the the Data Export page of their Organization Dashboard.
Reports are available in .CSV or .XSLX format. Click on the "EXPORT" link to choose.
Some Reports can be customized and exported over a specified date range.
Date Selectors will be available to you via the Date Range column where this is possible.
Reports can take a number of seconds to generate before they download to your web browser.
For larger reports a loading page will open in another tab in your browser. From there, the Download button will appear when the report has be generated.
API Access
Introduction
Kubicle has developed a simple CSV based API that allows you to access their learner data in an automated fashion. This API is currently in beta, as such, endpoints and their constraints may change in the future.
Getting Started
A Kubicle support representative will provide you with your organization ID and API key. The API key grants access to the API. It is important that it is kept confidential. Our team will share the key via Saltify. The Saltify link is single use - once your team access the API key in Saltify it cannot be recovered. You’ll need to copy the key from Saltify and store it in a secure location. Please contact our support team if you need the API key deactivated.
Usage
CSV exports of data can be accessed from the API via GET request. The request must contain:
-
The API key
-
The organization ID
-
A start date, formatted YYYY-MM-DD
-
An end date no more that 90 days after the start date, formatted YYYY-MM-DD
The general format of the URL for requests is:
For example, to get all the exam submissions from 1st January 2021 to 28th February 2021 for the organization with id 12 and API key abcd1234 the URL is:
Endpoint 1: Lesson Viewings
This contains the details of each lesson viewing in the time period. The following information is included:
-
Learning group
-
Name
-
Email
-
Learning Plan Version
-
Course
-
Lesson
-
Lesson Duration in Seconds
-
Date Watched
-
Seconds Watched
Endpoint 2: Course Completions
This contains the details of each course completion in the time period. The following information is included:
-
Learning group
-
Name
-
Email
-
Learning Plan Version
-
Course
-
Date Completed
Endpoint 3: Exam Submissions
This contains the details of each exam attempt in the time period. It includes incomplete submissions. The following information is included:
-
Learning group
-
Name
-
Email
-
Learning Plan Version
-
Course
-
Score
-
Date Attempted
Endpoint 4: Learning Time by Learner
URL:
https://kubicle.com/api/v1/organisations/<ORGANISATION_ID>/learning_time_by_learner?api_key=<API-KEY>&start_date=<START_DATE>&end_date=<END_DATE>
This contains the learning time of each learner for your organisation in the time period. It includes a record for learners with no learning time. The following information is included:
- First Name
- Last Name
- Learning group
- Total Learning Time (hours)
Endpoint 5: Current Semester Progress
- First Name
- Last Name
- Semester Status
- % of Semester Complete
- Total Learning Time
- Learning group
Endpoint 6: All Semester Progress
URL:This contains the semester status of each learner for your organisation, including all their semesters. No date range is required for this API endpoint. The data represents the current snapshot of semester progress statuses for each learner across all semesters. The following information is included:
- First Name
- Last Name
- Learning Group
- Semester
- Semester Status
- % of Semester Complete
- Total Learning Time
Endpoint 7: Custom User Fields
URL:This contains the custom user fields of each learner for your organisation. No date range is required for this API endpoint. The report is limited to the first 3 custom user fields. If you have fewer than 3 custom user fields defined then you will see empty columns where there is no custom user field data. The following information is included:
- Custom User Field 1
- Custom User Field 2
- Custom User Field 3