Bold360 and BoldChat Developer Center

getVisit

Returns full detail for a specified visit.

Input parameters

Parameter Type Required Description
VisitID numeric - ID code Yes The identifier of the visit to retrieve.

Request format

curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getVisit?auth=$authHash&VisitID=$VisitID"

Return values

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

Parameter Type Description
AccountID numeric - ID code Bold360 product account ID.
AreaCode code - UNSD M49 area code Telephone area code for the region, typically captured in the pre-chat survey.
CallInvitationTemplateVariantID numeric - ID code ID of the template used to create the call invite.
CallStatusType integer Call status of visit when conversion occurred.
ChatInvitationID numeric - ID code Unique system-assigned ID of the invitation for the chat.
ChatInvitationTemplateVariantID numeric - ID code ID of the invitation template which holds different customer settings (e.g. logo url, style, etc.)
ChatStatusType integer Status of the chat at conversion (e.g. none, chat was unavailable, chat was blocked, etc), there are 17 types, more info in ConversionInfo. The most recent state that chat was in at the time of the chat closing. The legend of statuses is:
  • 0 - None
  • 1 - Pre-chat form
  • 2 - In chat
  • 3 - Pre-chat form closed
  • 4 - Chat ended
  • 5 - Transcript
  • 6 - Sent transcript
  • 7 - Unavailable
  • 8 - Sent unavailable
  • 9 - Chat ended answered
  • 10 - Unavailable blocked
  • 11 - Unavailable max queue
  • 12 - Unavailable hours
  • 13 - Sent unavailable blocked
  • 14 - Sent unavailable max queue
  • 15 - Unavailable limit
  • 16 - Sent unavailable limit
  • 17 - Unsecure
City string - ISO 3166 City of the visitor or customer.
Closed date - ISO/UTC Date and time the transaction - visit, chat, etc. - closed.
CountryCode code - ISO 3166 ISO 2-letter country code (e.g. US).
Created date - ISO/UTC Date and time when the target resource was created.
CurrentUrl string - legal URL Current URL of the visit.
Data text - heading JSON array heading that precedes report data output.
Deleted Boolean A True/False setting for whether the item referred to has been deleted.
Ended date - ISO/UTC Date and time visit or chat ended.
EntryUrl string - legal URL The initial landing page of the customer after being referred from the refererUrl location.
ExperimentDate date - ISO/UTC Date and time when the experiment actions are selected (on each new visit).
Experiments string (max) Byte array, where every index represents an experiment and every value represents the selected action for the given experiment.
ExtendedInfo string  
FolderID numeric The ID of the folder.
InvitationItemType integer Type of the invitation (chat, email, etc).
InviteDeclines integer Number of auto invites declined during this visit.
InviteIgnores integer Number of auto invites ignored during this visit.
InviteStatusType integer Visit invite status type:
  • 0 - None
  • 1 - Auto inviting
  • 2 - Manual inviting
  • 3 - Auto invite accepted
  • 4 - Manual invite accepted
  • 5 - Auto invite declined
  • 6 - Manual invite declined
  • 7 - Auto invite ignored
  • 8 - Manual invite ignored
  • 9 - Chat Recovery Inviting
  • 10 - Chat Recovery Accepted
  • 11 - Chat Recovery Declined
  • 12 - Chat Recovery Ignored
  • 13 - Customer qualified for invite, but IP address is blocked
  • 14 - Customer qualified for invite, but no agents were available
  • 15 - Customer qualified for invite, but chat queue size is too big
  • 16 - Customer qualified for invite, but not in hours of operation
