Kubicle's Reporting API

Understand how to better utilize Kubicle's API for advanced reporting

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:

https://app.kubicle.com/api/v1/organisations//exam_submissions?api_key=&start_date=&end_date=

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:

https://app.kubicle.com/api/v1/organisations/12/exam_submissions?api_key=abcd1234&start_date=2021-01-01&end_date=2021-02-28

Endpoint 1: Lesson Viewings

URL: https://app.kubicle.com/api/v1/organisations//lessons_watched?api_key=&start_date=&end_date=

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

URL: https://app.kubicle.com/api/v1/organisations//course_completions?api_key=&start_date=&end_date=

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

URL: https://app.kubicle.com/api/v1/organisations//exam_submissions?api_key=&start_date=&end_date=

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://app.kubicle.com/api/v1/organisations//learning_time_by_learner?api_key=&start_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
Email
Learning group
Total Learning Time (hours)

Endpoint 5: Current Semester Progress

URL: https://app.kubicle.com/api/v1/organisations//current_semester_progress?api_key=

This contains the semester status of each learner for your organisation. No date range is required for this API endpoint. The data represents the current snapshot of semester progress statuses for each learner. The following information is included:

First Name
Last Name
Email
Semester Status
% of Semester Complete
Total Learning Time
Learning group

Endpoint 6: All Semester Progress

URL: https://app.kubicle.com/api/v1/organisations//all_semesters_progress?api_key=

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
Email
Learning Group
Semester
Semester Status
% of Semester Complete
Total Learning Time

Endpoint 7: Custom User Fields

URL: https://app.kubicle.com/api/v1/organisations//custom_user_fields?api_key=

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:

Email
Custom User Field 1
Custom User Field 2
Custom User Field 3

Endpoint 8: Learning Paths Progress

Url: https://app.kubicle.com/api/v1/organisations/<ORGANISATION_ID>/learning_paths_progress?api_key=<API-KEY>

This contains the learning path progress of each learner for your organisation. No date range is required for this API endpoint. The following information is included:

Email
Full name
Learning Path name
Enrollment Date
Progress
Completion Date

If there is other information you would like available from the API, please notify your Kubicle support representative.