Chatwoot icon

Chatwoot

Interact with Chatwoot API to manage conversations, messages, contacts, and more

Actions206

Report → Agent Statistics

AI-generated

Summary

Retrieve agent statistics report for a specified date range, with optional filtering and grouping.

Inputs

  • Since (required) — The start date for the agent statistics report.
  • Until (required) — The end date for the agent statistics report.
  • Options — Additional optional parameters to refine the report, including Entity ID (agent/inbox/team/label), grouping period (hour/day/week/month/year), timezone offset in seconds, filter by business hours, days before for conversation traffic context, comma-separated inbox IDs, comma-separated label IDs, and user ID to filter by user.

Output shape

a single JSON object containing the agent statistics report data from Chatwoot for the given parameters.

The report data includes aggregated statistics about agents within the specified time range and grouping. Optional fields enable filtering by specific agents or related entities. No pagination is involved; the response is a complete report for the query.

Examples

Example 1: Get daily agent statistics for all agents from 2023-01-01 to 2023-01-07.

Since = 2023-01-01, Until = 2023-01-07, optionally set Group By Period = 'day' (default).

Example 2: Get hourly statistics for a specific agent ID with timezone offset and business hours filtering.

Since and Until set, Options include id = agent's numeric ID, group_by = 'hour', timezone_offset = offset in seconds, business_hours = true.

Links

Discussion