Bold360 and BoldChat Developer Center

getAllAccessAuditLogs

Returns login and logout events. Can be refined by specifying start and end dates, operator, events, etc.

Input parameters

Parameter Type Required Description
FromDate date - ISO/UTC

No

Start date. Must be used with ToDate parameter.
ToDate date - ISO/UTC

No

End date. Must be used with FromDate parameter.

NextPage

string

No

Tells server the next page of data to retrieve. Should be the same value as what was returned in the response field "NextPage" by the previous call.

PageSize integer

No

Number of results returned per page. Default page size is 1000.
PageStart integer

No

The first page that should be displayed in the returned results. For example, to skip the first 1000 results, leave PageSize as default and define 2 for PageStart.
LoginID numeric - ID code

No

User identifier in Bold360.
UserKey string

No

User identifier in LogMeIn's common sign-in platform.
UserKeyNull Boolean

No

Includes those users in the results that do not exist in LogMeIn's common sign-in platform., and therefore the UserKey parameter is empty.
IPAddress string - legal URL

No

The IP address where the user logged in.
Action codes - set values

No

Type of action performed:
  • LOGIN
  • LOGOUT
Client string

No

Type of Bold client (such as Agent Workspace, Admin Center, or Reports) where the user logged in or logged out.

Request format

curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getAllAuditLogs?auth=$authHash&FromDate=2020-01-01T00:00:00Z,ToDate=2020-12-31T11:59:59Z"

Return values

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

Parameter Type Description
AccessKey string Keyboard shortcut that inserts a canned message into an active chat.
Action codes - set values Displays whether the user logged in or out. Possible values are:
  • LOGIN
  • LOGOUT
Client string Name of the Bold360 client - phone call, mobile, web, offline, etc. (see ClientType) - where the user performed the action.
Data text - heading JSON array heading that precedes report data output.
IPAddress string - legal URL IP address of the Bold user who performed the action.
LoginID numeric - ID code Operator's Bold360 login ID.
Status codes - set values "Success" when the call completes; "Error" when the call fails.
Time date - ISO / UTC Date and time of the login or logout action.
Truncated Boolean TRUE if results were shortened to fit the report, FALSE if full results for the report criteria were returned. If TRUE, you can filter down the results set or contact us to try to find a way to get at the data you are looking for.
UserKey numeric - ID code User identifier in LogMeIn's common sign-in platform.

Sample code

{
  "Status": "success",
  "Data": [
    {
      "accountId": "123456789",
      "loginId": "1234635815563272707",
      "userKey": "4321230154765081609",
      "time": "2020-04-07T11:50:11",
      "ipAddress": "172.21.10.1",
      "action": "LOGIN",
      "client": "Web"
    },
    {
      "accountId": "123456789",
      "loginId": "1234635815563272707",
      "userKey": "4321230154765081609",
      "time": "2020-04-07T11:52:10",
      "ipAddress": "172.21.10.1",
      "action": "LOGOUT",
      "client": "Web"
    }
  ],
  "Truncated": false
}