Skip to main content
A report aggregates conversation activity over a date range. For fields and response details, see the Reports API reference.

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 --start-date and --end-date together for an exact range instead, with or without --range-type custom_duration:
Dates are YYYY-MM-DD. With all three flags omitted, the range defaults to all_time. Every figure compared against the previous period of the same length comes back as present, previous and change_percentage.

Show the conversations report

Conversation volume over the range: opened, closed, replied to, and left unassigned, each compared against the immediately preceding period of the same length.
Without --json, the pretty output is a table with one row per metric.

Show the customer satisfaction report

How customers rated conversations on each day of the range, broken down into good, okay and bad. data is null when the workspace has no rating question configured on its post-chat survey.
Without --json, the pretty output is a table with one row per date and one column per rating.

Show the groups report

The same conversation metrics as the conversations report, broken down by group instead of for the whole workspace. All groups are returned; the response is not paginated.
Without --json, the pretty output is a table with one row per group.