GET /api/v1/paths/sessions/{sessionId}/stats

Return the statistics of a path session.

Possible error messages

Fields

• sessionId: Identifier of the path session.

• sessionName: Name of the path session.

• pathName: Name of the path.

• pathId: Identifier of the path.

• userStatus: Number of users per status. Possible status are:

  • inProgress
  • completed
  • enrolled
  • selfEnrolled
  • started

• detailedStatus: Number of users per detailed path status. Possible status are:

  • awaitingCorrection: Users that reached an assessment step and the assessor hasn't validated the assessment yet.
  • late: Users that started the path, and they are late on relative steps due dates for at least one mandatory step.
  • notYetStarted: Users enrolled in an ongoing path session and they haven't started the path yet.
  • onTime: Users that started the path, they haven't completed all the mandatory steps, and they haven't reached a blocking point.
  • sessionNotOpened: Users enrolled in a path session that hasn't started yet.
  • successful: Users that completed all the mandatory steps and fulfilled all the required conditions (time limit, minimum score, and/or mandatory replay).
  • toRetake: Users that completed all the mandatory steps without fulfilling all the required conditions (time limit, minimum score, and/or mandatory replay), and they haven't reached the maximum amount of authorized attempts (if any).
  • Unsuccessful: Users with the status notYetStarted, onTime, late, or toRetake when the path session ended; and users that completed the path without fulfilling all the required conditions (time limit, minimum score, or mandatory replay), and reached the maximum amount of authorized attempts.

• userStats: Stats of the enrolled user, with the following fields:

  • _id: Identifier of the user.

  • deleted: true if the user is deleted; false otherwise.

  • firstName: First name of the user.

  • lastName: Last name of the user.

  • mail: Email of the user.

  • totalTimeSpentInSeconds: Number of seconds spent by the user on the path session.

  • progress: Percentage (in integer) of the user’s completion rate on the path session. 0 if the user hasn’t started it yet.

  • score Percentage (in integer) of the user’s score on the path session. null if the user hasn’t completed it yet.

  • completedAt: Date when the user has completed the path session. null if the user hasn’t completed it yet. Format is ISO 8601.

  • detailedStatus: Detailed status of the user, with the following fields:

    • type: Possible values are awaitingCorrection, late, notYetStarted, onTime, sessionNotOpened, successful, toRetake, unsuccessful.

    • reason(optional): Only the following values are included in specific cases:

      • sessionEnded when type is unsuccessful because the session ended when the user status was either notYetStarted, onTime, late, or toRetake

      • mandatoryReplay when type is toRetake because the user completed some mandatory steps outside the path with mandatory replay.

  • certificate: true if the user received a certificate for that path session; false otherwise.

  • 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.

  • customFields: Array of custom fields for the user, with the following three fields:

    • customFieldId: ID of the custom field.
    • value: value of the custom field.
    • name: title of the custom field.

  • 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.

Servers

• https://app.360learning.com

Path parameters

Query parameters

How to start integrating

1. Add HTTP Task to your workflow definition.
2. 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.
3. Click Test request to test run your request to the API and see the API's response.