GET /api/v1/paths/sessions/{sessionId}/stats/{userEmailOrId}
Return the progress, time spent, score and completion date of a user on a given path session.
Error messages
Status code | Error body | Reason |
---|---|---|
404 | { "error": "path_session_not_found" } | The path session ID is incorrect (the session doesn’t exist, or exists in another platform). |
404 | { "error": "user_not_found" } | The user ID or email is incorrect (the user doesn’t exist, or exists in another platform). |
404 | { "error": "user_not_enrolled" } | The user isn’t enrolled in the path session (but the user and the path session both exist in the platform). |
If both the session and the user are incorrect, return path_session_not_found
.
Fields
progress
: learner’s progress percentage on the path session, expressed as an integer (0-100).globalTime
: total time spent (in milliseconds) by the learner on the path session, expressed as an integer.score
: score obtained by the learner on the path session, expressed as an integer (0-100).status
: status of the user. Possible values:onTime
: all steps with a due date that is passed have been completed, or are optional.late
: at least one non-optional step with a due date that is passed has not been completed.completed
: all steps have been completed.awaitingCorrection
: a mandatory step is awaiting correction.
completedAt
: date when the learner earned the path, expressed in ISO 8601.detailedStatus
: Detailed status of the user, with the following fields:type
: Possible values are:awaitingCorrection
: The user reached an assessment step that the assessor hasn't validated yet.late
: The user started the path, but they are late on relative steps due dates for at least one mandatory step.notYetStarted
: The user is enrolled in an ongoing path session but they haven't started the path yet.onTime
: The user started the path, they haven't completed all the mandatory steps, and they haven't reached a blocking point.sessionNotOpened
: The user is enrolled in a path session that hasn't started yet.successful
: The user completed all the mandatory steps and fulfilled all the required conditions (time limit, minimum score, and/or mandatory replay).toRetake
: The user completed all the mandatory steps without fulfilling all the required conditions (time limit, minimum score, and/or mandatory replay), but they still haven't reached the maximum amount of authorized attempts (if any).unsuccessful
: The user had the statusnotYetStarted
,onTime
,late
, ortoRetake
when the path session ended; or the user completed the path without fulfilling all the required conditions (time limit, minimum score, or mandatory replay), and they reached the maximum amount of authorized attempts.
reason
(optional): Only the following values are included in specific cases:sessionEnded
whentype
isunsuccessful
because the session ended when the user status was eithernotYetStarted
,onTime
,late
, ortoRetake
mandatoryReplay
whentype
istoRetake
because the user completed some mandatory steps outside the path with mandatory replay.
result
: Result of the user. Possible values are:successful
: all steps are successful.unsuccessful
: the minimum score of a step has not been reachewd and there are no attempts left.retake
: the minimum score of a step has not been reached but there are attempts left.
archivedAt
: date and time (in ISO 8601 format) when the user was unenrolled from the path session. This field is not shown if the user is still enrolled. The other fields keep the value they had at the time the user was last enrolled.
Servers
- https://app.360learning.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
userEmailOrId |
String | Yes |
ID or email of the enrolled user |
sessionId |
String | Yes |
ID of the path session. |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.