Connection logs are created when the connection status of agents is changed. You can list connection logs of all agents or view a specific log with its ID.
Resource representation
The following table shows the list of properties in a connection logs resource.
Property name
Type
Description
id
int
The unique ID of the connection log.
agent
int
The ID of the agent who owns the connection log.
prevStatus
string
The previous connection status of the agent. Valid values are ONLINE, OFFLINE, and AWAY.
currentStatus
string
The current connection status of the agent. Valid values are ONLINE, OFFLINE, and AWAY.
durationTime
string
The time that indicates how long the current connection status has been maintained.
createdAt
string
The date and time when the connection status was changed, in ISO 8601 format.
createdBy
int
The subject who changed the connection status.
fromConnection
string
The previous connection status of the agent. Valid values are ONLINE, OFFLINE, and AWAY.
* This property will be deprecated soon. Use prevStatus instead.
toConnection
string
The changed connection status of the agent. Valid values are ONLINE, OFFLINE, and AWAY.
* This property will be deprecated soon. Use currentStatus instead.
Actions
API endpoints are relative to the base URL allocated to your application. In this page, the /agent_connection_logs endpoint refers to https://desk-api-{application_id}.sendbird.com/platform/v1/agent_connection_logs.
Note: If you want to know your application ID, sign in to your dashboard, go to the Settings > Application > General, and then check the Application ID.
It's recommended that the parameter values in API URLs be urlencoded, such as {agent_id}.