canvas account-reports
canvas account-reports¶
Manage Canvas account reports
Synopsis¶
Manage account-level reports in Canvas.
Account reports provide data exports and analytics about usage, enrollments, grades, and other institutional data.
Examples:
canvas account-reports list 1
canvas account-reports runs 1 course_storage_csv
canvas account-reports start 1 course_storage_csv
canvas account-reports get 1 course_storage_csv 10
canvas account-reports abort 1 course_storage_csv 10
Options¶
Options inherited from parent commands¶
--as-user int Masquerade as another user (admin feature, requires permission)
--columns strings Select specific columns to display (comma-separated)
--config string config file (default is $HOME/.canvas-cli/config.yaml)
--dry-run Print curl commands instead of executing requests
--filter string Filter results by text (case-insensitive substring match)
--instance string Canvas instance URL (overrides config)
--limit int Limit number of results for list operations (0 = unlimited)
--no-cache Disable caching of API responses
-o, --output string Output format: table, json, yaml, csv (default "table")
--quiet Suppress informational messages, only output data and errors
--show-token Show actual token in dry-run output (default: redacted)
--sort string Sort results by field (prefix with - for descending, e.g., -name)
-v, --verbose Enable verbose output
SEE ALSO¶
- canvas - Canvas LMS CLI - Interact with Canvas from the command line
- canvas account-reports abort - Abort a running report
- canvas account-reports delete - Delete a report run
- canvas account-reports get - Get a specific report run
- canvas account-reports list - List available report types
- canvas account-reports runs - List runs for a specific report type
- canvas account-reports start - Start a new report run