BoldChat by LogMeIn - Help Center

BoldChat Data Extraction API

The Data Extraction JSON REST API provides a web service for retrieving customer data from your account.

Tip: Learn more about how to use the API with cURL examples.
Note: For the full list of available data fields, see API Data Fields.

Compatible Subscriptions

Access to BoldChat's API is included in the Enterprise subscription.

Important: API access is assigned to your account identifier (AID) that you can find in all HTML snippets under setAccountID.

Configuration

Learn about configuring the BoldChat Integration API under API Configuration.

Response

All methods return a JSON object with a structure depending on the method.

Important: We do not guarantee that the order of returned fields will be static. When designing your solution, it is best not to rely on the positions of values.
Tip: Test the output of each method listed below on our interactive page.

Chat API Methods

updateChat

Used to update a chat record with the given information.

Param Type Required Description

ChatID

string id

yes

The chat identifier of the record to update

<API field name>

string

no

The listed API field names can be updated on the chat record with the given value.

Supported Fields:

The listed API field names can be updated on the chat record with the given value.

Supported Fields:

  • UserStatusID
  • UserCategoryID
  • CustomField1ID
  • CustomField2ID
  • VisitRef
  • VisitInfo
  • VisitEmailAddress
  • VisitPhone
  • ChatName
  • LastName
  • InitialQuestion
  • ChatUrl
  • CustomUrl
  • CountryCode
  • RegionCode
  • City
  • ScheduleHistoryToEmailAddress
  • CustomFields.<name>
  • OperatorCustomFields.<name>

OperatorCustomFields.<name>

string

no

The operator custom field value to set.

Returns: Nothing

assignChat

Used to assign a chat to a particular department or operator. Answered chats can be reassigned only when 'Forced=true' parameter and value are set.

If 'AssignedByOperatorID' is not set the API will work differently than the clients if the ACD is on. In the case of assigning chat to an offline operator the ACD system will pick up the chat and assigns it to an available one.

If 'AssignedByOperatorID' is set then the API works like the clients. After assigning chat to an offline operator the ACD system won't reassign the chat.

It's recommended to create a technical 'api' operator and use the 'AssignedByOperatorID' parameter with the id of that operator.

Param Type Required Description

ChatID

string id

yes

The chat identifier of the record to update

DepartmentID

string id

no

The department to assign the chat to

OperatorID

string id

no

The operator to assign the chat to

AssignedByOperatorID

string id

no

The operator who assigns the chat

FolderID

string id

no

The folder to assign the chat to

Forced

boolean

no

If true then even answered chats can be reassigned

Returns: Nothing

addChatMessage

Used to add a chat message to a chat

Param Type Required Description

ChatID

string id

yes

The chat identifier of the record to update

Type

string

no

The person type for the message. Values include:
  • operator
  • visitor
  • system

Name

string

no

The name to associate with this message

Message

string

no

The text of this message

ChatMessageID

string id

no

The unique identifier to store this message as

OperatorID

string id

yes (if operator Type)

The unique identifier of the operator sending the message

Returns: Nothing

addChatIncident

Used to add an incident to a chat which will appear for the operator.

Param Type Required Description

ChatID

stringid

yes

The chat identifier of the record to update

IncidentType

string

no

How the incident will appear to an operator. Values include:

  1. § tab
  1. § popup
  1. § dock

Url

string

yes

The Url to populate for this incident.

Name

string

no

The name of the tab shown to the operator for the incident before the tab is loaded, or if the document loaded has no title element.

Returns:

Param Type Description

IncidentID

string id

The unique identifier for the incident created.

removeChatIncidents

Used to remove all chat incidents created using this API key associated with the given chat.

Param Type Required Description

ChatID

string id

yes

The identifier of the chat

Returns:

Param Type Description

IncidentIDs

JSON array

A JSON array of string IDs of the incidents deleted

removeChatIncident

Used to remove a given chat incident.

Param Type Required Description

IncidentID

stirng id

yes

The identifier of the incident

Returns: Nothing

Single Item Data Retrieval Methods

