Chatwoot icon

Chatwoot

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

Actions206

Report → Conversation Traffic

AI-generated

Summary

Retrieve conversation traffic report data within a specified date range, optionally grouping results by a time period and filtering by various parameters such as entity ID, timezone offset, business hours, inbox IDs, and labels.

Inputs

  • Since (required) — Start date for the report specifying the beginning of the time range to fetch conversation traffic data.
  • Until (required) — End date for the report specifying the end of the time range to fetch conversation traffic data.
  • Entity ID — Numeric ID of the agent, inbox, team, or label to filter the report results (when type is not account).
  • Group By Period — Time period to group the conversation traffic data by; options are hour, day, week, month, or year, with 'day' as default.
  • Timezone Offset — Timezone offset in seconds to adjust the reported times.
  • Business Hours — Boolean flag indicating whether to include data filtered to business hours only.
  • Days Before — Number of days to look back for conversation traffic; defaults to 6 if not specified.
  • Inbox IDs — Comma-separated list of inbox IDs to filter the report (applicable for inbox label matrix).
  • Label IDs — Comma-separated list of label IDs to filter the report (applicable for inbox label matrix).
  • User ID — User ID to filter data (applicable for conversation statistics).

Output shape

A JSON object containing the conversation traffic report data grouped and filtered according to the input parameters.

The report returns aggregated conversation traffic metrics for the given date range and filters. Grouping and other filters modify how data is summarized. Ensure 'Since' and 'Until' are specified to define the report period. Optional fields may refine the scope of the report.

Examples

Example 1: Gather conversation traffic grouped by day for the last 7 days in a specific timezone offset.

Set 'Since' and 'Until' dates to cover the last 7 days, choose 'day' as group by period, set the timezone offset, and optionally enable business hours filtering.

Links

Discussion