ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Overview

The "Get Agent Conversation Metrics" operation in the Reports resource fetches metrics related to agent conversations from the ChatWoot API. This node is useful for analyzing agent performance, monitoring conversation statistics, and generating reports on user interactions within a customer support or chat environment.

Typical use cases include:

  • Retrieving conversation metrics for specific agents to evaluate their activity.
  • Generating periodic reports on agent engagement.
  • Integrating conversation data into dashboards or analytics tools.

Properties

Name Meaning
Account Id The numeric ID of the account for which the report is requested.
Type The type of report to retrieve. For this operation, only "Agent" is available as an option.
User Id (Optional) The numeric ID of the user (agent) whose conversation metrics are being fetched.

Output

The node outputs JSON data containing the agent conversation metrics retrieved from the ChatWoot API. The exact structure depends on the API response but typically includes statistical data about conversations handled by the specified agent(s), such as counts, durations, or other relevant metrics.

No binary data output is expected from this operation.

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

  • Missing or invalid Account Id: Ensure that the Account Id is provided and is a valid number; otherwise, the API request 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/token is correctly configured and has sufficient permissions.
  • Network issues: Check connectivity to the ChatWoot server and ensure the base URL is correct.
  • API changes: If the API schema changes, the node might not return expected data; verify with the latest ChatWoot API documentation.

Links and References

Discussion