Actions113
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
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:
- Fetching conversation metrics for a specific agent to evaluate their workload or response times.
- Generating aggregated reports on agent activities for a given account to monitor team performance.
- Integrating these metrics into dashboards or automated workflows for real-time monitoring.
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 option. |
| User Id | (Optional) The numeric ID of a specific user/agent to filter the report by that user. |
Output
The node outputs JSON data containing the agent conversation metrics retrieved from the ChatWoot API. The structure typically includes details such as conversation counts, response times, agent identifiers, and other relevant statistics depending on the API's response schema.
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 depends on the
@devlikeapro/n8n-openapi-nodepackage for OpenAPI integration.
Troubleshooting
- Missing or invalid Account Id: Ensure the Account Id is provided and is a valid number; otherwise, the API call will fail.
- Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
- Invalid User Id format: If provided, User Id should be a string representing a numeric ID; incorrect formats may cause request failures.
- Network or API errors: Check connectivity to the ChatWoot instance and ensure the base URL is correct.
- Unsupported Type value: Only "Agent" is supported for the Type property; using other values will likely result in errors.