Sample output on this page is shown as the
--json envelope, which is reproducible. Pretty
tables depend on your terminal width. See Output formats.Choosing the date range
Every report takes the same three range flags. Pass--range-type for a named window, such as
last_7_days or last_30_days. Pass --range-type custom together with --start-date and
--end-date for an exact one:
YYYY-MM-DD. Every figure that is compared against the previous period of the same
length comes back as present, previous and change_percentage.
reports tickets
Reports how many tickets entered each status over the range. Use it for a volume snapshot. The pretty output is a table with one row per status.reports ticket-time-series
Reports tickets opened and tickets closed on each day of the range, as two series aligned to the same list of dates. Use it to plot a trend rather than a single total. The pretty output is a table with one row per date.reports agents
Reports each agent’s average first-response time, average resolution time, and assigned and closed ticket counts, each compared against the previous period of the same length. Times are in seconds. Thesummary and total_count the API returns alongside the list are not part of
the CLI output.
reports groups
The same metrics asreports agents, aggregated per group instead of per agent, with each
group’s id and name.
reports surveys
Reports how customers answered each satisfaction survey over the range, as a count per answer choice.reports agents and reports groups accept --page and --page-size. reports tickets,
reports ticket-time-series and reports surveys return the whole range and do not paginate.