Chatwoot icon

Chatwoot

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

Actions206

Report → Outgoing Messages Count

AI-generated

Summary

Retrieve the count of outgoing messages within a specified date range, optionally grouped by agent, inbox, label, or team, and further classified by a time period such as hour, day, week, month, or year.

Inputs

  • Since (required) — Start date for the report period, specified as a date-time value.
  • Until (required) — End date for the report period, specified as a date-time value.
  • Group By (required) — Entity by which the outgoing message counts will be grouped. Valid options are Agent, Inbox, Label, or Team.
  • Entity ID — Optional ID to filter the report by a specific agent, inbox, team, or label.
  • Group By Period — Time interval to group the data by. Options include Hour, Day, Week, Month, or Year. Defaults to Day.
  • Timezone Offset — Timezone offset in seconds to adjust the report timestamps.
  • Business Hours — Boolean flag to filter the report to include messages sent only during business hours.

Output shape

a JSON object containing counts of outgoing messages aggregated by the chosen entity and time period within the specified date range.

The output includes the counts grouped according to the specified 'Group By' entity and within the specified time period if provided. Filtering by specific entity ID or business hours modifies the scope of data returned.

Examples

Example 1: Count outgoing messages by agent within a specified week, grouped daily.

Set 'Since' and 'Until' to define the week, select 'Group By' as 'Agent', and set 'Group By Period' to 'Day'.

Links

Discussion