Generate the training duration report via API

Introduction

By default, the Training duration report shows the expected amount of time that learners spend on training (as specified in the training settings) in the current catalog.

LMS admins and Microsoft 365 global admins can choose to track the actual amount of time learners took to complete e-learning courses, based on how long they spent consuming content displayed in the Learn365 player. Time spent in content that is launched and accessed outside of the Learn365 player isn't tracked.

You can generate the report in the Learn365 Admin Center or via API.

In this article, we describe the steps you should follow to generate the two variants of the Training duration report via API.

 

Generate the training duration report - expected duration

 

Before generating the report, you’ll need the ID of the course catalog to which the needed training belongs. You can find this via the API by following the steps in this article.

To generate the Training duration (expected duration) report via API:

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the Reports section, select the GET /reports/trainingDuration/learnersTrainingDuration endpoint and select Try it out in the top right-hand corner.

3. Enter the following required query parameters:

• courseCatalogId: ID of a course catalog.
• startDate: date and time from which training is taken into account, for example, 2024-01-15T15:00:00.00Z. The report contains only training completed after the start date.
• endDate: date and time until which training is taken into account, for example, 2024-07-15T15:00:00.00Z. The report contains only training completed before the end date.

 

 

4. Select Execute to run the request.

 

 

5. Go to the Response block to check the results:

• 200 code with a list of learners and training data in its body means the successful response.
• 200 code with an empty body means there is no data to display. In this case, you can change the request parameters, for example, expand the date range.
• In case of an error, the response body contains the error object with the code and message keys explaining the issue.

Data in a successful response is split by learners and contains:

• LearnerName: full name of a learner.
• Email: a learner’s email address.
• Department: a department to which a learner belongs.
• CourseInfo array with a list of every course or training plan that a learner completed during the specified time period. Every course or training plan has the following details:
  • CourseCatalogName: the name of the catalog.
  • CourseName: the name of the training that a learner completed.
  • CourseCategory: a category to which training belongs.
  • CourseDuration: the duration of the course or training plan (in minutes) in the way it was specified in the Duration field of the course or training plan configuration panel. The report shows the duration that was valid when the learner enrolled in the training.
  • CompletionDate: date and time when a learner completed their training.

 

 

Generate the training duration report - actual duration

 

Before generating the report, you’ll need the enrollment ID for the specific training you want to track. You can find this via the API by following the steps in this article.

To generate the Training duration (actual duration) via API:

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the Reports section, select the GET /reports/trainingDuration/learnerActualTrainingDuration endpoint and select Try it out in the top right-hand corner.

3. In the enrollmentId query parameter, enter the enrollment ID for the training you want to track.

4. Select Execute to run the request.

 

 

5. Go to the Response block to check the results.

• 200 code with a list of learning sessions and training duration data in its body means the successful response.
• 404 code means there is no data to display for the enrollment ID specified in the request.
• In case of an error, the response body contains the error object with the code and message keys explaining the issue.

Data in a successful response:

• UserName: username of the learner.
• CourseId: the ID of the course.
• CourseName: the title of the course.
• CourseStatus: Completed.
• RealDurationMinutes: the actual amount of time the learner spent in the learning session.
• StartDateTime: the date and time the learner started the learning session.
• EndDateTime: the date and time the learner left the Learn365 player or completed the course.