getLoginActivity

Input parameters

Parameter	Type	Version	Required	Description
ServiceTypeID	string id	All	yes	The service type to query for activity: 1 - Chats 3 - Emails 5 - Tickets 9 - SMS/Text 10 - Twitter 15 - Async messaging
FromDate	date	All	no	Start date to query.
ToDate	date	All	no	End date to query.
PageStart	integer	v1	no	The number of elements to skip in the result set.
PageSize	integer	v1	no	The number of results in the returned set. This can be used to limit the returned set to less than the server maximum (this will not allow you to exceed the server page size, which is 1000 records in most cases.)

Return values

Parameter	Type	Version	Description
Truncated	boolean	All	Whether or not the above JSON array is the complete result set, or if the server limited the returned results.
Next	json object	v1	If the method called supports it, and the data is truncated, the Next parameter will contain the necessary parameters to pass back to the same server method to get more results.
OperatorID		All	Internal ID of the agent who was last assigned to a chat record.
UserName		All	Unique user name of a Bold360 user.
Name		All	Configuration label of the corresponding OperatorID.
ServiceTypeID		All	The channel that a Bold360 service is available for: 1 - Chats 3 - Emails 5 - Tickets 9 - SMS/Text 10 - Twitter 15 - Async messaging
StatusType		All	The status of a user's login: 0 - Offline 1 - Away 2 - Online Note: The `CustomOperatorStatusName` parameter contains custom agent statuses.
Created		All	Date and time when the Bold360 user's login event began.
Ended		All	Date and time for when the Bold360 user's login event stopped.
ServiceTypeID		All	The channel that a Bold360 service is available for: 1 - Chats 3 - Emails 5 - Tickets 9 - SMS/Text 10 - Twitter 15 - Async messaging
EndedBy		All	The ID of the Operator who ended the login event.
EndedReason		All	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
OriginalStatusType		All	The original StatusType of an Operator before it was changed.
CustomOperatorStatusID	long	All	The operator or agent system ID. Value is `null` if the Operator does not have a custom status.
CustomOperatorStatusName	string	All	Name of the agent's custom status. Value is `null` if the Operator does not have a custom status.

Additional information

Maximum page size: 3000 records

Sample code

{
    "Status": "success",
    "Truncated": true,
    "Data": [
        {
            "OperatorID": "5676748830204723022",
            "UserName": "ssmith@company.com",
            "Name": "Simpson Smith",
            "StatusType": 1,
            "Created": "2019-05-02T17:53:34.843Z",
            "Ended": null,
            "ServiceTypeID": "1",
            "EndedBy": null,
            "EndedReason": 0,
            "OriginalStatusType": 1,
            "CustomOperatorStatusID": null,
            "CustomOperatorStatusName": null
        }
    ]
}