Canvas (Data Access Platform)
Version 0.0.0
Set up
To get set up with the Canvas (Data Access Platform) connector, you will need the following:
- Client ID
- Client Secret
Features
Feature | Support | Notes |
---|---|---|
Backfill | ✅ | All-time |
Incremental | ✅ | Table Report |
API reliability | 🟢 | Reliable API |
Reports detail
You can run List Tables
report to see names of available tables. This will return all the possible table names. Once this is run, you can use the name when setting up a Table Report
(e.g. users
).
⬇️ Report | 🔑 Incremental key | 🔑 Primary key |
---|---|---|
List Tables | N/A | N/A |
Table Report | \_KLEENE_UNTIL_DATE | dependent on report |
Table Reports
When developed this connector was intended for use and tested against the following tables:
- users
- submissions
- accounts
- courses
- assignments
- enrollments
Backfill start date
When setting up the Extract for the
Table Report
, you’ll need to specify aBackfill start date
.On the first run, if the start date you provide is too early (i.e., outside the bounds of available data), you may encounter an error in the logs like this:
"The ‘since’ parameter in the request (2024-03-28T14:28:43Z) precedes the earliest data available (2024-03-28T14:28:43.273Z)"
If this happens, simply use the timestamp provided in the error message to update the Extract configuration, then re-run the report.
Updated about 15 hours ago