Get Chat Engagement
Retrieve chat engagement metrics for a specified period and organization
GET
/
backend
/
reports
/
{orgId}
/
chats
/
engagement
This endpoint provides chat engagement metrics, including the total number of chats, the number of engaged chats, and the engagement rate.
Authentication
Authorization
string
requiredBearer token for authentication
Path Parameters
orgId
string
requiredThe ID of the organization to filter the results
Query Parameters
startDate
string
The start date for the report period (ISO 8601 format)
endDate
string
The end date for the report period (ISO 8601 format)
channel
string
The channel to filter the results (e.g., “web”, “mobile”)
status
number
The status of the chat sessions to include
Response
total_chats
number
The total number of chat sessions in the specified period
engaged_chats
number
The number of chat sessions where there was at least one message exchange
engagement_rate
number
The ratio of engaged chats to total chats, expressed as a decimal (0 to 1)
Was this page helpful?