ChatWootInstall

Overview

This node interacts with the ChatWoot API to retrieve conversation metrics for a specific account. It is designed to fetch detailed reports about conversations associated with an account, which can be useful for analyzing customer support performance or monitoring communication trends.

Common scenarios include:

• Generating reports on how many conversations an account has handled.
• Monitoring conversation metrics over time for performance analysis.
• Integrating conversation data into dashboards or other analytics tools.

For example, a user might use this node to get the total number of conversations handled by their support team in a given account to evaluate workload and response efficiency.

Properties

Output

The node outputs JSON data containing the conversation metrics for the specified account. The exact structure depends on the ChatWoot API response but typically includes counts and statistics related to conversations such as total conversations, open conversations, resolved conversations, etc.

No binary data output is indicated.

Dependencies

• Requires an API key credential for authenticating with the ChatWoot API.
• The base URL for the ChatWoot instance must be configured in the node credentials.
• The node uses the ChatWoot REST API endpoint for fetching reports.

Troubleshooting

• Invalid Account Id: If the provided account ID does not exist or is incorrect, the API may return an error or empty results. Verify the account ID before running the node.
• Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions to access reports.
• Network Issues: Connectivity problems with the ChatWoot server will cause request failures. Check network settings and API endpoint availability.
• Unsupported Report Type: Currently, only the "Account" type is supported. Using other types may result in errors.

Links and References

• ChatWoot API Documentation - Official API docs for reference on available endpoints and data structures.