Skip to main content
GET
/
api
/
v2
/
accounts
/
{account_id}
/
summary_reports
/
channel
Get conversation statistics grouped by channel type
curl --request GET \
  --url https://app.chatwoot.com/api/v2/accounts/{account_id}/summary_reports/channel \
  --header 'api_access_token: <api-key>'
{
  "Channel::WebWidget": {
    "open": 10,
    "resolved": 20,
    "pending": 5,
    "snoozed": 2,
    "total": 37
  },
  "Channel::Api": {
    "open": 5,
    "resolved": 15,
    "pending": 3,
    "snoozed": 1,
    "total": 24
  }
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

Query Parameters

​
since
string

The timestamp from where report should start (Unix timestamp).

​
until
string

The timestamp from where report should stop (Unix timestamp).

​
business_hours
boolean

Whether to filter by business hours.

Response

Success

Channel summary report containing conversation counts grouped by channel type and status. Available in version 4.10.0+.

​
{key}
object

Conversation statistics for a specific channel type (e.g., Channel::WebWidget, Channel::Api)