All methods return:

Parameter Type Description
Data JSON object A JSON object with the mappings of the table fields to their values

getTextChats

Gets inactive messaging conversation records.

  • Maximum page size: 1000 records
Parameter Type Required Description
FolderID string id yes The identifier of the folder to retrieve

getAllTextChatAssignments

Gets assignments for all ended message conversations.

  • No additional parameters required
  • Maximum page size: 500 records

getAllTextChatMessages

Gets messages across the account based on the Created date.

  • No additional parameters required
  • Maximum page size: 1000 records

getChat

Gets an individual chat record.

Parameter Type Required Description
ChatID string id yes The identifier of the chat to retrieve

getVisit

Gets an individual visit record.

Parameter Type Required Description
VisitID string id yes The identifier of the visit to retrieve
Created date no
  • If specified, the method returns records 30 days prior to through 30 days after the given date
  • If not specified, the method returns records for the last 90 days

getEmailThread

Gets an individual email thread record.

Parameter Type Required Description
EmailThreadID string id yes The identifier of the email thread to retrieve

getTicket

Gets an individual ticket record.

Parameter Type Required Description
TicketID string id yes The identifier of the ticket to retrieve

getContact

Gets an individual contact record.

Parameter Type Required Description
ContactID string id yes The identifier of the contact to retrieve

getFolder

Gets an individual folder record.

Parameter Type Required Description
FolderID string id yes The identifier of the folder to retrieve

getDepartment

Gets an individual department record.

Parameter Type Required Description
DepartmentID string id yes The identifier of the department to retrieve

getOperator

Gets an individual operator record.

Parameter Type Required Description
OperatorID string id yes The identifier of the operator to retrieve

Paged Data Retrieval Methods, version 1

Important: Version 1 and version 2 retrieve the same page data with different input parameters, and the result are retrieved in a different way.

With version 1, you can retrieve all your results with your first API call. In a subsequent API call, you can define the starting element and the size of the result list, which tells the server to skip retrieving the previous elements. Results are sorted by date and time of creation.

All paged methods support the following parameters:

Param Type Version Required Description

FromDate

date

All

no

The start date

ToDate

date

All

no

The end date

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.)

All paged methods return:

Param Type Version Description

Data

json array

All

A JSON array of JSON objects with the mappings of fields to values

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.

getInactiveChats

  • Gets inactive chats for a folder based on the Closed date.
  • Max page size: 500 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getAllChatMessages

  • Gets chat messages across the account based on the Created date.
  • No additional parameters are needed.
  • Max page size: 500 records

getInactiveVisits

  • Gets inactive visits for a folder based on the Closed date.
  • Max page size: 1000 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getAllPageViews

Important: As of March 31, 2018, version 1 of the getAllPageViews method becomes deprecated. From April 1, 2018, this API call returns an HTTP 410 error message. Use version 2 of getAllPageViews to retrieve page views.
  • Gets page views across the account based on the Ended date. Results are restricted to the last 3 months.
  • No additional parameters are needed.
  • Max page size: 1000 records

Sample code

curl "https://api.boldchat.com/aid/$accountId/data/rest/json/v1/getAllPageViews?FromDate=2017-11-02T07:50:41+01:00&PageSize=500"

This API call returns the following result:

{
   "Status":"success",
   "Truncated":true,
   "Next":{
      "PageSize":500,
      "PageStart":1,
      "FromDate":"2017-11-02T06:50:41.000Z",
      "ToDate":"2018-01-23T13:43:56.000Z"
       },
   "Data":[...]
}

As long as the Truncated parameter is returned as true, you can query the next page of the results as follows:

curl "https://api.boldchat.com/aid/$accountId/data/rest/json/v1/getAllPageViews?FromDate=2017-11-02T07:50:41+01:00&ToDate=2018-01-23T14:43:56+01:00&PageStart=1&PageSize=500"

This API call returns the following result:

{
   "Status":"success",
   "Truncated":false,
   "Data":[...]
}

getAllInvitations

  • Gets invitations across the account based on the Created date.
  • No additional parameters are needed.
  • Max page size: 1000 records

