Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
/
{conversation_id}
/
reporting_events
Conversation Reporting Events
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/reporting_events \
  --header 'api_access_token: <api-key>'
[
  {
    "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

conversation_id
integer
required

The numeric ID of the conversation

Response

Success

Array of reporting events for the conversation

id
number

ID of the reporting event

name
string

Name of the event (e.g., first_response, resolution, reply_time)

value
number

Value of the metric in seconds

value_in_business_hours
number

Value of the metric in seconds, calculated only for business hours

event_start_time
string<date-time>

The timestamp when the event started

event_end_time
string<date-time>

The timestamp when the event ended

account_id
number

ID of the account

conversation_id
number | null

ID of the conversation

inbox_id
number | null

ID of the inbox

user_id
number | null

ID of the user/agent

created_at
string<date-time>

The timestamp when the reporting event was created

updated_at
string<date-time>

The timestamp when the reporting event was last updated