Canvas GuidesCanvas Admin Guide Canvas DataHow do I use the Canvas Data Portal for an account?

How do I use the Canvas Data Portal for an account?

When your Customer Success Manager or Implementation Consultant enables Canvas Data for your account, Account Settings includes the Canvas Data Portal link. This link allows the Canvas Data Administrator to manage Canvas Data.

Note: Any Canvas admin in your account can view the Canvas Data Portal link, but unless they have been granted access by the Canvas Data Administrator, they cannot view the page content.

The Canvas Data Portal allows the Canvas Data Administrator to:

  • view recent data exports
  • view current users
  • manage IP address whitelist
  • generate credentials for Redshift
  • generate credentials for Canvas Data API access (used for downloading flat files)

Open Canvas Data Portal

Open Canvas Data Portal

In Account Navigation, click the Canvas Data Portal link.

View Canvas Data Portal

The Canvas Data Portal allows you to manage Canvas Data. The portal includes two sections: the Credential Portal [1] and Documentation pages [2].

View Credential Portal

View Credential Portal

By default, the Canvas Data Portal opens to the Credential Portal, which includes all the credentials of your Canvas Data account.

View Recent Data Exports

Depending on your account access, the Recent Data Exports section displays downloadable files daily or monthly. The date of the file is when the data finished the export, not the actual date of the data. Most recent data is generally 24–36 hours older than the given date.

View Users

The Manage Users section shows admins who have been given access to the Canvas Data Portal, along with their permissions. You cannot edit permissions for yourself.

Any admin who does not have access but who has tried to view the portal also appears in the list. You can choose to edit that user's settings and grant permission access at any time. Learn how to manage Canvas Data Admin users.

View API Credentials

View API Credentials

If you would like to grant access to other users or third-party partners to automatically download data, you can generate API credentials and pass them to those users. To generate the credentials, click the Create Credentials button.

Once the credentials are generated, you will need to save them and transmit them securely to the users or third-party partners that will need them. The credentials can be regenerated at any time but the old credentials will be invalidated.

Learn more about the Canvas Data API.

View IP Address Whitelist

If your account allows you to access Redshift, you can manage the IP Addresses that can be used to connect to the database.

To add an IP, locate the Add IP heading [1]. In the IP Address field, enter the IP Address, then click the Submit button.

The IP Address appears as a new line item in the whitelist [2]. To remove the address, click the Remove button [3].

View Redshift Server Info

View Redshift Server Info

If your account allows you to access Redshift, your account will include access to a hosted online Redshift Amazon data warehouse. This data warehouse environment is accessible via any ODBC compliant analytics tool such as R, Excel, Tableau. To generate credentials for this environment, click the Create Credentials button.

Once the credentials are generated, you will need to save them. The credentials can be regenerated at any time but the old credentials will be invalidated.

View Documentation

View Documentation

To view Canvas Data documentation, click the Documentation tab menu.

The Schema Docs explain all the table data that is exported from Canvas.

The API Docs show all the API calls you can use for Canvas Data.