Choose 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:
last_7_days, last_30_days, last_24_hours, this_week, last_week, this_month, last_month, this_quarter, last_quarter, this_year, last_year, all_time, and custom. Without --range-type a report covers the last 30 days. The previous period has the same length as the range, so this_month is compared with all of last month.
With a signed-in session, a report covers only the tickets you are allowed to see. Every report also returns start_date, end_date, previous_start_date, and previous_end_date.
Dates are YYYY-MM-DD. Every figure that is compared against the previous period of the same
length comes back as present, previous, and change_percentage.
Show ticket volume
This command reports how many tickets entered each status over the range. Use this when you want a volume snapshot. The pretty output is a table with one row per status.Sample output (--json)
Show the ticket time series
This command reports tickets opened and tickets closed on each day of the range, as two series aligned to the same list of dates. Use this when you want to plot a trend rather than a single total. The pretty output is a table with one row per date.Sample output (--json)
Show agent performance
This command 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. Use this when you review how each agent is doing. Times are in seconds. Thesummary and total_count the API returns alongside the list are not part of
the CLI output.
Sample output (--json)
Show group performance
This command reports the same metrics asreports agents, aggregated per group instead of per agent, with each
group’s id and name. Use this when you compare teams.
Sample output (--json)
Show survey results
This command reports how customers answered each satisfaction survey over the range, as a count per answer choice. Use this when you want to track customer satisfaction.Sample output (--json)
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.