Embedded Integration

Students API

This section allows you to manage student interactions with experiments and retrieve grades.

Play Experiment

POST {Tenant endpoint}/api/v2/learning-path/student/experiment/play

Tenant endpoint example: yoursubdomain.jusoorlabs.com

Headers
Name Required Type Description
referer Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required string The API token provided by Jusoor Labs.
Parameters
Name Required Type Description
experiment_token Required string Token of the experiment to play
student_uuid Required string Unique identifier of the student
student_name Required string Display name of the student
type Optional string If "mobile", link provides option to open in app or download app
Response

The API returns a signed URL (link) in the response body. Your system should redirect the student directly to this link to launch the experiment — there is no additional processing required.

200 OK application/json
{
    "status": true,
    "message": "Experiment link generated successfully",
    "data": {
        "url": "https://yoursubdomain.jusoorlabs.com/experiment/play?token=eyJhbGciOiJIUzI1NiIs..."
    }
}

Get Experiment Grades

GET {Tenant endpoint}/api/v2/learning-path/student/grades/experiment/{experiment_token}?student_uuid={student_uuid}

Tenant endpoint example: yoursubdomain.jusoorlabs.com

Headers
Name Required Type Description
referer Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required string The API token provided by Jusoor Labs.
Path & Query Parameters
Name Required Type Description
experiment_token Required string Token of the experiment, passed in the URL path.
student_uuid Required string Unique identifier of the student, passed as a query parameter.
Response

Returns the experiment's info, the requested student's info, and their attempt(s) on that experiment.

200 OK application/json
{
    "status": true,
    "message": "Experiment grades fetched successfully",
    "data": {
        "experiment": {
            "token": "dc4e9a42-0de5-474a-8139-0edee88c1b08",
            "name": null
        },
        "student": {
            "jusoor_uuid": 14,
            "partner_uuid": "hamza-01",
            "student_name": "Hamza Alzughbieh"
        },
        "attempts": [
            {
                "time": 2.8619997501373,
                "progress": 36,
                "final_step": 4,
                "max_steps": 11,
                "quiz_mark": 100,
                "quiz_time": 0,
                "language": "Arabic",
                "experiment_type": "WithoutInstruction",
                "created_at": "2026-08-11 14:26:09"
            }
        ]
    }
}

Get Learning Path Grades

GET {Tenant endpoint}/api/v2/learning-path/student/grades/learning-path/{subject_uuid}?student_uuid={student_uuid}

Tenant endpoint example: yoursubdomain.jusoorlabs.com

Headers
Name Required Type Description
referer Required string The root of the application sending the request (e.g., jusoorlabs.com)
accept Required string Always set as application/json
token Required string The API token provided by Jusoor Labs.
Path & Query Parameters
Name Required Type Description
subject_uuid Required string Unique identifier of the subject (learning path), passed in the URL path.
student_uuid Required string Unique identifier of the student, passed as a query parameter.
Response

Returns the learning path, the requested student's info, and every linked experiment with that student's attempt(s) on it.

200 OK application/json
{
    "status": true,
    "message": "Learning path grades fetched successfully",
    "data": {
        "learning_path": {
            "subject_uuid": "1a2e6ba2-d5fd-4a7f-99b3-48cd4a486b98",
            "subject_name": "Subject1"
        },
        "student": {
            "id": 14,
            "uuid": "hamza-01",
            "name": "Hamza Alzughbieh"
        },
        "experiments": [
            {
                "experiment_token": "dc4e9a42-0de5-474a-8139-0edee88c1b08",
                "experiment_name": "Lab1",
                "attempts": [
                    {
                        "time": 2.8619997501373,
                        "progress": 36,
                        "final_step": 4,
                        "max_steps": 11,
                        "quiz_mark": 100,
                        "quiz_time": 0,
                        "language": "Arabic",
                        "experiment_type": "WithoutInstruction",
                        "created_at": "2026-08-11 14:26:09"
                    }
                ]
            }
        ]
    }
}