ChatWootInstall

Overview

The node interacts with the ChatWoot API to retrieve agent conversation metrics reports. Specifically, for the "Reports" resource and the "Get Agent Conversation Metrics" operation, it fetches detailed metrics related to agents' conversations within a specified account. This is useful for customer support teams or managers who want to analyze agent performance, track conversation statistics, and generate reports on user interactions.

Practical examples include:

• Fetching conversation metrics for a specific agent to evaluate their workload or efficiency.
• Generating periodic reports on agent activity for performance reviews.
• Integrating conversation metrics into dashboards for real-time monitoring.

Properties

Output

The node outputs JSON data containing the agent conversation metrics retrieved from the ChatWoot API. The structure typically includes various statistics and details about conversations handled by agents, such as counts, durations, statuses, and other relevant metrics.

If binary data were involved, it would represent attachments or files related to the conversations, but in this case, the output is purely JSON-based metric data.

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 provided in the credentials.
• The node uses the @devlikeapro/n8n-openapi-node package internally to handle OpenAPI-based requests.

Troubleshooting

• Missing or invalid Account Id: Ensure that the Account Id is correctly set and corresponds to an existing account in ChatWoot.
• Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions to access reports.
• Empty or incomplete data: If no metrics are returned, check if the User Id filter is too restrictive or if there are no conversations matching the criteria.
• Network issues: Confirm that the ChatWoot instance URL is reachable from n8n and that there are no firewall restrictions.

Common error messages might include unauthorized access, resource not found, or bad request due to missing parameters. Resolving these usually involves checking credentials, input parameters, and network connectivity.

Links and References

• ChatWoot API Documentation
• n8n OpenAPI Node Integration Guide
• ChatWoot Official Website