getLoginActivity

Input parameters

Parameter	Type	Required	Description
ServiceTypeID	numeric - ID code	Yes	The service type to query for activity: 1 - Chats 3 - Emails 5 - Tickets 9 - SMS/Text 10 - Twitter 15 - Async messaging
FromDate	date - ISO / UTC	No	Start date to query.
ToDate	date - ISO / UTC	No	End date to query.
NextPage	string	No	Tells the server the next page of data to retrieve. This parameter should be the same value as what was returned in the response field "NextPage" by the previous call.

Request format

curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getLoginActivity?auth=$authHash&ServiceTypeID=$ServiceTypeID"

Return values

Parameters are provided in alphabetic order. See Sample code for probable output.

Parameter	Type	Description
Created	date - ISO / UTC	Date and time when the Bold360 user's login event began.
CustomOperatorStatusID	long	The operator or agent system ID. Value is `null` if the Operator does not have a custom status.
CustomOperatorStatusName	string	Name of the agent's custom status. Value is `null` if the Operator does not have a custom status.
Ended	date - ISO / UTC	Date and time for when the Bold360 user's login event stopped.
EndedBy	numeric - ID code	The ID of the Operator who ended the login event.
EndedReason	byte	The reason code for why the login event was ended: 0 - ENDED_REASON_NONE 1 - ENDED_REASON_SIGNED_OFF 2 - ENDED_REASON_NEW_CLIENT 3 - ENDED_REASON_SAME_OPERATOR 4 - ENDED_REASON_CLIENT_CLOSED 5 - ENDED_REASON_SERVER_RESTARTED 6 - ENDED_REASON_SIGNON_LIMIT 7 - ENDED_REASON_SIGNOFF_REQUESTED 8 - ENDED_REASON_SAME_CLIENT 9 - ENDED_REASON_DISABLED 10 - ENDED_REASON_FORCED 11 - ENDED_REASON_STATUS
Name	string	Configuration label of the corresponding OperatorID.
Next	json object	DEPRECATED
OperatorID	numeric - ID code	The Operator or agent system ID.
OriginalStatusType	integer	The original StatusType of an Operator before it was changed.
ServiceTypeID	integer	The channel that a Bold360 service is available for: 1 - Chats 3 - Emails 5 - Tickets 9 - SMS/Text 10 - Twitter 15 - Async messaging
StatusType	integer	The status of a user's login: 0 - Offline 1 - Away 2 - Online Note: The `CustomOperatorStatusName` parameter contains custom agent statuses.
Truncated	Boolean	Whether or not the above JSON array is the complete result set, or if the server limited the returned results.
UserName	string	Operator's user name.

Sample code

{	
 "Status": "success",
    "Truncated": true,
    "Next":{"PageSize":20,"PageStart":1,"ToDate":"2021-01-09T03:51:45.000Z"},
    "Data": [
        {
	"OperatorID":"1950049884361"
	"UserName":"Ken"
	"Name":"Ken Drake"
 	"StatusType":2
	"Created":"2020-10-10T18:54:54.573Z",
	"Ended":"2020-12-12T19:02:08.657Z",
	"ServiceTypeID":1
	"EndedBy":"1950049884361"
	"EndedReason":4
	"OriginalStatusType":9,
       "CustomOperatorStatusID": null,
       "CustomOperatorStatusName": null
        }
    ]
}