GET
/
api
/
v2
/
accounts
/
{account_id}
/
reports
curl --request GET \
  --url https://app.chatwoot.com/api/v2/accounts/{account_id}/reports \
  --header 'api_access_token: <api-key>'
[
  {
    "value": "<string>",
    "timestamp": 123
  }
]

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

​
metric
enum<string>
required

The type of metric

Available options:
conversations_count,
incoming_messages_count,
outgoing_messages_count,
avg_first_response_time,
avg_resolution_time,
resolutions_count
​
type
enum<string>
required

Type of report

Available options:
account,
agent,
inbox,
label,
team
​
id
string

The Id of specific object in case of agent/inbox/label

​
since
string

The timestamp from where report should start.

​
until
string

The timestamp from where report should stop.

Response

200
application/json

Success

Array of date based conversation statistics