IP string - legal URL IP address of the customer's device connecting to Bold360.
LastName string Last name of the customer (e.g. from pre-chat form).
OperatorID numeric - ID code System-assigned ID of the operator.
PageViewCount integer Number of pages a visitor viewed during their current session.
RefererID numeric - ID code ID of the referring individual.
RefererQuery string The search query, if recognized, given by the refererUrl used to refer the visitor to the site.
RegionCode codes - ISO 3166 The geographical state/province.
RelatedToItemID numeric - ID code ID assigned to relate VisitRef and ContactId from found contact record.
RelatedToItemType integer Filled in by system when relating from VisitRef and set contact folder type (byte).
ReverseIP string - legal URL The IP address of a customer's device used for reverse DNS lookup.
Status codes - set values "Success" when the call completes; "Error" when the call fails.
Updated date - ISO / UTC Date and time when the <event/record> was most recently modified.
UserAgent string (max) A user agent is a computer program representing a person, for example, a browser in a Web context. Could also be a bot scraping webpages, a download manager, or another app accessing the Web. Along with each request agents make to the server, browsers include a self-identifying header called a user agent (UA) string. This string often identifies the browser, its version number, and its host operating system.
VisitActionType integer Action type of the visit:
  • 0 - Normal
  • 1 - Blocked
  • 2 - Initiate chat
  • 3 - Invite chat
  • 4 - Initiate call
  • 5 - Invite call
VisitEmailAddress string - legal email The email address of the customer from the pre-chat survey.
VisitEmailAddressNew string - legal email An additional email address of the customer.
VisitID numeric - ID code The identifier of a specific visit.
VisitInfo string Free-form parameter for additional customer details, can be set from the front-end.
VisitName string (max) Parsed from the request, custom info, can be set from the front-end (pass custom information about customer).
VisitorID numeric - ID code ID of the visitor / customer to whom this visit belongs.
VisitPhone string - legal phone number The phone number of the customer, captured in pre-chat survey.
VisitRef string (max) Parsed from the request and primary user name, used for lookup in the contacts table to fill out RelatedToItemType and RelatedToItemId. Can be set from the front-end (pass custom information about customer).
VisitSeq integer Incremented number of unique visits.
VisitStatusType integer Status of:
  • 0 - None
  • 1 - Blocked
VisitType integer Type of:
  • 0 - Unmonitored
  • 1 - Monitored
WebsiteDefID numeric - ID code System-assigned ID of the website associated with the chat.

Sample code

{	
"Status": "success",	
"Data": {	
	"ChatInvitationTemplateVariantID": null,
	"RegionCode": "Massachusetts",
	"CallInvitationTemplateVariantID": null,
	"VisitID": "445480419157371667",
	"VisitInfo": null,
	"RefererQuery": null,
	"PageViewCount": 1,
	"VisitActionType": 0,
	"Updated": "2020-08-17T08:06:21.203Z",
	"RefererID": null,
	"VisitRef": null,
	"IP": "66.30.192.82",
	"City": "Boston",
	"ExtendedInfo": null,
	"VisitName": null,
	"EntryUrl": "https://bloomenfeld.github.io/testpage/",
	"ExperimentDate": null,
	"ChatStatusType": 9,
	"InviteIgnores": 0,
	"AreaCode": null,
	"LastName": null,
	"InviteDeclines": 0,
	"CurrentUrl": "https://blomenfeld.github.io/testpage/",
	"VisitEmailAddressNew": null,
	"VisitEmailAddress": null,
	"RefererUrl": null,
	"InvitationItemType": null,
	"FolderID": "445200406059827776",
	"OperatorID": "445201225474815444",
	"Experiments": null,
	"Created": "2020-08-14T16:05:42.000Z",
	"WebsiteDefID": "445200405525661888",
	"ChatInvitationID": null,
	"CallStatusType": 0,
	"UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:79.0) Gecko/20100101 Firefox/79.0 (1920x1080-96dpi)",
	"RelatedToItemType": 58,
	"Deleted": null,
	"CountryCode": "US",
	"ReverseIP": "",
	"VisitPhone": null,
	"VisitorID": "445431366647938930",
	"AccountID": "447307266697849894",
	"Ended": "2020-08-14T16:16:15.000Z",
	"Closed": "2020-08-14T16:21:20.000Z",
	"VisitStatusType": 0,
	"VisitType": 0,
	"InviteStatusType": 0,
	"VisitSeq": 2,
	"RelatedToItemID": "6782258023986106270"
	}
}