Chatwoot icon

Chatwoot

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

Actions206

Report → Timeseries

AI-generated

Summary

Retrieve a time series report from Chatwoot for a specified entity type and metric within a defined date range.

Inputs

  • Since (required) — Start date for the report, specified as a date-time.
  • Until (required) — End date for the report, specified as a date-time.
  • Type (required) — Entity type to report on; options include Account, Agent, Inbox, Label, or Team.
  • Metric (required) — The metric to retrieve in the time series; options include conversations count, incoming/outgoing messages count, average first response time, average resolution time, or resolutions count.
  • Options — Additional filters and grouping options including Entity ID (required for all entity types except Account), Group By period (hour, day, week, month, year), Timezone offset in seconds, whether to limit to business hours, and other entity-specific filters.

Output shape

a single object containing the requested time series metric data grouped by the specified time period and filtered according to the given parameters.

The data returned corresponds to the metric over the specified date range and grouping. The Entity ID option is required when Type is not Account to specify the exact agent, inbox, team, or label. Optional filters adjust the granularity and scope of the data. Errors in inputs like missing required fields may result in request failure.

Links

Discussion