Canvas (Data Access Platform)

Set up

---

To get set up with the Canvas (Data Access Platform) connector, you will need the following:

• Client ID
• Client Secret

For more info about the API, please see the official documentation: here

Features

---

Reports detail

---

To view available tables, first run a List Tables report. This will return all available table names. Once you have the list, you can use one of these names (e.g., users) when configuring a Table Report.

📘

Table Reports

When developed this connector was intended for use and tested against the following canvas tables:

• users
• submissions
• accounts
• courses
• assignments
• enrollments

📘

Backfill start date

When setting up the Extract for the Table Report, you’ll need to specify a Backfill start date. Use the date format shown in the pre-filled example on the Extract setup page.

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.

🚧

Web Logs report

This report can contain a very large volume of data during extended backfills—potentially hundreds of millions of records—and may take several hours to complete.