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 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 a summary report of all conversations handled by a particular agent over the last month.
- A business analyst needs to see conversation trends for a specific inbox during a campaign period.
- A team lead wants to compare conversation volumes across different teams.
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 | Timestamp marking the start date/time for the report data range (optional). |
| Until | Timestamp marking the end date/time for the report data range (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 metrics such as counts of conversations, messages, response times, and other relevant statistics grouped by the chosen entity (account, agent, inbox, label, or team).
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 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' timestamps should be in a valid ISO 8601 format or as expected by the API to avoid request failures.
- Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
- API rate limits or connectivity problems: Network issues or hitting API rate limits can cause errors; check connectivity and consider retry logic if needed.
Links and References
- ChatWoot API Documentation
- ChatWoot Reports API Reference (for detailed parameters and response schema)