Parameter |
Label |
Required |
Options |
Description |
Status |
Status |
NO |
Option |
Value |
open |
open |
closed |
closed |
waiting |
waiting |
connected |
connected |
missed |
missed |
end |
end |
|
|
OperatorIds |
OperatorIds |
NO |
|
|
DepartmentId |
DepartmentId |
NO |
|
|
AppId |
AppId |
NO |
|
|
Email |
Email |
NO |
|
|
StartTime |
StartTime |
NO |
Option |
Value |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
EndTime |
EndTime |
NO |
Option |
Value |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
VisitorType |
VisitorType |
NO |
Option |
Value |
lead |
lead |
contact |
contact |
|
|
UpdatedTimeStart |
UpdatedTimeStart |
NO |
Option |
Value |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
UpdatedTimeEnd |
UpdatedTimeEnd |
NO |
Option |
Value |
2023-12-31T00:00:00 |
2023-12-31T00:00:00 |
now |
now |
today |
today |
yesterday |
yesterday |
yearstart-10y |
yearstart-10y |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
monthend+1d-1y |
monthend+1d-1y |
|
The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start)
|
SortBy |
SortBy |
NO |
Option |
Value |
end_time |
end_time |
updated_time |
updated_time |
|
|
PageSize |
PageSize |
NO |
|
|
Label |
DataType |
Length |
Raw |
Description |
Id |
DT_WSTR |
500 |
False |
|
Question |
DT_WSTR |
1000 |
False |
|
Status |
DT_WSTR |
500 |
False |
|
StartTime |
DT_DBTIMESTAMP |
0 |
False |
|
EndTime |
DT_DBTIMESTAMP |
0 |
False |
|
ChatDuration |
DT_WSTR |
500 |
False |
|
MissedReason |
DT_WSTR |
500 |
False |
|
OwnerEmail |
DT_WSTR |
500 |
False |
|
OwnerId |
DT_WSTR |
500 |
False |
|
RatingString |
DT_WSTR |
100 |
False |
|
Rating |
DT_I4 |
0 |
False |
|
VisitorCountryCode |
DT_WSTR |
50 |
False |
|
VisitorName |
DT_WSTR |
500 |
False |
|
VisitorEmail |
DT_WSTR |
1000 |
False |
|
VisitorId |
DT_WSTR |
500 |
False |
|
VisitorChannelDetailsChannel |
DT_WSTR |
100 |
False |
|
VisitorChannelDetailsSource |
DT_WSTR |
4000 |
False |
|
VisitorSupportedOperations |
DT_WSTR |
4000 |
False |
|
VisitorIp |
DT_WSTR |
500 |
False |
|
VisitorPhone |
DT_WSTR |
500 |
False |
|
VisitorType |
DT_WSTR |
100 |
False |
|
VisitorChannelName |
DT_WSTR |
100 |
False |
|
HasNotes |
DT_BOOL |
0 |
False |
|
UnreadChats |
DT_BOOL |
0 |
False |
|
Uvid |
DT_WSTR |
500 |
False |
|
StatusCode |
DT_I4 |
0 |
False |
|
DepartmentName |
DT_WSTR |
500 |
False |
|
DepartmentId |
DT_WSTR |
500 |
False |
|
AppName |
DT_WSTR |
100 |
False |
|
LastModifiedTime |
DT_DBTIMESTAMP |
0 |
False |
|
AppId |
DT_WSTR |
500 |
False |
|
Type |
DT_WSTR |
50 |
False |
|
ChatStatusStateKey |
DT_WSTR |
50 |
False |
|
ChatStatusStatusCode |
DT_I4 |
0 |
False |
|
ChatStatusState |
DT_I4 |
0 |
False |
|
ChatStatusId |
DT_WSTR |
50 |
False |
|
ChatStatusLabel |
DT_WSTR |
500 |
False |
|
ChatStatusStatusKey |
DT_WSTR |
100 |
False |
|
ReferenceId |
DT_WSTR |
50 |
False |
|
MissedTime |
DT_DBTIMESTAMP |
0 |
False |
|
VisitorUuid |
DT_WSTR |
500 |
False |
|
Supervisors |
DT_WSTR |
4000 |
False |
|
OwnerImageKey |
DT_WSTR |
500 |
False |
|
OwnerName |
DT_WSTR |
500 |
False |
|
OwnerIsBot |
DT_BOOL |
0 |
False |
|
OwnerCallEnabled |
DT_BOOL |
0 |
False |
|
EndedByName |
DT_WSTR |
500 |
False |
|
EndedByType |
DT_WSTR |
100 |
False |
|
EndedById |
DT_WSTR |
500 |
False |
|
AttenderImageKey |
DT_WSTR |
500 |
False |
|
AttenderEmail |
DT_WSTR |
500 |
False |
|
AttenderName |
DT_WSTR |
500 |
False |
|
AttenderIsBot |
DT_BOOL |
0 |
False |
|
AttenderCallEnabled |
DT_BOOL |
0 |
False |
|
AttenderId |
DT_WSTR |
500 |
False |
|
Participants |
DT_WSTR |
4000 |
False |
|
AttendedTime |
DT_DBTIMESTAMP |
0 |
False |
|
LastMessageInfoSequenceId |
DT_WSTR |
50 |
False |
|
LastMessageInfoSenderName |
DT_WSTR |
500 |
False |
|
LastMessageInfoSenderId |
DT_WSTR |
500 |
False |
|
LastMessageInfoType |
DT_WSTR |
50 |
False |
|
LastMessageInfoTime |
DT_DBTIMESTAMP |
0 |
False |
|
LastMessageInfoLastReadMessageId |
DT_WSTR |
500 |
False |
|
LastMessageInfoId |
DT_WSTR |
500 |
False |
|
VisitorStatusWhileEnd |
DT_WSTR |
100 |
False |
|
CustomerInfoCompany |
DT_WSTR |
500 |
False |
|
LastMessageInfoText |
DT_WSTR |
50 |
False |
|
LastMessageInfoFormattedText |
DT_WSTR |
4000 |
False |
|
LastMessageInfoMessage |
DT_WSTR |
1280 |
False |
|
LastMessageInfoMessageTime |
DT_DBTIMESTAMP |
0 |
False |
|
LastMessageInfoMode |
DT_WSTR |
100 |
False |
|
LastMessageInfoOperationUserName |
DT_WSTR |
500 |
False |
|
LastMessageInfoOperationUserId |
DT_WSTR |
500 |
False |
|
OwnerAboutme |
DT_WSTR |
500 |
False |
|
AttenderAboutme |
DT_WSTR |
500 |
False |
|
LastMessageInfoEditedTime |
DT_DBTIMESTAMP |
0 |
False |
|
LastMessageInfoEdited |
DT_BOOL |
0 |
False |
|
VisitorUserId |
DT_WSTR |
500 |
False |
|