Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.51 KB

README.md

File metadata and controls

36 lines (26 loc) · 1.51 KB
Raw

Canvas Page View Analytics Summary

This project downloads the page view summary for each user in a course and outputs a CSV with the following headers:

  • canvas_id: Canvas User ID.
  • page_views: The number of page views of the user.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for use with your own API tokens and Canvas domains.

Prerequisites

  1. Install Node 10 or greater.
  2. Install Git.

Host URL and Token setup

  1. Create a .env file.
  2. Generate Canvas API token and copy it to clipboard.
  3. Add the following: CANVAS_API_TOKEN={YOUR API TOKEN} and CANVAS_API_DOMAIN={YOUR API DOMAIN}. An example CANVAS_API_DOMAIN is https://{school}.instructure.com/api/v1

Installation and execution of script

  1. Clone this repo. git clone https://github.com/ubccapico/canvas-page-view-analytics-summary
  2. Then cd into the repo. cd canvas-page-view-analytics-summary
  3. Run the installation script. npm install (If you see babel-node: command not found, you've missed this step.)
  4. Open index.js and supply the Canvas course IDs where it says /* add Canvas course IDs here */.
  5. Run the script. npm start.
  6. An {Canvas course id}-pageviews.csv file should be generated for each Canvas course ID.

Authors

License

This project is licensed under the GNU General Public License v3.0.