Schoolrunner may sync with your SIS to provide the foundational data upon which Schoolrunner works. If this is the case for your school – regardless of whether Schoolrunner syncs directly from your SIS' database, an SFTP site, or from Clever – at some point, you'll likely want to know when Schoolrunner last checked your SIS for changes.
You can use the Schoolrunner API to get a summary of recent syncs, when they happened, and what/how many changes were brought into Schoolrunner.
- Download this Chrome extension (or some other JSON formatter – this turns a block of questionably-legible data from the next step into something more organized and readable).
- Without this extension:
-
- With this extension:
- Visit https://YOURDOMAIN.schoolrunner.org/api/v1/sync/summary?limit=5
- This will show you details from the most recent sync (you should change the limit=5 part to look at the most recent X number of syncs – i.e. limit=3).
- Depending on the power of your computer, and the number of syncs you're pulling a summary for, this may take a couple of minutes.
- Make sure you're already signed in to your Schoolrunner site, or you'll get an "Unauthorized" error.
- You'll then be able to tell if a sync is currently running (sync_status_id = 1), has successfully completed (sync_status_id = 2), or if it failed for some reason (sync_status_id = 3)
- You can also look within the nested blocks to view more table-specific info (i.e. you can view the "students" table, or the "sections" table) like how many changes were made during the sync.
Note that times reported in the Schoolrunner API are in Coordinated Universal Time, NOT in local time.
Comments
0 comments
Please sign in to leave a comment.