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 operation fetches conversation statistics reports from a ChatWoot account. It allows users to retrieve various metrics related to conversations, messages, response times, and resolutions over a specified time range. This is useful for customer support teams or managers who want to analyze performance data such as the number of conversations handled, message volumes, average response times, and resolution counts.
Practical examples include:
- Getting the total number of conversations handled by an account or specific agents.
- Measuring average first response time to evaluate support efficiency.
- Tracking outgoing and incoming message counts to monitor communication volume.
- Generating reports filtered by inbox, label, or team to understand workload distribution.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account to query. |
| Metric | The type of metric to retrieve. Options: Conversations Count, Incoming Messages Count, Outgoing Messages Count, Avg First Response Time, Avg Resolution Time, Resolutions Count. |
| Type | The type of report to generate. Options: Account, Agent, Inbox, Label, Team. |
| Id | The ID of the specific object (agent, inbox, label, etc.) when applicable. |
| Since | The start timestamp (ISO 8601 string) from which to begin the report data. |
| Until | The end timestamp (ISO 8601 string) until which to collect report data. |
Output
The node outputs JSON data containing the requested conversation statistics based on the selected metric and filters. The structure typically includes aggregated values or lists of statistics corresponding to the chosen report type (account, agent, inbox, label, or team). The exact JSON schema depends on the API response but generally provides counts or averages for the specified metric.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in credentials.
- Depends on the ChatWoot REST API being accessible and the user having appropriate permissions to access reports.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and is correct.
- Metric or Type not supported: Verify that the metric and type values are among the allowed options.
- Date format errors: The
sinceanduntilfields should be valid ISO 8601 timestamps; invalid formats may cause request failures. - Authentication errors: Confirm that the API key credential is valid and has sufficient permissions.
- Empty results: If no data is returned, check if the date range covers periods with activity and that the IDs correspond to existing entities.
Links and References
- ChatWoot API Documentation
- ChatWoot Reports API Reference (for detailed parameter and response info)