Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
reporting_events
Account Reporting Events
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/reporting_events \
  --header 'api_access_token: <api-key>'
{
  "meta": {
    "count": 123,
    "current_page": 123,
    "total_pages": 123
  },
  "payload": [
    {
      "id": 123,
      "name": "<string>",
      "value": 123,
      "value_in_business_hours": 123,
      "event_start_time": "2023-11-07T05:31:56Z",
      "event_end_time": "2023-11-07T05:31:56Z",
      "account_id": 123,
      "conversation_id": 123,
      "inbox_id": 123,
      "user_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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

​
page
integer
default:1

The page parameter

​
since
string

The timestamp from where events should start (Unix timestamp in seconds)

​
until
string

The timestamp from where events should stop (Unix timestamp in seconds)

​
inbox_id
number

Filter events by inbox ID

​
user_id
number

Filter events by user/agent ID

​
name
string

Filter events by event name (e.g., first_response, resolution, reply_time)

Response

Success

​
meta
object
​
payload
object[]

List of reporting events