Skip to content
hscli

Reporting

The report group turns Help Scout's reporting into data you can pipe anywhere. It's a set of focused reports, each scoped by a date range with --start / --end. See the command reference for all flags.

Conversation volume & resolution

Section titled “Conversation volume & resolution”
zsh — hscli
$ hscli report conversations --start 2026-05-01 --end 2026-05-31 --output json
[
  { "mailbox": "Support", "conversations": 1284, "resolved": 1102 },
  { "mailbox": "Billing", "conversations": 331,  "resolved": 318  }
]

Company-wide rollup

Section titled “Company-wide rollup”
Terminal window
hscli report company --start 2026-05-01 --end 2026-05-31

Per-agent productivity

Section titled “Per-agent productivity”
Terminal window
hscli report user --start 2026-05-01 --end 2026-05-31 --user 10

Pull metrics into your stack

Section titled “Pull metrics into your stack”

Reports return nested JSON — stream them into a notebook, a BI tool, or a jq pipeline:

Terminal window
hscli report conversations --start 2026-05-01 --end 2026-05-31 --output json > may.json