Bold360 and BoldChat Developer Center

Agent (Operator) Reports

Important: Reports generated through the API are not visible in Bold360 reports.

To generate reports, see Reports.

Agent (Operator) Survey report

Gives an overview of how satisfied chatters are with the service your agents are providing.

Input parameters

Parameter Type Required Description
ReportType integer yes For this report, report type ID is 17.
Grouping string yes The grouping key which varies by report. Available groupings are:
  • operator

FromDate iso8601 date-time yes The starting date for the report.
ToDate iso8601 date-time yes The ending date for the report. For information on the syntax of the date-time parameters, see https://www.w3.org/TR/NOTE-datetime.
Filters string no The filters are additional parameters that can be passed to the runReport call. The following filters are available:
  • 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

Agent (Operator) Survey NPS report

This report provides an agent by agent view of performance on the after-chat survey. For completed surveys, the NPS scores are presented.

Input parameters

Parameter Type Required Description
ReportType integer yes For this report, report type ID is 67.
Grouping string yes The grouping key which varies by report. Available groupings are:
  • operator

FromDate iso8601 date-time yes The starting date for the report.
ToDate iso8601 date-time yes The ending date for the report. For information on the syntax of the date-time parameters, see https://www.w3.org/TR/NOTE-datetime.
Filters string no The filters are additional parameters that can be passed to the runReport call. The following filters are available:
  • 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

Agent (Operator) Activity report

Provides an overview of the chat volume handled by your agents. For a total number of chats offered, see the number and percent that were answered vs. missed.

Input parameters

Parameter Type Required Description
ReportType integer yes For this report, report type ID is 20.
Grouping string yes The grouping key which varies by report. Available groupings are:
  • date

  • day_of_week

  • hour

  • operator

FromDate iso8601 date-time yes The starting date for the report.
ToDate iso8601 date-time yes The ending date for the report. For information on the syntax of the date-time parameters, see https://www.w3.org/TR/NOTE-datetime.
Filters string no The filters are additional parameters that can be passed to the runReport call. The following filters are available:
  • AnyAssignmentDepartmentID

  • DepartmentID

  • DepartmentIDInitial

  • DepartmentIDFinal

  • FolderID

  • OperatorID

  • WebsiteDefID

Agent (Operator) Productivity report

Provides an overview of how busy your chat agents are as well as an agent by agent overview of their time spent chatting.

Input parameters

Parameter Type Required Description
ReportType integer yes For this report, report type ID is 19.
Grouping string yes The grouping key which varies by report. Available groupings are:
  • operator

FromDate iso8601 date-time yes The starting date for the report.
ToDate iso8601 date-time yes The ending date for the report. For information on the syntax of the date-time parameters, see https://www.w3.org/TR/NOTE-datetime.
Filters string no The filters are additional parameters that can be passed to the runReport call. The following filters are available:
  • DepartmentID

  • OperatorID

Custom Survey report

Provides an agent by operator view of performance on the default post-chat and custom pre/post-chat survey fields.

Input parameters

Parameter Type Required Description
ReportType integer yes For this report, report type ID is 34.
Grouping string yes The grouping key which varies by report. Available groupings are:
  • operator

FromDate iso8601 date-time yes The starting date for the report.
ToDate iso8601 date-time yes The ending date for the report. For information on the syntax of the date-time parameters, see https://www.w3.org/TR/NOTE-datetime.
Filters string no The filters are additional parameters that can be passed to the runReport call. The following filters are available:
  • 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 report

Provides an overview of data collected on custom wrap-up forms.

Input parameters

Parameter Type Required Description
ReportType integer yes For this report, report type ID is 65.
Grouping string yes The grouping key which varies by report. Available groupings are:
  • operator

FromDate iso8601 date-time yes The starting date for the report.
ToDate iso8601 date-time yes The ending date for the report. For information on the syntax of the date-time parameters, see https://www.w3.org/TR/NOTE-datetime.
Filters string no The filters are additional parameters that can be passed to the runReport call. The following filters are available:
  • 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