Comm100

Visitor History

Visitor Histories

- Visitor Histories Manage

GET livechat/visitorHistory:Search

DELETE livechat/visitorHistory

Model

Visitor History JSON Format

Visitor History is represented as simple flat JSON objects with the following keys:

Name	Type	Description
`id`	integer	Id of the visitor history.
`sessionId`	guid	Id of the session.
`time`	datetime	Time of the visitor history.
`type`	string	Allowed values are "none", "chat", "offlineMessage", "chatOrOfflineMessage", "navigation", "chatOrNavigation", "offlineMessageOrNavigation", "chatOrOfflineMessageOrNavigation".
`name`	string	Name of the visitor.
`email`	string	Email of the visitor.
`departmentId`	guid	Id of the department.
`summary`	string	Summary of the visitor history.
`ssoUserId`	string	Id of the SSO user.
`departmentName`	string	Name of the department.
`agentsName`	string	Name of agents.
`categoryiesName`	string	Name of categories.
`autoInvitationId`	guid	Id of the auto invitation.
`autoInvitationName`	string	Name of the auto invitation.
`ip`	string	IP of the visitor history.
`city`	string	City of the visitor history.
`state`	string	State of the visitor history.
`country`	string	Country of the visitor history.
`zipCode`	string	Zip code of the visitor history.
`customVariables`	string	Custom variables of the visitor history.
`campaignId`	guid	Id of the campaign.
`campaignName`	string	Name of the campaign.
`refererUrl`	string	Referrer URL of the visitor history.
`agentId`	guid	Id of the agent.

Endpoint

Search Visitor Histories

GET livechat/visitorHistory:Search

Parameters:

Name	Type	In	Required	Description
`pageSize`	integer	query	no	Page size.
`include`	string	query	no	Allowed values are contactIdentity, "campaign", "chatAgent", "chatWrapupCategory", "department".
`visitorId`	string	query	no	Id of the visitor.
`pageIndex`	integer	query	no	Page index.

Response:

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/visitorHistory:Search \

-X 'GET' \

-H 'Authorization: Bearer {access_token}' \

Response:

HTTP/1.1 200 OK

Delete Visitor History

DELETE livechat/visitorHistory

Parameters:

No Parameters

Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/visitorHistory \

-X 'DELETE' \

-H 'Authorization: Bearer {access_token}' \

-D '[{"id":4875,"type":"chat"}]'

Response:

HTTP/1.1 200 OK