Actions113
- 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
- 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
- Webhooks Actions
- Teams Actions
- Custom Filters Actions
- Reports Actions
Overview
This node interacts with the ChatWoot API to retrieve summarized conversation statistics reports. Specifically, the "List All Conversation Statistics Summary" operation under the "Reports" resource fetches aggregated data about conversations filtered by different entity types such as account, agent, inbox, label, or team.
Use cases include:
- Monitoring overall conversation metrics for an entire account.
- Analyzing performance and workload of individual agents.
- Reviewing statistics for specific inboxes or labels to understand traffic distribution.
- Evaluating team-based conversation handling efficiency.
Practical examples:
- A support manager wants to see how many conversations each agent handled last month.
- A business analyst needs a summary report of conversations tagged with a particular label during a campaign.
- An admin wants to track conversation volume trends across different inboxes over a custom date range.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the ChatWoot account for which the report is generated (required). |
| Type | The type of report to generate. Options: Account, Agent, Inbox, Label, Team (required). |
| Id | The identifier of the specific object when the type is agent, inbox, or label (optional). |
| Since | The start timestamp (ISO string) from which to begin the report data (optional). |
| Until | The end timestamp (ISO string) until which to collect report data (optional). |
Output
The node outputs JSON data containing the summarized conversation statistics according to the selected report type and filters. The structure typically includes aggregated counts and metrics relevant to conversations, such as total conversations, resolved conversations, response times, etc., grouped by the chosen entity (account, agent, inbox, label, or team).
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- The base URL of the ChatWoot instance must be configured in the credentials.
- The node uses the ChatWoot REST API endpoints to fetch report data.
Troubleshooting
- Missing or invalid Account Id: Ensure the Account Id is correctly provided and corresponds to an existing ChatWoot account.
- Invalid Type or Id combination: When selecting types like agent, inbox, or label, the corresponding Id must be valid; otherwise, the API may return errors or empty results.
- Date format issues: The 'Since' and 'Until' properties should be valid ISO 8601 timestamps. Incorrect formats may cause the API to reject the request.
- Authentication errors: Verify that the API key credential is correct and has sufficient permissions to access reports.
- API connectivity problems: Check network connectivity and the correctness of the ChatWoot base URL in credentials.
Links and References
- ChatWoot API Documentation
- ChatWoot Reports API Reference (for detailed report parameters and response schema)