API Call to get final grade in gradebook to enable us to integrate it into SMS.

[MimieVermeulen]

Hi Everyone,

We use weighted assignment groups to calculate the final grade of our students. 

 

For example in the attached image you can see two assignment groups that counts 50% each towards the final grade and then the total grade as calculated by Canvas. 

We would like this total grade to be integrated into our SMS. Is there an API statement that would give me the total grade for a course?

Or how could I go about getting this information. I specifically want the "Total" grade. Not the grade for assignment groups or an individual assignment. I will get the SMS team to do the rest, but I just need to know how to extract this data from Canvas. 

Thank you for your help!

[JamesSekcienski]

The List Enrollments endpoint will provide grade information for users enrolled in the course.  You will likely want to include the 'type[]' query parameter to limit the enrollments to just 'StudentEnrollment'.

[melodyc_lam]

@MimieVermeulen 

Assuming you're an admin on an account in Canvas:

I would pull the Grade Export report instead of trying API calls into each course.

Go to the account in question (ex. XXX.instructure.com/accounts/1 leads to the "root level" account), then go to Settings -> Reports tab and run the Grade Export report. That will save you many API calls with going to each course and then pulling grades.

I also advise a 'sanity check' to make sure the Grade Export report reflects the grade that is shown in Canvas for the gradebook.

There is an API call to grab reports.

Hopefully this meets your needs!

[sendres]

Hi @MimieVermeulen,

Listing the course enrollments includes a grade summary for each student. See, for example, this response from one of our test users enrolled in a test course:

[
    {
        "id": 48771748,
        "user_id": 5744424,
        "course_id": 2258512,
        "type": "StudentEnrollment",
        "created_at": "2024-03-19T21:52:17Z",
        "updated_at": "2024-03-19T21:53:34Z",
        "associated_user_id": null,
        "start_at": null,
        "end_at": null,
        "course_section_id": 2397451,
        "root_account_id": 1877,
        "limit_privileges_to_course_section": false,
        "enrollment_state": "active",
        "role": "StudentEnrollment",
        "role_id": 4818,
        "last_activity_at": null,
        "last_attended_at": null,
        "total_activity_time": 0,
        "sis_import_id": 8408320,
        "grades": {
            "html_url": "https://dominicanu.instructure.com/courses/2258512/grades/5744424",
            "current_grade": null,
            "current_score": null,
            "final_grade": null,
            "final_score": 0.0,
            "unposted_current_score": null,
            "unposted_current_grade": null,
            "unposted_final_score": 0.0,
            "unposted_final_grade": null
        },
        "sis_account_id": "16515",
        "sis_course_id": null,
        "course_integration_id": null,
        "sis_section_id": "394b1bc0-ab09-4747-a12d-458b40453bd8",
        "section_integration_id": null,
        "sis_user_id": "JennyTran",
        "html_url": "https://dominicanu.instructure.com/courses/2258512/users/5744424",
        "user": {
            "id": 5744424,
            "name": "Jenny Trần",
            "created_at": "2024-03-19T11:02:46-05:00",
            "sortable_name": "Trần, Jenny",
            "short_name": "Jenny Trần",
            "sis_user_id": "JennyTran",
            "integration_id": null,
            "sis_import_id": 8407810,
            "login_id": "jetran",
            "pronouns": "she/her/hers"
        }
    }
]

I recommend testing in your environment to make sure this gives you the correct information.

[thomas_walker]

Is it possilbe to determine when the final grades have been posted and are available for the program to use?  Is there an indicator in Canvas?