Chatwoot icon

Chatwoot

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

Actions206

Report → Bot Summary

AI-generated

Summary

Retrieve a summary report of chatbot performance for a specified entity and time range.

Inputs

  • Since (required) — Start date for the report.
  • Until (required) — End date for the report.
  • Type (required) — Entity type for the report (Account, Agent, Inbox, Label, or Team).
  • Entity ID — ID of the agent, inbox, team, or label when Type is not 'account'.
  • Group By Period — Time period grouping for results (Hour, Day, Week, Month, or Year). Defaults to day.
  • Timezone Offset — Timezone offset in seconds to apply to the report.
  • Business Hours — Filter the report data to business hours only.

Output shape

a JSON object containing statistics summarizing chatbot activity and metrics over the specified time range, grouped by the specified period and entity type

The report covers the chosen entity type and respects filters like business hours and timezone offset. Entity ID is required when the type is specific (e.g., agent, inbox). The output structure corresponds to the Chatwoot API's chatbot summary report format.

Links

Discussion