ChatwootInstall

Summary

Retrieve a summary report of conversations within a specified date range, optionally grouped by a time period and filtered by various options like entity ID, timezone offset, business hours, and specific inboxes or labels.

Inputs

• Since (required) — Start date for the report
• Until (required) — End date for the report
• Options — Optional parameters to filter and group the report, including Entity ID, Group By Period (hour, day, week, month, year), Timezone Offset (seconds), Business Hours only filter, Days Before, Inbox IDs, Label IDs, and User ID

Output shape

a summary report object detailing conversations aggregated according to the specified parameters

The report data returned may vary based on the options provided; grouping by time periods influences the structure. The exact fields in the response follow the Chatwoot API's conversation summary schema and are returned as a JSON object.

Examples

Example 1: Retrieve conversation summary grouped by day from Jan 1, 2024 to Jan 31, 2024

Set 'Since' to 2024-01-01, 'Until' to 2024-01-31, and leave grouping as 'Day'.

Example 2: Get conversation summary for a specific Inbox filtered by business hours

Set 'Since' and 'Until' dates, set 'Business Hours' to true, and specify the Inbox IDs in 'Options'.

Links

• n8n community nodes installation guide