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 → Inbox Statistics
AI-generatedSummary
Retrieve inbox statistics report data within a specified date range, optionally grouped by a time period and filtered by various criteria such as entity ID, timezone offset, business hours, and specific inbox or label IDs.
Inputs
- since (required) — Start date for the report in dateTime format.
- until (required) — End date for the report in dateTime format.
- options — Optional parameters to refine the report including entity ID, grouping period (hour, day, week, month, year), timezone offset in seconds, business hours filter, days to look back, and comma-separated inbox or label IDs, as well as user ID for filtering.
Output shape
a single report data object containing inbox statistics for the specified filters and date range
The response contains aggregated statistics grouped by the chosen period (default is day). The data returned is scoped to the provided date range and optional filters. All input parameters must be valid; errors occur otherwise.
Examples
Example 1: Fetch inbox statistics report from Jan 1, 2023 to Jan 31, 2023 grouped by day with business hours filter.
since: 2023-01-01T00:00:00Z, until: 2023-01-31T23:59:59Z, options: { group_by: 'day', business_hours: true }