ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node interacts with the ChatWoot API to retrieve summarized conversation statistics reports. Specifically, the "List All Conversation Statistics Summary" operation under the "Reports" resource fetches aggregated data about conversations filtered by different entity types such as account, agent, inbox, label, or team. This is useful for gaining insights into conversation volumes and performance metrics over a specified time range.

Common scenarios include:

  • Monitoring overall account-level conversation activity.
  • Analyzing individual agent performance.
  • Reviewing inbox-specific conversation summaries.
  • Evaluating labels or teams to understand workload distribution.

Practical example: A customer support manager could use this node to generate weekly reports on how many conversations each agent handled, helping to identify high performers or those needing assistance.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account for which the report is generated (required).
Type The type of report to generate. Options: Account, Agent, Inbox, Label, Team (required).
Id The identifier of the specific object when the type is agent, inbox, or label (optional).
Since The start timestamp (ISO 8601 string) from which to begin the report data (optional).
Until The end timestamp (ISO 8601 string) until which to collect report data (optional).

Output

The node outputs JSON data containing the summarized conversation statistics according to the selected type and filters. The structure typically includes aggregated counts and metrics relevant to conversations, such as total conversations, resolved conversations, response times, etc., grouped by the chosen entity (account, agent, inbox, label, or team).

No binary data output is produced by this node.

Dependencies

  • Requires an active ChatWoot account and API access.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL for the ChatWoot instance must be set in the credentials.
  • Relies on the ChatWoot REST API endpoint for fetching conversation statistics summary reports.

Troubleshooting

  • Missing or invalid Account Id: Ensure the Account Id is correctly provided and corresponds to an existing ChatWoot account.
  • Invalid Type or Id combination: When selecting types like agent, inbox, or label, the corresponding Id must be valid; otherwise, the API may return errors or empty results.
  • Date format issues: The 'Since' and 'Until' properties should be valid ISO 8601 timestamps; incorrect formats can cause request failures.
  • Authentication errors: Verify that the API key/token is correctly configured and has sufficient permissions.
  • API rate limits or downtime: If requests fail repeatedly, check ChatWoot service status and consider implementing retry logic.

Links and References

Discussion