ChatwootInstall

Summary

Retrieve a summary report of chatwoot account activities aggregated by specified entity type over a defined date range.

Inputs

• Since - Start date for the report (required) (required) — Start date defining the beginning of the report period, provided as a date-time value.
• Until - End date for the report (required) (required) — End date defining the end of the report period, provided as a date-time value.
• Type - Entity type for the report (required) (required) — The entity category to summarize: 'account', 'agent', 'inbox', 'label', or 'team'.
• Options (optional) — Additional filtering and grouping options including: Entity ID (numeric ID of agent, inbox, team, or label when type is not account), Group By Period (hour/day/week/month/year), Timezone Offset (in seconds), Business Hours only filter (boolean), Days Before (look-back days for conversation traffic), Inbox IDs (comma-separated string, for inbox label matrix), Label IDs (comma-separated string, for inbox label matrix), and User ID (numeric filter for user in conversation statistics).

Output shape

a single JSON object representing the account summary report data.

The returned data contains aggregated metrics corresponding to the specified entity type and period. The exact structure varies by report type and grouping options. Errors or empty data are returned according to API conventions. Pagination is not applicable to this summary report endpoint.

Examples

Example 1: Get overall account summary from January 1 to January 31, grouped daily.

Set 'Since' to 2024-01-01, 'Until' to 2024-01-31, 'Type' to 'account', 'Group By Period' to 'day'.

Links

• n8n community nodes installation guide