Canvas Live API - Account Reports - Parameter Formatting

[jared_flaherty]

I am using the Live API to try and test Account Reports.

Specifically, the students_with_no_submissions_csv report.

I want to add the enrollment_term_id (integer, optional) optional parameter but cannot figure out how to format it in the Parameters field.

I've tried a lot different things such as this and it all returns Internal Server Error.

{"enrollment_term_id": 123}

Any help would be appreciated!

[seanbeirnes]

Hello @jared_flaherty,

I am not familiar with the exact parameters you may use for that report, but you probably need to put the parameters in a parameters object like shown below.

{
    "parameters":{
        "enrollment_term_id":123
    }
}

The Account Reports API documentation also shows that you can get a list of available reports by requesting the following endpoint:

/api/v1/accounts/:account_id/reports

This would look in your browser something like yourschool.instructure.com/api/v1/accounts/1/reports

Just be sure to replace "yourschool.instructure.com" with your institution's Canvas domain.

[jared_flaherty]

thanks, I have tried that from the following documentation below, but still getting errors.

"title": "Students with no submissions", "parameters": { "enrollment_term_id": { "required": false, "description": "The term to report on" },