getConversions

  • Gets conversions for a folder based on the Created date.
  • Max page size: 5000 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getEmailThreads

  • Gets email threads for a folder based on the Created date.
  • Max page size: 500 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getOpenEmailThreads

  • Gets open email threads for a folder based on the Created date.
  • Max page size: 500 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getClosedEmailThreads

  • Gets closed email threads for a folder based on the Closed date.
  • Max page size: 500 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getTickets

  • Gets tickets for a folder based on the Created date.
  • Max page size: 1000 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getClosedTickets

  • Gets closed tickets for a folder based on the Closed date.
  • Max page size: 1000 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getOpenTickets

  • Gets open tickets for a folder based on the Created date.
  • Max page size: 1000 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getContacts

  • Gets contacts for a folder based on the Created date.
  • Max page size: 3000 records
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getLoginActivity

  • Gets login activity details for the account.
  • Max page size: 3000 records
Param Type Required Description

ServiceTypeID

string id

yes

The service type to query for activity. See ServiceType for a list of types

FromDate

date

no

Start date to query

ToDate

date

no

End date to query

Paged Data Retrieval Methods, version 2

Important: Version 1 and version 2 retrieve the same page data with different input parameters, but the result are retrieved in a different way.

With version 2, you can retrieve all your results with your first API call. If the first call returns a NextPage parameter, then in a subsequent API call, you can retrieve the next page of results. Results are retrieved unsorted.

All paged methods support the following parameters:

Param Type Version Required Description

FromDate

date

All

no

The start date

ToDate

date

All

no

The end date

NextPage

string

v2 or above

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.

All paged methods return:

Param Type Version Description

Data

json array

All

A JSON array of JSON objects with the mappings of fields to values

Truncated

boolean

All

Whether or not the above JSON array is the complete result set, or if the server limited the returned results.

NextPage

string

v2 or above

If the method called supports it, and the data is truncated, the NextPage parameter will contain the necessary information to pass back to the same server method to get the next page of results.

getInactiveChats

Gets inactive chats for a folder based on the Closed date.

Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getAllChatMessages

  • Gets chat messages across the account based on the Created date.
  • No additional parameters are needed.

getInactiveVisits

  • Gets inactive visits for a folder based on the Closed date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getAllPageViews

  • Gets page views across the account based on the Ended date. Results are restricted to the last 3 months.
  • No additional parameters are needed.
  • You can test your API implementation on our interactive page.

When you migrate from version 1 of this method, consider the following:

  • You cannot define the maximum page size in version 2
  • You must define different input parameters in version 2
  • From April 1, 2018, you can only use version 2 of this method

Sample code

"https://api.boldchat.com/aid/$accountId/data/rest/json/v2/getAllPageViews?auth=$authHash&FromDate=2017-11-02T06:50:41.000Z"

This API call returns the following result:

{
    "Status": "success",
    "Truncated": true,
    "Data": [
  {
            "PageViewID": "1839194691477381",
            "Url": "https://<yourURL>",
            "VisitID": "1839195045224224",
            "Created": "2018-01-23T13:43:55.513Z",
            "Ended": "2018-01-23T13:43:56.000Z",
            "AccountID": $accountId,
            "Deleted": null,
            "VisitorID": "1833179461808746"
       }     
    ],
    "NextPage": "eyJQYWdl...MzoyNC4wMDBaIn0="
}

As long as the Truncated parameter is returned as true, you can query the next page of the results as follows:

curl "https://api.boldchat.com/aid/$accountId/data/rest/json/v2/getAllPageViews?auth=$authHash&NextPage=eyJQYWdlU...wMDBaIn0="

This API call returns the following result:

{
    "Status":"success",
    "Truncated":false,
    "Data": [
  {
            "PageViewID": "1839194691477611",
            "Url": "https://<yourURL>",
            "VisitID": "1839195045224224",
            "Created": "2018-01-23T13:48:55.551Z",
            "Ended": "2018-01-23T13:51:26.000Z",
            "AccountID": $accountId,
            "Deleted": null,
            "VisitorID": "1833179461808746"
       }     
    ]
}

