How to see SIS import logs within UI

[qnguyen]

Hi,

We have both SIS script run and manual import at the same time. So how can I see the logs from UI ? right now when click on the UI, SIS Import, the only one shows is the Last Batch of Import.

Thanks

[mcowen · Accepted solution]

To view the log of the latest import, go Admin>SIS Imports or https://_____.instructure.com/accounts/self/sis_import

To view the last 10 imports, add an 's' on the end of the previous URL https://_____.instructure.com/accounts/self/sis_imports

To go back further in the import logs add a ?page=2 (or ?page=3 etc.) at the end of the previous URL https://_____.instructure.com/accounts/self/sis_imports?page=2

You can also use ?per_page=30  or 40 or 50  etc. at then end of the URL ( up to ?per_page=100 ).

Note: you will want to have some sort of JSON parser to make the page more readable. I use JSON Formatter in Chrome.

Is this what you are looking for?

[qnguyen]

Yes it worked, this is great and I also used that converter too.

Thank you.

I guess Canvas should have this function built in somewhere on the UI

[mcowen]

This might be a feature to vote for:

[jcruse]

This was so helpful, thank you!  The JSON Formatter in Chrome worked wonders for reading the SIS import logs.

[AndyChavez]

Hello,

I know the post is a bit old but wanted to know if the url format is still the same for today.  I've tried it and it is not working for me.

[jbagley]

@AndyChavez 

I ran into some issues initially. There's a random string of letters (meant for some purpose I don't know), but it needs to be removed for this to work. I was able to load the file just fine. But I can't make heads or tales of it without that JSON converter.

[James]

@AndyChavez 

The /accounts/self/sis_import endpoint takes you to the page to view the SIS import.

If you want to see the log, then make sure there is an s at the end of sis_import. /accounts/self/sis_imports

There is actually an API call for this, which is what Canvas is accessing behind the scenes when you leave off the /api/v1. The API allows you to filter the SIS imports by date or workflow state.

For others talking about the need for an extension, you can view this without installing a browser extension. You can copy/paste the JSON into a JSON to CSV converter. I use the one at data.page, although data is sent to the server. If you want an in-browser converter, then konklone.io has one. I find the JSON to CSV nice since it presents the information in a human-friendly table.

Another option is to use the native browser tools. Firefox natively displays JSON in a human-friendly form. For Chrome, you can open the developer tools (F12), go to the Network tab, make sure All is selected and then load/reload the page; click on the sis_imports and then click on Preview. Not as easy as having a tool to it for you, but it is an option for those who cannot install an extension.

[jbagley]

I'm curious about your response to the API. I don't know much about APIs in general, but I am pretty familiar with programming codes and I am a quick learner in that regard. Where is this API or how do I get it working? I'd love to use a tool like that instead of using the website UI.

[James]

@jbagley 

I linked to the API documentation for the SIS import, but here it is for the existing REST API. Canvas has made the decision to start moving to a GraphQL API and new development will take place there. You would probably want to visit the Canvas Developer's group here in the community for more information. Much of using the API has already been explained there.

[jbagley]

@James 

Sorry, I guess my question is not very clear.  I have no idea how to use any of these codes.  What do I type them into?  They don't work in a Chrome browser.  I don't know of any program that's capable of running those codes.  What program(s) do I need to interact with the APIs?

[jerry_nguyen]

@jbagley 

@Code-with-Ski has created a Google Chrome extension to display SIS Import Log, you can check it out here: https://community.canvaslms.com/t5/Canvas-Developers-Group/Creating-a-Chrome-Extension-to-Use-with-C...

You can use a program called "Postman" to interact with Canvas API