ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Reports → Get Account Conversation Metrics

AI-generated

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 engagement statistics.

Common scenarios include:

  • Monitoring the volume and quality of conversations handled by a support team.
  • Generating periodic reports on account activity for management review.
  • Integrating conversation metrics into dashboards or other analytics tools.

For example, a user might configure this node to get conversation metrics for their customer support account to track how many conversations were handled in a given period.

Properties

Name Meaning
Account Id The numeric ID of the account for which to retrieve conversation metrics.
Type Type of report to generate. Currently supports only "Account".

Output

The node outputs JSON data containing the conversation metrics for the specified account. This typically includes aggregated statistics such as counts of conversations, messages, or other relevant metrics provided by the ChatWoot API under the "account" report type.

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 depends on the @devlikeapro/n8n-openapi-node package for OpenAPI integration.

Troubleshooting

  • Invalid Account Id: If the account ID is incorrect or does not exist, 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 correctly set up and has sufficient permissions to access account reports.
  • Network Issues: Connectivity problems with the ChatWoot server will cause request failures. Check network settings and the availability of the ChatWoot instance.
  • Unsupported Report Type: Currently, only the "account" report type is supported. Using other types may result in errors.

Links and References

Discussion