ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

This node operation "List All Conversation Statistics" under the "Reports" resource fetches aggregated conversation metrics from a ChatWoot account. It is designed to retrieve various statistics such as counts of conversations, incoming/outgoing messages, average response times, and resolution counts. This is useful for customer support teams or managers who want to analyze performance data across different scopes like accounts, agents, inboxes, labels, or teams.

Practical examples include:

  • Getting the total number of conversations handled by an agent within a specific time frame.
  • Measuring average first response time for a team to evaluate responsiveness.
  • Tracking resolutions count for a particular inbox to assess effectiveness.

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 scope/type of the report. Options: Account, Agent, Inbox, Label, Team (required).
Id The identifier of the specific object when the type is agent, inbox, or label (optional).
Since Timestamp indicating the start date/time for the report data (optional).
Until Timestamp indicating the end date/time for the report data (optional).

Output

The node outputs JSON data containing the requested conversation statistics based on the selected metric and scope. The structure typically includes fields representing the metric values aggregated over the specified period and filtered by the chosen type and id if applicable.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the ChatWoot API.
  • Needs the base URL of the ChatWoot instance configured in credentials.
  • Relies on the ChatWoot REST API endpoints for fetching reports.

Troubleshooting

  • Missing or invalid Account Id: Ensure the account ID is correct and exists in ChatWoot.
  • Invalid metric or type selection: Choose valid options from the provided lists.
  • Date format errors: Use proper timestamp formats for 'Since' and 'Until' fields.
  • Authentication failures: Verify that the API key and base URL are correctly set in credentials.
  • Empty results: Check if the date range or filters actually contain data; try expanding the time window.

Links and References

Discussion