getAllInvitations

  • Gets invitations across the account based on the Created date.
  • No additional parameters are needed.

getConversions

  • Gets conversions for a folder based on the Created date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getEmailThreads

  • Gets email threads for a folder based on the Created date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getOpenEmailThreads

  • Gets open email threads for a folder based on the Created date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getClosedEmailThreads

  • Gets closed email threads for a folder based on the Closed date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getTickets

  • Gets tickets for a folder based on the Created date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getClosedTickets

  • Gets closed tickets for a folder based on the Closed date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getOpenTickets

  • Gets open tickets for a folder based on the Created date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getContacts

  • Gets contacts for a folder based on the Created date.
Param Type Required Description

FolderID

string id

yes

The identifier of the folder to retrieve data from

getLoginActivity

  • Gets login activity details for the account.
Param Type Required Description

ServiceTypeID

string id

yes

The service type to query for activity. See ServiceType for a list of types

FromDate

date

no

Start date to query

ToDate

date

no

End date to query

List Data Retrieval Methods

All methods return:

Parameter Type Description
Data JSON array A JSON array of JSON objects with the mappings of fields to values
Truncated boolean Whether or not the above JSON array is the complete result set, or if the server limited the returned results. For these methods, it is unlikely the limit will be hit, but if it is either filter down the results set or contact us to try to find a way to get at the data you are looking for.

getTextChatAssignments

Gets assignments for a given messaging conversation.

Parameter Type Required Description
TextChatID string id yes The identifier of the message conversation to get assignments for

getTextChatMessages

Gets messages for a given messaging conversation.

Parameter Type Required Description
TextChatID string id yes The identifier of the message conversation to get messages for

getChatMessages

Gets chat messages for a given chat.

Parameter Type Required Description
ChatID string id yes The identifier of the chat to get messages for

getActiveChats

Gets active chats for a given folder, operator or department.

Maximum page size: 1000 records

Parameter Type Required Description
FolderID string id no The identifier of the folder to get active chats for
OperatorID string id no The identifier of the operator to get active chats for
DepartmentID string id no The identifier of the department to get active chats for

getChatAssignments

Gets chat assignments for a given chat.

Maximum page size: 500 records

Parameter Type Required Description
ChatID string id yes The identifier of the chat to get assignments for

getPageViews

Gets page views for a given visit.

Note: If the Created parameter is not supplied, the method only returns records for the last 90 days.

Maximum page size: 500 records

Parameter Type Required Description
VisitID string id yes The identifier of the visit to get page views for
Created date no
  • If specified, the method returns records 30 days prior to through 30 days after the given date
  • If not specified, the method returns records for the last 90 days

getActiveVisits

Gets active visits for a given folder.

Maximum page size: 500 records

Parameter Type Required Description
FolderID string id yes The identifier of the folder to get active visits for

getInvitations

Gets invitations for a given visit.

Maximum page size: 500 records

Parameter Type Required Description
VisitID string id yes The identifier of the visit to get invitations for

getEmails

Gets emails for a given email thread.

Maximum page size: 150 records

Parameter Type Required Description
EmailThreadID string id yes The identifier of the email thread to get emails for

getEmailAttachmentEntries

Gets email attachment details for a given email.

Maximum page size: 1000 records

Parameter Type Required Description
EmailID string id yes The identifier of the email to get attachment entries for

getEmailThreadAssignments

Gets email thread assignments for a given email thread.

Parameter Type Required Description
EmailThreadID string id yes The identifier of the email thread to get assignments for

getTicketAssignments

Gets ticket assignments for a given ticket.

Parameter Type Required Description
TicketID string id yes The identifier of the ticket to get assignments for

getOperatorDiscussions

Gets operator discussion messages associated with the given item.

Maximum page size: 1000 records

Parameter Type Required Description
ItemType integer yes The type of item. See FolderType (ItemType) for a list of types.
ItemID string id yes The identifier of the item

getSetupItems

Gets setup items on the account of the given type.

