GET /api/v3/classAnalytics/guided-journey/class/progress/{classId}

Get aggregated guided journey progress data for experience. The data is calculated only on students that participated in the class.

Request Path

GET /api/v3/classAnalytics/guided-journey/class/progress/{classId}

Request Payload

None

Parameters

{classId} The id of the class. To retrieve class IDs, use GET /api/v3/class
Example: COMcB7gdfab2DFm0WqklnX6Q2

Response Example

{
"avgExploredRate": 0.13,
"avgInProgressRate": 0.12,
"avgNotStartedRate": 0.75,
"avgPassedRate": 0.15,
"avgFailedRate": 0.05,
"avgNotInitiatedRate": 0.8,
"aggSectionStatuses": [
{
"number": 0,
"name": "Exercise 1: System Setup and Initial Configuration  ",
"exploredRate": 0.2,
"inProgressRate": 0,
"notStartedRate": 0.8,
"passedRate": 0.2,
"failedRate": 0,
"notInitiatedRate": 0.8,
"avgTimeSpent": 805.80286764,
"estimatedTimeMinutes": 10
},
{
"number": 1,
"name": "Exercise 2: Configuring Threat Intelligence and Anomaly Detection",
"exploredRate": 0.1,
"inProgressRate": 0.1,
"notStartedRate": 0.8,
"passedRate": 0,
"failedRate": 0,
"notInitiatedRate": 0,
"avgTimeSpent": 29.086879899999996,
"estimatedTimeMinutes": 10
}
]
}

Response Parameters

avgExploredRate Average explored rate of all students. Student explored rate is number of sections with ‘Explored’ status divided by number of sections * number of students
avgInProgressRate Average in progress rate of all students. Student in progress rate is number of sections with ‘In Progress’ status divided by number of sections * number of students
avgNotStartedRate Average not started rate of all students. Student not started rate is number of sections with ‘Not Started’ status divided by number of sections * number of students
avgPassedRate Average ‘Visual AI Check’ passed rate of all students. Student passed rate is number of checks with ‘Passed’ status divided by number of checks * number of students
avgFailedRate Average ‘Visual AI Check’ failed rate of all students. Student failed rate is number of checks with ‘Failed’ status divided by number of checks * number of students
avgNotInitiatedRate Average ‘Visual AI Check’ not initiated rate of all students. Student not initiated rate is number of checks with ‘Not Initiated’ status divided by number of checks * number of students
number section number in the guided journey sequence
name Section title
exploredRate Number of students that have a ‘Explored’ status in this section divided by total number of students
inProgressRate Number of students that have a ‘In Progress’ status in this section divided by total number of students
notStartedRate Number of students that have a ‘Not Started’ status in this section divided by total number of students
passedRate Number of students that have a ‘Passed’ status of the ‘Visual AI Check’ in this section divided by total number of students
failedRate Number of students that have a ‘Failed’ status of the ‘Visual AI Check’ in this section divided by total number of students
notInitiatedRate Number of students that have a ‘Not Initiated’ status of the ‘Visual AI Check’ in this section divided by total number of students
avgTimeSpent Average time spent on section by students in seconds
estimatedTimeMinutes The estimated time set for this ‘Visual AI Check’ in seconds