ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation, List All Conversation Statistics under the Reports resource, retrieves aggregated conversation metrics from a ChatWoot account. It is useful for generating reports on conversation volumes, message counts, response times, and resolutions across different scopes such as accounts, agents, inboxes, labels, or teams.

Typical use cases include:

  • Monitoring overall conversation activity in an account.
  • Measuring agent performance by tracking conversations and response times.
  • Analyzing inbox or label-specific conversation statistics.
  • Generating time-bound reports to evaluate customer support efficiency.

For example, a support manager could use this node to fetch the average first response time for all conversations handled by a specific team during the last month.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account for which the report is generated.
Metric The type of metric to retrieve. Options: Conversations Count, Incoming Messages Count, Outgoing Messages Count, Avg First Response Time, Avg Resolution Time, Resolutions Count.
Type The scope/type of the report. Options: Account, Agent, Inbox, Label, Team.
Id The identifier of the specific object (agent, inbox, or label) when applicable.
Since The start timestamp (ISO 8601 string) from which to begin the report data collection.
Until The end timestamp (ISO 8601 string) until which to collect report data.

Output

The node outputs JSON data containing the requested conversation statistics based on the selected metric and scope. The structure typically includes aggregated counts or averages corresponding to the metric chosen, filtered by the provided parameters such as account, agent, or time range.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in credentials.
  • Depends on the ChatWoot REST API being accessible and responsive.

Troubleshooting

  • Invalid or missing Account Id: Ensure the numeric account ID is correct and corresponds to an existing ChatWoot account.
  • Incorrect metric or type values: Use only the supported options listed in the properties; invalid values may cause API errors.
  • Date format issues: The since and until timestamps should be valid ISO 8601 strings; otherwise, the API might reject the request.
  • Authentication failures: Verify that the API key credential is correctly set up and has sufficient permissions.
  • API connectivity problems: Check network access to the ChatWoot instance URL and ensure the service is operational.

Links and References

Discussion