Skip to content

canvas analytics department

canvas analytics department

View department analytics

Synopsis

View department-level analytics for an account.

If --account-id is not specified, uses the default account ID from config.

Analytics types: - statistics: Overall department statistics - activity: Department participation over time - grades: Grade distribution

Examples:

canvas analytics department                     # Uses default account
canvas analytics department --account-id 1
canvas analytics department --type grades --term-id 123
canvas analytics department [flags]

Options

      --account-id int   Account ID (uses default if configured)
  -h, --help             help for department
      --term-id int      Filter by term ID
      --type string      Analytics type: statistics, activity, grades (default "statistics")

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")
      --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

Auto generated by spf13/cobra on 25-Jan-2026