Training Dashboard
The following requests relate to getting information about users' training performance from different points of view via the Schoox Academy API. Note: All requests must be Authenticated. Access Level for all requests: Administrators, Training Managers, Region and Location Managers. Depending on the role the requests return data either for all users (Access level: Administrators and Training Managers or for users that belong to a certain region or location (Access Level: Region Managers, Local Managers. You can simulate a user's view by his/her Schoox ID.
Get a List of Users
Returns a list of current users in your organization with a summary of their training performance (e.g. total training hours, courses and exams). By default only the first 100 people are returned. The list can be filtered on letter, role, region and location and paged using the optional paging parameters.
GET /dashboard/users
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| role | Users' role | Yes | String | employee |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
| aboveId | Above Unit's ID | No | Integer | 1 |
| unitId | Unit's ID | No | Integer | 4 |
| jobId | Job's ID | No | Integer | 7 |
| search | Search text | No | String | John Doe |
| start | List's starting position | No | Integer | 0 |
| limit | Number of users to return per request, up to maximum of 1,000. Default to 100 | No | Integer | 100 |
| sort | Sorting criteria | No | String | lastname |
| order | Descending or ascending order | No | String | DESC |
Example Request
https://api.schoox.com/v1/dashboard/users?role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":473159548,"firstname":"Frank","lastname":"Doe","preferred_name":"test","email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/473159548\/","custom_fields":[{"Custom Date":"2021-07-15"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan"}],"above_units":[{"id":1286994,"name":"New York"}],"total_course_hours":"0:00:00","total_courses":1,"total_exams":1,"external_ids":["1234ACEF"]},{"id":2099521483,"firstname":"John","lastname":"Doe","preferred_name":null,"email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2099521483\/","custom_fields":[{"Custom Date":"2021-07-12"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan","jobs":[{"id":1009130,"name":"Cashier"}]}],"above_units":[{"id":1286994,"name":"New York"}],"total_course_hours":"0:00:00","total_courses":1,"total_exams":1,"external_ids":["12345ABCD"]},{"id":228779921,"firstname":"Academy","lastname":"Instructor","preferred_name":null,"email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/228779921\/","custom_fields":[{"Custom Date":""},{"Custom Text Field":""}],"units":[],"above_units":[],"total_course_hours":"0:00:00","total_courses":0,"total_exams":0,"external_ids":[]},{"id":2016854398,"firstname":"Security","lastname":"Review","preferred_name":null,"email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2016854398\/","custom_fields":[{"Custom Date":""},{"Custom Text Field":""}],"units":[{"id":1006485,"name":"NY - Manhattan"}],"above_units":[{"id":1286994,"name":"New York"}],"total_course_hours":"0:00:00","total_courses":0,"total_exams":0,"external_ids":["999999998"]},{"id":1520241641,"firstname":"Security","lastname":"User","preferred_name":null,"email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/1520241641\/","custom_fields":[{"Custom Date":""},{"Custom Text Field":""}],"units":[{"id":1006485,"name":"NY - Manhattan"}],"above_units":[{"id":1286994,"name":"New York"}],"total_course_hours":"0:00:00","total_courses":0,"total_exams":0,"external_ids":["9999999988"]}]
Get List of a User's Courses
Returns a list of all courses a user is enrolled in with a summary of his or her total training and training information by course (e.g. enrollment/assignment date, due date, total time spent on the course and progress). By default only the first 100 people are returned.
GET /dashboard/users/:userid/courses
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| category_id | Academy category ID | No | Integer | 0 |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
| dropped_out | Sets whether the courses are dropped out by the user | No | String | true |
Example Request
https://api.schoox.com/v1/dashboard/users/2099521483/courses?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":3703886,"title":"Course 1","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","url":"https:\/\/www.schoox.com\/3703886\/course-1","progress":100,"total_time":"0:00:00","due_date":null,"is_due":false,"last_progress":"Jan 26, 2022","completions_count":1,"completed_by_admin":true,"assignee_first_name":"Dev","assignee_last_name":"Team","enroll_date":"2021-12-01T08:26:38+00:00","timecompleted":"2022-08-26T13:03:49+00:00","certificates":[{"id":188154098,"ver_code":"b643417","total_time":"0:00:00","time_certified":"2022-08-26T13:03:49+00:00","url":"https:\/\/www.schoox.com\/c188154098?ver_code=b643417"}],"enrolled":true,"archived":false,"completed_as_equivalent":false,"external_id":"347634","required":true,"compliance_course":false}]
Get List of a User's Curriculums
Returns a list of all curriculums a user is enrolled in with a summary of his or her total training and training information by curriculum (e.g. enrollment/assignment date, due date, total time spent on the curriculum and progress). By default only the first 100 people are returned.
GET /dashboard/users/:userid/curriculums
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/dashboard/users/2099521483/curriculums?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":93769,"title":"Curriculum 1","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/academy\/APIAcademytest\/curriculum\/card\/93769","progress":100,"total_time":"0:00:00","enroll_date":"2021-12-01T08:26:38+00:00","archived":false,"timecompleted":"2022-08-26T13:03:49+00:00","due_date":false,"is_due":false}]
Get List of a User's Exams
Returns a list of all exams a user has taken so far with information about his or her performance on every exam (e.g. number of attempts, date of last attempt, score, points, passing score). By default only the first 100 people are returned.
GET /dashboard/users/:userid/exams
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/dashboard/users/2099521483/exams?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":2744992,"name":"Exam 1","description":null,"image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","instructions":null,"attempts":1,"last_attempt":{"date_start":"2022-01-26T15:11:11+00:00","date_end":"2022-01-26T15:11:35+00:00"},"score":100,"points":{"got":100,"all":100},"passed":true}]
Get List of a User's On the job trainings
Returns a list of all on the job trainings of a user has taken so far with information about his or her performance on every on the job training. Also returns a "more" flag which indicates if there are more on the job trainings to show. By default only the first 100 on the job trainings are returned. You can optionally use the "start" parameter to set the offset of the listing
GET /dashboard/users/:userid/ojts
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
| start | Defines the offset of the on the job trainings listing" | No | Integer | 5 |
Example Request
https://api.schoox.com/v1/dashboard/users/2099521483/ojts?start=10&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
{"more":false,"on_the_job_trainings":[]}
Get a User's dashboard summary information
Get a User's dashboard summary information
GET /dashboard/users/:userid/summary
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/dashboard/users/2099521483/summary?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
{"training":{"courses":{"total_courses":1,"total_time":"0:00:00","completion_rate":100},"curricula":{"total_curricula":1,"total_time":"0:00:00","completion_rate":100},"exams":{"total_exams":1,"total_time":"0:00:11","success_rate":100},"on_the_job_trainings":{"total_on_the_job_trainings":1,"total_tasks":1,"completion_rate":0},"events":{"total_events":0,"total_time":"0:00:00","completion_rate":0}},"compliance":{"courses":{"total_courses":0,"total_time":"0:00:00","completion_rate":0,"compliance_progress":0},"curricula":{"total_curricula":0,"total_time":"0:00:00","completion_rate":0,"compliance_progress":0}}}
Get a User's manager dashboard information
Get a User's dashboard summary information
GET /dashboard/users/:userid/manager
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/dashboard/users/2099521483/manager?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
User does not have the necessary permissions to view manager dashboard
Get a List of Courses
Returns a list of all courses with title, short description and image.
GET /dashboard/courses
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| role | Users' role | Yes | String | employee |
Example Request
https://api.schoox.com/v1/dashboard/courses?role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":3703886,"title":"Course 1","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","students":2,"completion_rate":50,"publish_date":"2021-12-01T09:08:53+00:00"}]
Get a List of Enrolled Users in a Course
Returns a list of enrolled users in a course with a summary of information for every user (e.g. enrollment date, user’s region and location, total time spent on course and total progress).
GET /dashboard/courses/:courseid
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| role | Users' role | Yes | String | employee |
| aboveId | Above Unit's ID | No | Integer | 1 |
| unitId | Unit's ID | No | Integer | 4 |
| jobId | Job's ID | No | Integer | 7 |
| search | Search text | No | String | John Doe |
| start | List's starting position | No | Integer | 0 |
| limit | Number of users to return per request, up to maximum of 1,000. Default to 100 | No | Integer | 100 |
| sort | Sorting criteria | No | String | lastname |
| order | Descending or ascending order | No | String | DESC |
Example Request
https://api.schoox.com/v1/dashboard/courses/3703886?role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":473159548,"firstname":"Frank","lastname":"Doe","preferred_name":"test","email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/473159548\/","custom_fields":[{"Custom Date":"2021-07-15"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan"}],"above_units":[{"id":1286994,"name":"New York"}],"enrolment_date":"2022-08-26T13:03:36+00:00","progress":0,"time":"0:00:00","certificates":[],"external_ids":["1234ACEF"]},{"id":2099521483,"firstname":"John","lastname":"Doe","preferred_name":null,"email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2099521483\/","custom_fields":[{"Custom Date":"2021-07-12"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan","jobs":[{"id":1009130,"name":"Cashier"}]}],"above_units":[{"id":1286994,"name":"New York"}],"enrolment_date":"2021-12-01T08:26:38+00:00","progress":100,"time":"0:00:00","certificates":[{"id":188154098,"ver_code":"b643417","total_time":0,"time_certified":"2022-08-26T13:03:49+00:00","url":"https:\/\/www.schoox.com\/c188154098?ver_code=b643417"}],"external_ids":["12345ABCD"]}]
Get detailed Course Progress for a User
Courses can consist of one or more lectures and exams. This request returns detailed information about a user's progress on a course for every single lecture and exam of it (e.g. lecture name, progress, time spent, number of attempts, name of exam, score, date of last attempt).
GET /dashboard/courses/:courseid/users/:userid
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
Example Request
https://api.schoox.com/v1/dashboard/courses/3703886/users/2099521483?&role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
{"lectures":[{"id":1997763,"title":"API","progress":0,"time":"0:00:00"}],"exams":[{"id":2744992,"title":"Exam 1","last_attempt":"1970-01-01T00:00:00+00:00","passed":true,"score":100,"points":{"got":100,"all":100}}],"certificates":[{"id":188154098,"ver_code":"b643417","total_time":"0:00:00","time_certified":"2022-08-26T13:03:49+00:00","url":"https:\/\/www.schoox.com\/c188154098?ver_code=b643417"}]}
Get a List of Curriculums
Returns a list of all curriculums with title, short description, image and number of courses.
GET /dashboard/curriculums
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| role | Users' role | Yes | String | employee |
Example Request
https://api.schoox.com/v1/dashboard/curriculums?role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":93769,"title":"Curriculum 1","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","students":2,"completion_rate":50,"publish_date":"2021-12-01T08:26:04+00:00"}]
Get a List of Enrolled Users in a Curriculum
Returns a list of enrolled users in a curriculum with a summary of information for every user (e.g. enrollment date, total time spent on the curriculum and total progress).
GET /dashboard/curriculums/:curriculumid
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| role | Users' role | Yes | String | employee |
| aboveId | Above Unit's ID | No | Integer | 1 |
| unitId | Unit's ID | No | Integer | 4 |
| jobId | Job's ID | No | Integer | 7 |
| search | Search text | No | String | John Doe |
| start | List's starting position | No | Integer | 0 |
| limit | 'Number of users to return per request, up to maximum of 1,000. Default to 100 | No | Integer | 100 |
| sort | Sorting criteria | No | String | firstname |
| order | Descending or ascending order | No | String | DESC |
Example Request
https://api.schoox.com/v1/dashboard/curriculums/93769?role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":473159548,"firstname":"Frank","lastname":"Doe","preferred_name":"test","email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=226581108&user=473159548","custom_fields":[{"Custom Date":"2021-07-15"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan"}],"above_units":[{"id":1286994,"name":"New York"}],"enrolment_date":"2022-08-26T13:36:18+00:00","progress":0,"time":"0:00:00","external_ids":["1234ACEF"]},{"id":2099521483,"firstname":"John","lastname":"Doe","preferred_name":null,"email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=226581108&user=2099521483","custom_fields":[{"Custom Date":"2021-07-12"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan","jobs":[{"id":1009130,"name":"Cashier"}]}],"above_units":[{"id":1286994,"name":"New York"}],"enrolment_date":"2021-12-01T08:26:38+00:00","due_date":"1970-01-01T00:00:00+00:00","progress":100,"time":"0:00:00","external_ids":["12345ABCD"]}]
Get detailed Curriculum Progress for a User
Curriculums can consist of one or more courses. This request returns detailed information about a user’s progress on a curriculum for every single course of it (e.g. course name, image, time spent and total progress).
GET /dashboard/curriculums/:curriculumid/users/:userid
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| external_id | Sets whether the id given is the external_id of the User. By default, the value is "false" |
No | String | true |
| dropped_out | Sets whether the curricula are dropped out by the user | No | String | true |
Example Request
https://api.schoox.com/v1/dashboard/curriculums/93769/users/2099521483?&role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":3703886,"title":"Course 1","time":"0:00:00","progress":100}]
Get a List of Exams
Returns a list of all exams with title, image and publishing date.
GET /dashboard/exams
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| role | Users' role | Yes | String | employee |
Example Request
https://api.schoox.com/v1/dashboard/exams?role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":2744992,"name":"Exam 1","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","students":2,"success_rate":100,"average_score":100}]
Get a List of Enrolled Users in an Exam
This returns a list of all users for an exam with detailed information about every user's performance (e.g. user’s name, number of attempts, date of last attempt, starting date, ending date, score, points and status: passed / failed).
GET /dashboard/exams/:examid
Query parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 226581108 |
| apikey | Your academy's API key | Yes | String | 9d3419535b0c8d76f7f6f72800f62f92 |
| role | Users' role | Yes | String | employee |
| aboveId | Above Unit's ID | No | Integer | 1 |
| unitId | Unit's ID | No | Integer | 4 |
| jobId | Job's ID | No | Integer | 7 |
| search | Search text | No | String | John Doe |
| start | List's starting position | No | Integer | 0 |
| limit | 'Number of users to return per request, up to maximum of 1,000. Default to 100 | No | Integer | 100 |
| sort | Sorting criteria | No | String | firstname |
| order | Descending or ascending order | No | String | DESC |
Example Request
https://api.schoox.com/v1/dashboard/exams/2744992?role=employee&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":2099521483,"firstname":"John","lastname":"Doe","preferred_name":null,"email":"John.Doe1@schoox.com","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/academies\/profile.php?acadId=226581108&user=2099521483","custom_fields":[{"Custom Date":"2021-07-12"},{"Custom Text Field":"Text"}],"units":[{"id":1006485,"name":"NY - Manhattan","jobs":[{"id":1009130,"name":"Cashier"}]}],"above_units":[{"id":1286994,"name":"New York"}],"attempts":1,"last_attempt":"2022-01-26T15:11:11+00:00","passed":true,"score":100,"points":{"got":"100","all":"100"},"external_ids":["12345ABCD"]}]