Actions113
- 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
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response 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 periodic reports on agent performance for team meetings.
- Integrating agent metrics into dashboards 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 the user (agent) whose conversation metrics are requested. |
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, and other relevant statistics per agent. The exact fields depend on the API response but generally provide comprehensive metrics about agent interactions.
No binary data output is indicated for 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.
- The node uses standard HTTP headers for JSON communication.
Troubleshooting
- Missing or invalid Account Id: Ensure 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 report may return empty or error.
- 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 ChatWoot API changes, the node might fail; verify compatibility with the current API version.