Parameter Type Required Description
FolderType integer yes The type of setup items to retrieve. See FolderType for a list of types

getFolders

Gets folders setup on the account.

Parameter Type Required Description
FolderType integer no The folder type to query. If omitted, all folders will be returned. See FolderType for a list of types.

getDepartments

Gets all departments for the account.

No additional parameters required.

getOperators

Gets all operators for the account.

No additional parameters required.

getOperatorClients

Gets all operator clients signed in to the account.

No additional parameters required.

getDepartmentOperators

Gets operators assigned to the given department.

Parameter Type Required Description
DepartmentID string id yes The identifier of the department

getOperatorDepartments

Gets departments assigned to the given operator.

Parameter Type Required Description
OperatorID string id yes The identifier of the operator

getExperimentGroups

Gets a list of experiment groups for a specific visitID.

Maximum page size: 500 records

Parameter Type Required Description
VisitID string id yes The identifier of the department
Created date no
  • If specified, the method returns visits closed 30 days prior to through 30 days after the given date
  • If not specified, the method returns visits closed 30 days prior to through 30 days after the current date
WebsiteDefID string id no If specified, the methods returns records for the given website only

Reports API

Important: Reports generated through the API are not visible in BoldChat reports.
Important: All reports accept the following parameters:
Parameter Type Required Description
ReportType integer yes The report type ID. See the table below for available report types.
Grouping string yes The grouping key which varies by report. See the table below for supported groupings for the report you wish to run.
FromDate iso8601 date-time yes The starting date for the report.
ToDate iso8601 date-time yes The ending date for the report.

runReport

Starts generating a report; however, this method does not return report data. Report generation is run asynchronously, so you must call getReport to check the report status. This call returns a ReportID value which must be passed as a parameter to the getReport method to retrieve the report data.

getReport

Retrieves the report data if it is available.

Parameter Type Required Description
ReportID string id yes The report you want to retrieve. This report id must be the one returned in the call to runReport.

Reports require time to be generated and cannot be immediately acquired. Depending on the generation status, the following codes are returned:

Code Status Description
0-3 Running The report is being generated
4 Success The report is successfully generated
5 Timeout The report took too long to generate

The following table lists the supported reports. The filters are additional parameters that can be passed to the runReport call.

Report Type Groupings Filters Return Fields
Chat Summary 0

access_key

button

chat_type

chat_url

country

custom_field_1

custom_field_2

date

day_of_week

folder

hour

invite

mobility

operator

user_category

user_status

website

window

AutoTranslate (0=no, 1=yes)

AnyAssignmentDepartmentID

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Chat Conversion Summary 11

conversion_code

country

custom_invite

date

day_of_week

entry_url

experiment_group

folder

hour

keywords

operator

referrer

referrer_url

ChatInvitationTemplateVariantID

ConversionAmount

ConversionCodeID

CountryCode (2 letter)

DepartmentID

DepartmentIDFinal

DepartmentIDInitial

ExperimentGroupID

FolderID

OperatorID

RefererID

WebsiteDefID

ACD Summary 18

access_key

button

chat_type

chat_url

country

custom_field_1

custom_field_2

date

day_of_week

folder

hour

invite

mobility

operator

user_category

user_status

website

window

AnyAssignmentDepartmentID

AutoTranslate (0=no, 1=yes)

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Missed Opportunities Summary 37

date

day_of_week

hour

CountryCode (2 letter)

FolderID

VisitFolderID

WebsiteDefID

Canned Message Summary 39

account

operator

AnyAssignmentDepartmentID

AutoTranslate (0=no, 1=yes)

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Salesforce Summary 30

access_key

button

chat_type

country

custom_field_1

custom_field_2

date

day_of_week

folder

hour

invite

mobility

operator

user_category

user_status

website

window

AnyAssignmentDepartmentID

AutoTranslate (0=no, 1=yes)

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Chat Assignment Report 63

date

operator

DepartmentID

FromDepartmentID

FolderID

FromOperatorID

OperatorID

ActiveAssist Chat Summary 64

