ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Reports → List All Conversation Statistics

AI-generated

Overview

This node interacts with the ChatWoot API to retrieve conversation statistics reports. Specifically, the "List All Conversation Statistics" operation under the "Reports" resource fetches aggregated metrics related to conversations within a specified account. This is useful for monitoring and analyzing customer support performance, such as tracking the number of conversations, message counts, response times, and resolutions over a given period.

Practical examples include:

  • Generating daily or weekly reports on how many conversations were handled by the support team.
  • Measuring average first response time to evaluate agent responsiveness.
  • Tracking resolution counts to assess issue closure rates.
  • Filtering reports by agents, inboxes, labels, or teams to get detailed insights.

Properties

Name Meaning
Account Id The numeric ID of the ChatWoot account for which the report is generated (required).
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 (required).
Type The category of report. Options: Account, Agent, Inbox, Label, Team (required).
Id The identifier of a specific object when filtering by agent, inbox, or label (optional).
Since Timestamp indicating the start date/time from which to generate the report (optional).
Until Timestamp indicating the end date/time until which to generate the report (optional).

Output

The node outputs JSON data containing the requested conversation statistics based on the selected metric and filters. The structure typically includes aggregated values corresponding to the metric chosen, such as counts or average times, grouped according to the report type (e.g., per agent or inbox).

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the ChatWoot API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the ChatWoot instance must be set in the credentials.

Troubleshooting

  • Invalid Account Id: Ensure the provided account ID exists and is accessible with the API key used.
  • Metric or Type Not Supported: Verify that the metric and type values are among the allowed options.
  • Date Format Issues: The since and until timestamps should be in a valid ISO 8601 format; otherwise, the API may reject the request.
  • Authentication Errors: Check that the API key credential is correctly configured and has sufficient permissions.
  • Empty Results: If no data is returned, confirm that the date range and filters actually correspond to existing conversation data.

Links and References

Discussion