getInactiveVisits
Returns inactive (past) visits for a specified folder.
Input parameters
Parameter | Type | Required | Description |
---|---|---|---|
FolderID |
numeric - ID code |
Yes |
The identifier of the folder to retrieve data from. |
FromDate |
date - ISO/UTC |
No |
The start date. |
ToDate |
date - ISO/UTC |
No |
The end date. |
NextPage |
string |
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. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getInactiveVisits?auth=$authHash&FromDate=2020-01-01T00:00:00Z"
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:
|
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 | date - ISO / UTC | Date and time when the item was deleted. The value is null if the item was not 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 | Info for a visit sent by custom scripts. |
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:
|
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. |
RefererUrl | string - legal URL | The referring location given credit for referring the customer to the site initially to make the conversion. |
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. |
RowNumber | integer | |
Status | codes - set values | "Success" when the call completes; "Error" when the call fails. |
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. |
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:
|
VisitEmailAddress | string - legal email | The email address of the customer from the pre-chat survey. |
VisitEmailAddressNew | ||
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 frontend (pass custom information about customer). |
VisitSeq | integer | Incremented number of unique visits. |
VisitStatusType | integer | Status of:
|
VisitType | integer | Type of:
|
WebsiteDefID | numeric - ID code | System-assigned ID of the website associated with the chat. |
Sample code
{
"Status": "success",
"Truncated": false,
"Data": [
{
"RowNumber": "1",
"VisitID": "445563557341851705",
"VisitType": 0,
"VisitActionType": 0,
"IP": "176.63.18.40",
"UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36 (2880x1800-192dpi)",
"ReverseIP": "",
"CurrentUrl": "https://akhiltalwar.github.io/testpage/",
"EntryUrl": "https://akhiltalwar.github.io/testpage/",
"RefererUrl": null,
"VisitorID": "445562450089778948",
"AccountID": "447307266697849894",
"PageViewCount": 1,
"Created": "2020-11-18T21:30:02.097Z",
"Ended": "2020-11-18T21:30:32.000Z",
"Updated": "2020-11-18T21:32:37.190Z",
"Deleted": null,
"FolderID": "445200406059827776",
"Closed": "2020-11-18T21:32:37.000Z",
"VisitSeq": 17,
"WebsiteDefID": "445200405525661888",
"VisitRef": null,
"VisitInfo": null,
"VisitName": null,
"CountryCode": "HU",
"RegionCode": "Budapest",
"City": "Budapest",
"RelatedToItemType": 58,
"RelatedToItemID": "7045544304361937273",
"VisitEmailAddress": null,
"VisitPhone": null,
"ChatInvitationID": null,
"ChatInvitationTemplateVariantID": null,
"VisitStatusType": 0,
"OperatorID": "445201225474815444",
"InviteDeclines": 0,
"InviteIgnores": 0,
"ChatStatusType": 0,
"InviteStatusType": 0,
"AreaCode": null,
"RefererID": null,
"RefererQuery": null,
"CallInvitationTemplateVariantID": null,
"CallStatusType": 0,
"InvitationItemType": null,
"Experiments": null,
"ExperimentDate": null,
"LastName": null,
"ExtendedInfo": null,
"VisitEmailAddressNew": null
}
]
}