ChatWootInstall

Overview

This 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 performance data related to agents' conversations within a specified account. This is useful for customer support teams or managers who want to analyze agent activity, measure efficiency, or generate performance reports.

Practical examples include:

• Retrieving conversation statistics for a specific agent to evaluate their workload.
• Generating periodic reports on agent interactions for quality assurance.
• Integrating agent metrics into dashboards or analytics tools.

Properties

Output

The node outputs JSON data containing the agent conversation metrics as returned by the ChatWoot API. This typically includes statistical information about conversations handled by agents, such as counts, durations, or other relevant metrics.

No binary data output is indicated for this operation.

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 corresponding to reports.

Troubleshooting

• Missing or invalid Account Id: Ensure that the Account Id is provided and is a valid number; otherwise, the API call will fail.
• Invalid User Id: If provided, the User Id should correspond to an existing user; otherwise, the response may be empty or error out.
• Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
• Network or API errors: Check connectivity to the ChatWoot instance and ensure the base URL is correct.
• Unsupported Type value: Currently, only "Agent" is supported; using other values will likely cause errors.

Links and References

• ChatWoot API Documentation
• ChatWoot Reports API Reference