https://github.com/ubc/canvas-page-view
Download Canvas user(s) full page view logs
https://github.com/ubc/canvas-page-view
Last synced: 7 months ago
JSON representation
Download Canvas user(s) full page view logs
- Host: GitHub
- URL: https://github.com/ubc/canvas-page-view
- Owner: ubc
- License: gpl-3.0
- Created: 2020-09-08T18:01:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T20:39:28.000Z (9 months ago)
- Last Synced: 2024-10-17T07:07:30.539Z (8 months ago)
- Language: JavaScript
- Size: 103 KB
- Stars: 2
- Watchers: 7
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Canvas Page View
This project downloads the page views for specified Canvas users and outputs a CSV for each user with the following headers:
* 'id'
* 'app_name'
* 'url'
* 'context_type'
* 'asset_type'
* 'controller'
* 'interaction_seconds'
* 'created_at'
* 'user_request'
* 'render_time'
* 'user_agent'
* 'participated'
* 'http_method'
* 'remote_ip'
* 'links'
An explanation of what these headers mean can be found here: https://canvas.instructure.com/doc/api/users.html#PageView
## 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](https://nodejs.org)**.
2. **Install [Git](https://git-scm.com/downloads)**.
### Host URL and Token setup
1. Create a `.env` file.
1. Generate Canvas API token and copy it to clipboard.
1. 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`
1. Then cd into the repo. `cd canvas-page-view`
1. Run the installation script. `npm install` (If you see `babel-node: command not found`, you've missed this step.)
1. Add your Canvas user IDs to `index.js`, as well as the start time and end time, where it says: `getPageViewsForUsers([/* add Canvas user IDs */], /* add start date */, /* add end date */)`
1. The start and end times should be specified in UTC time like this: `2020-05-18T00:00:00Z`
1. Run the script. `npm start`.
1. An `{Canvas user id}-pageviews.csv` file should be generated for each Canvas user id.
## Note
Please note that this project downloads `remote-ip`, which is the origin IP address of the request. IP addresses are considered personal information and should be treated with care. Sharing IP addresses of students without formal approval from an Associate Dean is not permitted. Please contact the [LTHub](mailto:[email protected]) if you have any questions or concerns.
## Authors
* [justin0022](https://github.com/justin0022) -
**Justin Lee** <[email protected]>
## License
This project is licensed under the GNU General Public License v3.0.