| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the chat session. |
button |
object |
Chat button. |
button.id |
string |
Id of the button. |
button.name |
string |
Name of the button. |
visitor |
string |
Visitor. |
visitor.name |
string |
Name of the Visitor. |
visitor.emaillAddress |
string |
Email address of the Visitor. |
visitor.networkAddress |
string |
IP address of the visitor. |
visitor.startPage |
string |
Web page start page. |
visitor.country |
string |
Country of the visitor. Based on IP address of the visitor. |
visitor.city |
string |
City of the visitor. Based on IP address of the visitor. |
visitor.operatingSystem |
string |
Operating system used by the visitor. |
visitor.browser |
string |
Type of browser used by the visitor. |
visitor.userAgent |
string |
User agent string of browser used by the visitor. |
start |
object |
The start time of the first chat message for this session. |
start.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). |
start.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. |
messages[] |
list |
Messages of the chat session. |
messages[].id |
string |
Identifier of the chat message. |
messages[].sessionId |
string |
Chat session identifier. |
messages[].message |
string |
Text of the message. |
messages[].source |
string |
Writer of the message, Values: "operator" or "visitor". |
messages[].sent |
object |
The send date of the message. |
messages[].sent.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). |
messages[].sent.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. |
Authentication is required to execute this request. Please refer to Authentication for more.
{sessionId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
sessionId |
string |
Session identifier. |
Do not supply a request body with this method.
If successful, this method returns a History resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Optional query parameters | ||
startDate |
datetime |
Upper bound (exclusive) for a session start time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by start time. |
endDate |
string |
Lower bound (exclusive) for a session start time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by end time. |
If successful, this method returns a response body with the following structure:
| Parameter name | Value | Description |
|---|---|---|
summary |
string |
Resumed information about the chat sessions. |
summary.averageChatSessionDuration |
float |
Average durection of a chat session, in seconds. |
summary.chatSessions |
integer |
Number of chat sessions. |