Sign in
admin

Get Agent Sessions

Get all agent sessions, with optional filtering and pagination. Only accessible by admin users.

get/admin/agent-sessions

Query parameters

statusstring nullable

Filter by session status (active, completed, failed)

Filter by session status (active, completed, failed)

agent_typestring nullable

Filter by agent type

Filter by agent type

skipinteger

Number of records to skip

Number of records to skip

limitinteger

Maximum number of records to return

Maximum number of records to return

sort_by'start_time' | 'end_time'

Field to sort by

Field to sort by

sort_order'asc' | 'desc'

Sort order

Sort order

start_datestring nullable

Filter sessions starting from this date (ISO format)

Filter sessions starting from this date (ISO format)

end_datestring nullable

Filter sessions until this date (ISO format)

Filter sessions until this date (ISO format)

Response

Successful Response

idstring required
user_idstring required
user_emailstring nullable
room_namestring required
start_timestring date-time required
end_timestring date-time nullable
statusstring required
agent_typestring nullable
session_idstring nullable
agent_dataobject nullable
transcriptobject nullable

Changes

No recorded changes to this endpoint across all 2 revisions of this API.