active_assist

chat_type

date

folder

operator

website

window

ActiveAssistType (see field types)

AnyAssignmentDepartmentID

AutoTranslate (0=no, 1=yes)

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

CountryCode (2 letter)

CustomField1IDCustomField2IDDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderIDMessages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorIDUserCategoryIDUserStatusID

WebsiteDefID

Button Availability Report 68

date

button

AvailabilityStatus (see field types)

ChatButtonDefID

WebsiteDefID

Email Productivity
Accepted 79

date

day_of_week

email_Account

folder

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Answered 74

date

day_of_week

email_Account

folder

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Assigned 78

date

day_of_week

email_Account

folder

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Closed (Answered) 80

date

day_of_week

email_Account

folder

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Closed (Unanswered) 81

date

day_of_week

email_Account

folder

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Sent 76

date

day_of_week

email_Account

folder

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Received 77

date

day_of_week

email_Account

folder

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Time To Respond 82

date

day_of_week

email_Account

folder

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Summary 83

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

EmailAccountID

EmailCount

FolderID

OperatorID

Service-Level Analysis
Answered 8

date

day_of_week

hour

operator

AutoTranslate (0=no, 1=yes)

AnyAssignmentDepartmentID

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Interval (seconds, required)

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Unanswered 9

date

day_of_week

hour

AutoTranslate (0=no, 1=yes)

AnyAssignmentDepartmentID

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Interval (seconds, required)

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Chat Duration 10

date

day_of_week

hour

operator

AutoTranslate (0=no, 1=yes)

AnyAssignmentDepartmentID

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Interval (seconds, required)

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Average Time in Queue 71

date

day_of_week

hour

operator

AutoTranslate (0=no, 1=yes)

AnyAssignmentDepartmentID

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

ExperimentGroupID

FolderID

Interval (seconds, required)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Operator Reports
Survey 17

operator

AutoTranslate (0=no, 1=yes)

AnyAssignmentDepartmentID

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Survey NPS 67

operator

ChatAPISettingsID

AnyAssignmentDepartmentID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Activity 20

date

day_of_week

hour

operator

AnyAssignmentDepartmentID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

OperatorID

WebsiteDefID

Productivity 19

operator

DepartmentID

OperatorID

Custom Survey 34

operator

AutoTranslate (0=no, 1=yes)

AnyAssignmentDepartmentID

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Custom Wrap-Up 65

operator

AutoTranslate (0=no, 1=yes)

AnyAssignmentDepartmentID

ChatAPISettingsID

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Visit
Visit Summary 4

country

custom_invite

date

day_of_week

entry_url

exit_url

folder

hour

keywords

referrer

referrer_url

user_agent

CallInvitationTemplateVariantID

ChatInvitationTemplateVariantID

CountryCode (2 letter)

EntryUrlQueryParameter

FolderID

InviteStatusType (see field types)

RefererID

WebsiteDefID

Invite Summary 38

rule

CountryCode (2 letter)

FolderID

InvitationDefID

InviteStatusType (see field types)

OperatorID

WebsiteDefID

Visit Chat Interactions 28

chat_type

chat_url

country

entry_url

exit_url

keywords

mobility

referrer

referrer_url

AutoTranslate (0=no, 1=yes)

ChatButtonDefID

ChatDuration (seconds)

ChatType (see field types)

ChatWindowDefID

ClientType (see field types)

CountryCode (2 letter)

CustomField1ID

CustomField2ID

DepartmentID

DepartmentIDInitial

DepartmentIDFinal

FolderID

EntryUrlQueryParameter

Messages (integer)

MessagesOperator (integer)

MessagesVisitor (integer)

OperatorID

UserCategoryID

UserStatusID

WebsiteDefID

Login
Chat Login Summary 41

operator

OperatorID

DepartmentID

Chat Login Detail 6

date

operator

OperatorID

DepartmentID

Experiment
Experiment Summary 69

experiment

ExperimentGroupID

WebsiteDefID

Experiment Detail 70

experiment

ExperimentGroupID

WebsiteDefID