Chatwoot icon

Chatwoot

Interact with Chatwoot API to manage conversations, messages, contacts, and more

Actions206

Summary Report → Channel Summary

AI-generated

Summary

Fetches a channel summary report from Chatwoot for the specified date range, optionally filtered to only include business hours.

Inputs

  • Since (required) — The start date and time from which to begin the summary report.
  • Until (required) — The end date and time until which to generate the summary report.
  • Options.business_hours — Boolean flag to restrict the summary to business hours only.

Output shape

A JSON object containing the summary report data for channels within the specified date range.

The operation requires 'Since' and 'Until' inputs and will return data scoped within that interval. The 'business_hours' option is optional and defaults to false if not provided.

Examples

Example 1: Retrieve a channel summary for last week including all hours

Set 'Since' to the start of last week and 'Until' to the end of last week. Leave 'Business Hours' unset or false.

Example 2: Retrieve a channel summary for yesterday restricted to business hours

Set 'Since' and 'Until' to cover yesterday's date and set 'Business Hours' to true.

Links

Discussion