Actions206
- Account Actions
- Agent Actions
- Agent Bot Actions
- Applied SLA (Enterprise) Actions
- Audit Log Actions
- Automation Rule Actions
- Campaign Actions
- Canned Response Actions
- Company (Enterprise) Actions
- Contact Actions
- Contact Note Actions
- Conversation Actions
- Conversation Participant Actions
- CSAT Survey Actions
- Custom Attribute Actions
- Custom Filter Actions
- Help Center Actions
- Inbox Actions
- Integration Actions
- Label Actions
- Live Report Actions
- Macro Actions
- Message Actions
- Notification Actions
- Profile Actions
- Report Actions
- Search Actions
- SLA Policy (Enterprise) Actions
- Summary Report Actions
- Team Actions
- Webhook Actions
- [Platform] Account Actions
- [Platform] Account Agent Bot Actions
- [Platform] Account User Actions
- [Platform] User Actions
- [Public] Contact Actions
- [Public] Conversation Actions
- [Public] Message Actions
Report → Conversation Statistics
AI-generatedSummary
Fetch conversation statistics report filtered by a specified time range, conversation type, and optional detailed filters such as entity ID, grouping period, timezone offset, business hours, and user ID.
Inputs
- Since (required) — Start date for the report in date-time format.
- Until (required) — End date for the report in date-time format.
- Type (required) — Conversation type to report on (e.g., agent, inbox, team, label).
- Options — Optional filters and parameters to refine the report, including Entity ID (number), Group By Period (hour, day, week, month, year), Timezone Offset (in seconds), Business Hours filter (boolean), Days Before (number), Inbox IDs, Label IDs (comma-separated strings), and User ID (number).
Output shape
A JSON object containing conversation statistical data grouped by the specified period and filtered by the provided parameters.
The output includes counts and metrics relevant to conversations matching the criteria. Grouping defaults to 'day' if not set. The report respects the specified timezone offset and can optionally filter data during business hours only. The data structure depends on the backend API response and may vary with the selected filters.