Bold360 and BoldChat Developer Center

Visit Reports

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

To generate reports, see Reports.

Visit Summary report

Provides an overview of the traffic to one or more specified websites.

Input parameters

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

  • custom_invite

  • date

  • day_of_week

  • entry_url

  • exit_url

  • folder

  • hour

  • keywords

  • referrer

  • referrer_url

  • user_agent

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:
  • CallInvitationTemplateVariantID

  • ChatInvitationTemplateVariantID

  • CountryCode (2 letter)

  • EntryUrlQueryParameter

  • FolderID

  • InviteStatusType (see field types)

  • RefererID

  • WebsiteDefID

Invite Summary report

Analyzes the effectiveness of your Auto Invite Rule Sets.

Input parameters

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

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:
  • CountryCode (2 letter)

  • FolderID

  • InvitationDefID

  • InviteStatusType (see field types)

  • OperatorID

  • WebsiteDefID

Visit Chat Interactions report

Shows which search terms drive a high volume of chat interactions.

Input parameters

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

  • chat_url

  • country

  • entry_url

  • exit_url

  • keywords

  • mobility

  • referrer

  • referrer_url

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)

  • 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