Cube is a virtual Entity. A report page may use multiple fields in multiple cube entities. There is a specific example of obtaining chat volume report on report document.
In the lower part of this page, we list all cubes and all fields corresponding to the cube.
Cube is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
mame |
string | Name of this cube |
fields |
field[] | Reference to Field |
Field JSON Format:
Name | Type | Description |
---|---|---|
name |
string | Name of the field |
type |
string | Allowed values are "string", "datetime", "reference", "decimal", "json", "int", "bool", "smallInt", "timespan", "guid", "selfIncreasingInt", "calculation" |
Cube Chat Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the chat. |
Guid |
guid | Guid of the chat. |
SessionId |
reference | Id of the session. |
Session.Id |
guid | Id of the session. |
Session.IP |
string | IP of the visitor. |
Session.ReferrerURL |
string | The rest part of the URL will be abandoned if the URL is too long. |
Session.Keywords |
string | Keywords of the visitor used to search for your website. |
Session.Browser |
string | Browser the visitor is using. |
Session.Language |
string | Language the visitor is using. |
Session.ScreenResolution |
string | Screen resolution of the visitor's device. |
Session.OperatorSystem |
string | Operating system of the visitor's device. |
Session.TimeZone |
12 | Time zone of the visitor. |
Session.LandingPageURL |
string | URL of the first page of your website the visitor visited. |
Session.LandingPageTitle |
string | Title of the first page of your website the visitor visited. |
Session.StartTime |
datetime | Time when the session started. |
Session.VisitorId |
guid | Id of the visitor. |
Session.ContactIdentityId |
guid | Id of the contact identity. |
Session.SearchEngineId |
guid | Id of the search engine the visitor used to search for your website. |
Session.City |
string | City of the visitor. |
Session.State |
string | State of the visitor. |
Session.CountryOrRegion |
string | Country or region of the visitor. |
Session.IsDeleted |
bool | Whether the session is deleted or not. |
StartTime |
datetime | Time when the chat started. |
EndTime |
datetime | Time when the chat ended. |
IsQueued |
bool | Whether the chat is queued or not. |
IfAudioChatHappened |
bool | Whether the chat happened audio chat or not. |
IfVideoChatHappened |
bool | Whether the chat happened video chat or not. |
Status |
smallInt | Status of chat. Enum: 0: normal, 1: refused, 2: missed, 3: switchedToMessage. |
Messages |
string | Messages of the chat. |
RequestingPageTitle |
string | Page title of the requesting page. |
RequestingPageURL |
string | Page URL of the requesting page. |
Source |
smallInt | Source of chat. Enum: 0: chatButton, 1: autoInvitation, 2: manualInvitation. |
AutoInvitationId |
reference | Id of the auto invitation. |
AutoInvitation.Id |
guid | Id of the auto invitation. |
AutoInvitation.Name |
string | Name of the auto invitation. |
AutoInvitation.IsEnabled |
string | Whether auto invitation is enabled or not. |
AutoInvitation.CampaignId |
reference | Id of the campaign. |
AutoInvitation.Campaign.Id |
guid | Id of the campaign. |
AutoInvitation.Campaign.Name |
string | Name of the campaign. |
PreChatSocialMediaSource |
smallInt | Pre-chat social media source of chat. Enum: 0: none, 1: facebook. |
PreChatSocialProfileURL |
string | Pre-chat social profile URL of the chat. |
PreChatName |
string | Pre-chat name of the chat. |
PreChatEmail |
string | Pre-chat email of the chat. |
PreChatPhone |
string | Pre-chat phone of the chat. |
PreChatCompany |
string | Pre-chat company of the chat. |
PreChatProductService |
string | Pre-chat product service of the chat. |
DepartmentId |
reference | Id of the department. |
Department.Id |
guid | Id of deparmtent. |
Department.Name |
string | Name of deparmtent. |
RequestedTime |
datetime | Time when the chat was requested. |
AvgResponseTime |
timespan | Average response time of the chat. |
VisitorMessagesCount |
int | The number of messages sent by visitors. |
AgentMessagesCount |
int | The number of messages sent by agents. |
CampaignId |
reference | Id of the campaign. |
Campaign.Id |
guid | Id of the campaign. |
Campaign.Name |
string | Name of the campaign. |
WaitingTime |
timespan | Waiting time of the chat. |
Duration |
timespan | Duration of the chat. |
CannedMessageCount |
int | The number of canned messages sent during the chat. |
BotDuration |
int | Bot duration of the chat. |
AgentDuration |
int | Agent duration of the chat. |
LastMessageSentBy |
smallInt | Last message sentby of chat. Enum: 0: visitor, 1: agent, 2: system, 3: chatBot. |
BotId |
reference | Id of the bot. |
Bot.Id |
guid | Id of the chatbot. |
Bot.Name |
string | Name of the chatbot. |
ChatType |
smallInt | Chat type of chat. Enum: 0: agentOnly, 1: chatBotOnly, 2: fromBotToAgent, 4: fromBotToOfflineMessage, 8: waitingToOfflineMessage, 16: queuingToOfflineMessage. |
PreChatTicketId |
int | Pre-chat ticket Id of the chat. |
IsDeleted |
bool | Whether the chat is deleted or not. |
OfflineMessageGuid |
guid | Guid of the offline message. |
VisitorId |
guid | Id of the visitor. |
ContactIdentityId |
guid | Id of the contact identity. |
SkillId |
reference | |
Skill.Id |
guid | |
Skill.Name |
string | |
PreviousScript |
string | |
AgentFirstResponseTime |
timespan | |
PostChatSurvey.RatingGrade |
smallInt | Allowed values are "1", "2", "3", "4", "5". |
PostChatSurvey.RatingComment |
string | Rating comment of the post chat. |
PostChatSurvey.SubmitTime |
datetime | Time when the post chat was submitted. |
PostChatSurvey.ChatId |
reference | Id of the chat. |
PostChatSurvey.IsDeleted |
bool | Whether the post chat survey is deleted or not. |
ChatWrapup.Comment |
string | Comment of the chat wrap-up. |
ChatWrapup.LastUpdatedTime |
datetime | Last updated time of the chat wrap-up. |
ChatWrapup.AgentId |
reference | Id of the agent. |
ChatWrapup.Agent.Id |
guid | Id of agent. |
ChatWrapup.Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
ChatWrapup.Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
ChatWrapup.Agent.FirstName |
string | |
ChatWrapup.Agent.LastName |
string | |
ChatWrapup.ChatId |
reference | Id of the chat. |
ChatWrapup.IsDeleted |
bool | Whether the chat wrap-up is deleted or not. |
ChatAgent.AgentId |
reference | Id of the agent. |
ChatAgent.Agent.Id |
guid | Id of agent. |
ChatAgent.Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
ChatAgent.Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
ChatAgent.Agent.FirstName |
string | |
ChatAgent.Agent.LastName |
string | |
ChatAgent.StartTime |
datetime | Time when the chat started. |
ChatAgent.EndTime |
datetime | Time when the chat ended. |
ChatAgent.Duration |
int | Duration of the chat. |
ChatAgent.ChatId |
reference | Id of the chat. |
ChatAgent.IsDeleted |
bool | Whether the chat agent is deleted or not. |
ChatFieldResult.Id |
int | Id of chat field result. |
ChatFieldResult.FormType |
smallInt | Form type of chat field result. Enum: 0: preChat, 1: offlineMessage, 2: postChat, 3: wrapUp, 4: pciForm, 5: customVariable. |
ChatFieldResult.FieldId |
reference | Id of the field. |
ChatFieldResult.Field.Id |
guid | Id of the field. |
ChatFieldResult.Field.IsSystem |
string | Whether the field is system field or not. |
ChatFieldResult.Field.Name |
string | Name of the field. |
ChatFieldResult.Field.Type |
smallInt | Type of field. Enum: 1: text, 2: textArea, 3: radioBox, 4: checkBox, 5: dropdownList, 6: checkboxList, 7: nps, 8: attachment, 9: rating, 10: checkboxListOptionGroups, 301: category, 302: comment. |
ChatFieldResult.FieldName |
string | Name of the field. |
ChatFieldResult.Value |
string | Value of the chat field result. |
ChatFieldResult.Url |
string | URL of the chat field result. |
ChatFieldResult.ChatId |
reference | Id of the chat. |
ChatFieldResult.IsDeleted |
bool | Whether the chat field result is deleted or not. |
ChatSegmentResult.Id |
int | Id of the chat segment result. |
ChatSegmentResult.SegmentId |
reference | Id of the segment. |
ChatSegmentResult.Segment.Id |
guid | Id of the segment. |
ChatSegmentResult.Segment.Name |
string | Name of the segment. |
ChatSegmentResult.Segment.IsEnabled |
string | Whether segment is enabled or not. |
ChatSegmentResult.LogTime |
datetime | Log time of the chat segment result. |
ChatSegmentResult.ChatId |
reference | Id of the chat. |
ChatSegmentResult.IsDeleted |
bool | Whether the chat segment field result is deleted or not. |
ChatWrapupCategory.Id |
int | Id of the chat wrapup category. |
ChatWrapupCategory.ChatId |
reference | Id of the chat. |
ChatWrapupCategory.CategoryOptionId |
reference | Id of the wrap-up category option. |
ChatWrapupCategory.CategoryOption.Id |
guid | Id of the wrap-up category option. |
ChatWrapupCategory.CategoryOption.Name |
string | Name of the wrap-up category option. |
ChatWrapupCategory.CategoryOption.GroupId |
reference | Id of the wrapup category group which the wrapup category option belongs to. |
ChatWrapupCategory.IsDeleted |
bool | Whether the chat wrap-up catagory is deleted or not. |
CobrowseHistory.Id |
int | Id of the cobrowse history. |
CobrowseHistory.StartTime |
datetime | Time when the co-browsing started. |
CobrowseHistory.EndTime |
datetime | Time when the co-browsing ended. |
CobrowseHistory.VisitorId |
guid | Id of the visitor. |
CobrowseHistory.ChatId |
reference | Id of the chat. |
CobrowseHistory.AgentId |
reference | Id of the agent. |
CobrowseHistory.Agent.Id |
guid | Id of agent. |
CobrowseHistory.Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
CobrowseHistory.Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
CobrowseHistory.Agent.FirstName |
string | |
CobrowseHistory.Agent.LastName |
string | |
CobrowseHistory.Status |
int | Status of cobrowse history. Enum: 0: notCompleted, 1: completed. |
CobrowseHistory.SessionCode |
string | Session code of the co-browsing history. |
CobrowseHistory.Duration |
int | Duration of the co-browsing history. |
BotSentimentRecord.Id |
int | Id of the bot sentiment record. |
BotSentimentRecord.ChatId |
int | Id of the chat. |
BotSentimentRecord.VeryPositiveCount |
int | Count of Very Positive. |
BotSentimentRecord.PositiveCount |
int | Count of Positive. |
BotSentimentRecord.NetureCount |
int | Count of Neture. |
BotSentimentRecord.NegativeCount |
int | Count of Negative. |
BotSentimentRecord.VeryNegativeCount |
int | Count of Very Negative. |
ChatChatbotMap.BotId |
reference | |
ChatChatbotMap.Bot.Id |
guid | Id of the chatbot. |
ChatChatbotMap.Bot.Name |
string | Name of the chatbot. |
ChatChatbotMap.StartTime |
datetime | |
ChatChatbotMap.EndTime |
datetime | |
ChatChatbotMap.Duration |
int | |
ChatChatbotMap.ChatId |
reference | |
ChatChatbotMap.IsDeleted |
bool | |
ScreenSharingHistory.Id |
int | |
ScreenSharingHistory.StartTime |
datetime | |
ScreenSharingHistory.EndTime |
datetime | |
ScreenSharingHistory.RequestTime |
datetime | |
ScreenSharingHistory.ChatId |
reference | |
ScreenSharingHistory.AgentId |
reference | |
ScreenSharingHistory.Agent.Id |
guid | Id of agent. |
ScreenSharingHistory.Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
ScreenSharingHistory.Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
ScreenSharingHistory.Agent.FirstName |
string | |
ScreenSharingHistory.Agent.LastName |
string | |
ScreenSharingHistory.Status |
int | |
ScreenSharingHistory.RequestedBy |
int | |
ScreenSharingHistory.Duration |
int | |
ScreenSharingHistory.IsDeleted |
bool | |
ChatExtentions.ChatId |
reference | |
ChatExtentions.AnswerType |
int |
Cube OfflineMessage Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the offline message. |
Guid |
guid | Guid of the offline message. |
SessionId |
reference | Id of the session. |
Session.Id |
guid | Id of the session. |
Session.IP |
string | IP of the visitor. |
Session.ReferrerURL |
string | The rest part of the URL will be abandoned if the URL is too long. |
Session.Keywords |
string | Keywords of the visitor used to search for your website. |
Session.Browser |
string | Browser the visitor is using. |
Session.Language |
string | Language the visitor is using. |
Session.ScreenResolution |
string | Screen resolution of the visitor's device. |
Session.OperatorSystem |
string | Operating system of the visitor's device. |
Session.TimeZone |
12 | Time zone of the visitor. |
Session.LandingPageURL |
string | URL of the first page of your website the visitor visited. |
Session.LandingPageTitle |
string | Title of the first page of your website the visitor visited. |
Session.StartTime |
datetime | Time when the session started. |
Session.VisitorId |
guid | Id of the visitor. |
Session.ContactIdentityId |
guid | Id of the contact identity. |
Session.SearchEngineId |
guid | Id of the search engine the visitor used to search for your website. |
Session.City |
string | City of the visitor. |
Session.State |
string | State of the visitor. |
Session.CountryOrRegion |
string | Country or region of the visitor. |
Session.IsDeleted |
bool | Whether the session is deleted or not. |
CreatedTime |
datetime | Created time of the offline message. |
Name |
string | Name of the visitor. |
Email |
string | Email of the visitor. |
Phone |
string | Phone of the visitor. |
Company |
string | Company of the visitor. |
DepartmentId |
reference | Id of the department. |
Department.Id |
guid | Id of deparmtent. |
Department.Name |
string | Name of deparmtent. |
AgentId |
reference | Id of the agent. |
Agent.Id |
guid | Id of agent. |
Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
Agent.FirstName |
string | |
Agent.LastName |
string | |
Subject |
string | Subject of the offline message. |
Message |
string | Content of the offline message. |
RequestingPageTitle |
string | Request page title of the offline message. |
RequestingPageURL |
string | Request page URL of the offline message. |
Source |
smallInt | Source of offline message. Enum: 0: chatButton, 1: autoInvitation, 2: manualInvitation, 3: queue, 4: bot. |
CampaignId |
reference | Id of the campaign. |
Campaign.Id |
guid | Id of the campaign. |
Campaign.Name |
string | Name of the campaign. |
AutoInvitationId |
reference | Id of the autoinvitation. |
AutoInvitation.Id |
guid | Id of the auto invitation. |
AutoInvitation.Name |
string | Name of the auto invitation. |
AutoInvitation.IsEnabled |
string | Whether auto invitation is enabled or not. |
AutoInvitation.CampaignId |
reference | Id of the campaign. |
AutoInvitation.Campaign.Id |
guid | Id of the campaign. |
AutoInvitation.Campaign.Name |
string | Name of the campaign. |
TicketId |
int | Id of the ticket. |
AttachmentFileKey |
string | Attachment file key of the offline message. |
IsDeleted |
bool | Whether the offline message is deleted or not. |
AttachmentFileName |
string | Attachment file name of the offline message. |
VisitorId |
guid | Id of the visitor. |
ContactIdentityId |
guid | Id of the contact identity. |
ChatGuid |
guid | Guid of the chat. |
SkillId |
reference | |
Skill.Id |
guid | |
Skill.Name |
string | |
OfflineMessageFieldResult.Id |
int | Id of the offline message field result. |
OfflineMessageFieldResult.FormType |
smallInt | Form type of offline message field result. Enum: 0: preChat, 1: offlineMessage, 2: postChat, 3: wrapUp, 4: pciForm, 5: customVariable. |
OfflineMessageFieldResult.FieldId |
reference | Id of the field. |
OfflineMessageFieldResult.Field.Id |
guid | Id of the field. |
OfflineMessageFieldResult.Field.IsSystem |
string | Whether the field is system field or not. |
OfflineMessageFieldResult.Field.Name |
string | Name of the field. |
OfflineMessageFieldResult.Field.Type |
smallInt | Type of field. Enum: 1: text, 2: textArea, 3: radioBox, 4: checkBox, 5: dropdownList, 6: checkboxList, 7: nps, 8: attachment, 9: rating, 10: checkboxListOptionGroups, 301: category, 302: comment. |
OfflineMessageFieldResult.FieldName |
string | Name of the field. |
OfflineMessageFieldResult.Value |
string | Value of the offline message field result. |
OfflineMessageFieldResult.Url |
string | URL of the offline message field result. |
OfflineMessageFieldResult.OfflineMessageId |
reference | Id of the offline message. |
OfflineMessageFieldResult.IsDeleted |
bool | Whether the offline message field result is deleted or not. |
OfflineMessageSegmentResult.Id |
int | Id of the offline message segment result. |
OfflineMessageSegmentResult.SegmentId |
reference | Id of the segment. |
OfflineMessageSegmentResult.Segment.Id |
guid | Id of the segment. |
OfflineMessageSegmentResult.Segment.Name |
string | Name of the segment. |
OfflineMessageSegmentResult.Segment.IsEnabled |
string | Whether segment is enabled or not. |
OfflineMessageSegmentResult.LogTime |
datetime | Log time of the offline message segment result. |
OfflineMessageSegmentResult.OfflineMessageId |
reference | Id of the offline message. |
OfflineMessageSegmentResult.IsDeleted |
bool | Whether the offline message segment result is deleted or not. |
Cube AgentPrivateMessage Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the agent private message. |
Guid |
guid | Guid of the agent private message. |
FromAgentId |
reference | Id of the agent. |
FromAgent.Id |
guid | Id of agent. |
FromAgent.IsAdmin |
string | Whether the agent is an administrator or not. |
FromAgent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
FromAgent.FirstName |
string | |
FromAgent.LastName |
string | |
ToAgentId |
reference | Id of the agent. |
ToAgent.Id |
guid | Id of agent. |
ToAgent.IsAdmin |
string | Whether the agent is an administrator or not. |
ToAgent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
ToAgent.FirstName |
string | |
ToAgent.LastName |
string | |
Content |
string | Content of the agent private message. |
AttachmentFileKey |
string | Attachment file key of the agent private message. |
Time |
datetime | Time of the agent private message. |
IsDeleted |
bool | Whether the agent private message is deleted or not. |
Cube ManualInvitationLog Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the manual invitation log. |
AgentId |
reference | Id of the agent. |
Agent.Id |
guid | Id of agent. |
Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
Agent.FirstName |
string | |
Agent.LastName |
string | |
SentTime |
datetime | Send time of the manual invitation. |
Status |
smallInt | Status of manual invitation log. Enum: 0: sent, 1: accepted, 2: refused. |
Message |
string | The default manual invitation message. |
IsDeleted |
bool | Whether the manual invitation log is deleted or not. |
Cube AutoInvitationStatistics Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the auto invitation statistics. |
CampaignId |
reference | Id of the campaign. |
Campaign.Id |
guid | Id of the campaign. |
Campaign.Name |
string | Name of the campaign. |
AutoInvitationId |
reference | Id of the auto invitation. |
AutoInvitation.Id |
guid | Id of the auto invitation. |
AutoInvitation.Name |
string | Name of the auto invitation. |
AutoInvitation.IsEnabled |
string | Whether auto invitation is enabled or not. |
AutoInvitation.CampaignId |
reference | Id of the campaign. |
AutoInvitation.Campaign.Id |
guid | Id of the campaign. |
AutoInvitation.Campaign.Name |
string | Name of the campaign. |
SentNum |
int | The number of auto invitations sent to visitors. |
AcceptNum |
int | The number of auto invitations accepted by visitors. |
RefuseNum |
int | The number of auto invitations refused by visitors. |
LogTime |
datetime | Log time of the auto invitation statistics. |
IsDeleted |
bool | Whether the auto invitation statistics is deleted or not. |
Cube VisitsStatistics Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the visits statistics. |
CampaignId |
reference | Id of the campaign. |
Campaign.Id |
guid | Id of the campaign. |
Campaign.Name |
string | Name of the campaign. |
LogTime |
datetime | Log time of the visits statistics. |
VisitCount |
int | Visit count of the visits statistics. |
IsDeleted |
bool | Whether the visits statistics is deleted or not. |
Cube QueueStatistics Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the queue statistics. |
Type |
int | Type of queue statistics. Enum: 1: site, 2: department. |
DepartmentId |
reference | Id of the department. |
Department.Id |
guid | Id of deparmtent. |
Department.Name |
string | Name of deparmtent. |
QueueLength |
int | Queue length of the queue statistics. |
Time |
datetime | Time of the queue statistics. |
IsDeleted |
bool | Whether the queue statistics is deleted or not. |
Cube ConversionLog Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the conversion log. |
ConversionActionId |
reference | Id of the conversion action. |
ConversionAction.Id |
guid | Id of the conversion action. |
ConversionAction.IsEnabled |
string | Whether conversion action is enabled or not. |
ConversionAction.Name |
string | Name of the conversion action. |
DepartmentId |
reference | Id of the department. |
Department.Id |
guid | Id of deparmtent. |
Department.Name |
string | Name of deparmtent. |
AgentId |
reference | Id of the agent. |
Agent.Id |
guid | Id of agent. |
Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
Agent.FirstName |
string | |
Agent.LastName |
string | |
AppendInfo |
string | Append info of the conversion log. |
ConversionValue |
decimal | Value assigned for the conversion action. |
CreatedTime |
datetime | Created time of the conversion log. |
VisitorId |
guid | Id of the visitor. |
ChatGuid |
guid | Guid of the chat. |
IsDeleted |
bool | Whether the conversion log is deleted or not. |
Cube TransferLog Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the transfer log. |
ChatGuid |
guid | Guid of the chat. |
Time |
datetime | Time of the transfer log. |
TransferType |
smallInt | Transfer type of transfer log. Enum: 0: agent, 1: department. |
AgentId |
reference | Id of the agent. |
Agent.Id |
guid | Id of agent. |
Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
Agent.FirstName |
string | |
Agent.LastName |
string | |
FromAgentId |
reference | Id of the agent. |
FromAgent.Id |
guid | Id of agent. |
FromAgent.IsAdmin |
string | Whether the agent is an administrator or not. |
FromAgent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
FromAgent.FirstName |
string | |
FromAgent.LastName |
string | |
ToAgentId |
reference | Id of the agent. |
ToAgent.Id |
guid | Id of agent. |
ToAgent.IsAdmin |
string | Whether the agent is an administrator or not. |
ToAgent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
ToAgent.FirstName |
string | |
ToAgent.LastName |
string | |
FromDepartmentId |
reference | Id of the department. |
FromDepartment.Id |
guid | Id of deparmtent. |
FromDepartment.Name |
string | Name of deparmtent. |
ToDepartmentId |
reference | Id of the department. |
ToDepartment.Id |
guid | Id of deparmtent. |
ToDepartment.Name |
string | Name of deparmtent. |
IsDeleted |
bool | Whether the transfer log is deleted or not. |
FromSiteId |
int | |
ToSiteId |
int |
Cube ChatbotDetectIntentRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the chatbot detect intent record. |
ChatbotId |
reference | Id of the chatbot. |
Chatbot.Id |
guid | Id of the chatbot. |
Chatbot.Name |
string | Name of the chatbot. |
Question |
string | Question of the intent. |
ChannelId |
string | Id of the channel. |
ChatId |
guid | Id of the chat. |
ConversationId |
guid | Id of the conversion. |
IntentId |
reference | Id of the intent. |
Intent.Id |
guid | Id of the chatbot intent. |
Intent.Name |
string | Name of the chatbot intent. |
Intent.ChatbotIntentCategoryId |
reference | Id of the chatbot intent category. |
Intent.ChatbotIntentCategory.Id |
guid | Id of the chatbot intent category. |
Intent.ChatbotIntentCategory.Name |
string | Name of the chatbot intent category. |
Score |
decimal | Score of the intent. |
CampaignId |
reference | Id of the campaign. |
Campaign.Id |
guid | Id of the campaign. |
Campaign.Name |
string | Name of the campaign. |
ChannelAccountId |
guid | Id of the channel account. |
AnswerType |
smallInt | Type of the answer. |
SourceType |
smallInt | Type of the source. |
CreatedTime |
datetime | Time when the chatbot detect intent record was created. |
IsDeleted |
bool | Whether the chatbot detect intent record is deleted or not. |
ChatbotRatingRecord.Id |
guid | Id of the chatbot rating record. |
ChatbotRatingRecord.ChatbotDetectIntentRecordId |
reference | Id of the chatbot detect intent record. |
ChatbotRatingRecord.RateType |
smallInt | Type of the chatbot rating. |
ChatbotRatingRecord.IsDeleted |
bool | Whether the chatbot rating record is deleted or not. |
Cube QueueLog Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the queue log. |
DepartmentId |
reference | Id of the department. |
Department.Id |
guid | Id of deparmtent. |
Department.Name |
string | Name of deparmtent. |
NumberOfQueue |
int | The number of queue. |
LogTime |
datetime | Log time of the queue log. |
Cube CannedMessageUseRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of canned message usage record. |
CreatedTime |
datetime | Time when the canned message usage record was created. |
CannedMessageId |
reference | Id of canned message. |
CannedMessage.Id |
guid | Id of public canned message. |
CannedMessage.Name |
string | Name of public canned message. |
CannedMessage.CategoryId |
reference | Id of public canned message category. |
CannedMessage.Category.Id |
guid | Id of public canned message category. |
CannedMessage.Category.Name |
string | Name of public canned message category. |
AgentId |
reference | Id of agent. |
Agent.Id |
guid | Id of agent. |
Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
Agent.FirstName |
string | |
Agent.LastName |
string | |
TicketId |
int | Id of ticket. |
ModuleId |
string | Id of module. |
ChatId |
guid | Id of chat. |
IsDeleted |
bool | Whether the canned message useage record is deleted or not. |
Cube AgentLoginRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of agent login record. |
AgentId |
reference | Id of agent. |
Agent.Id |
guid | Id of agent. |
Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
Agent.FirstName |
string | |
Agent.LastName |
string | |
LoginIp |
decimal | IP of the logged-in agent. |
LoginTime |
datetime | Time When the agent is logging. |
IsDeleted |
bool | Whether the agent login record is deleted or not. |
Cube VisitorLoginRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the visitor login record. |
VisitorId |
guid | Id of the visitor. |
LoginIp |
decimal | IP of the logged-in vistor. |
LoginTime |
datetime | Time When the vistor is logging. |
IsDeleted |
bool | Whether the vistor login record is deleted or not. |
Cube TaskbotTriggerRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the taskbot trigger record. |
TaskbotId |
reference | Id of the taskbot. |
Taskbot.Id |
guid | Id of the taskbot. |
Taskbot.Name |
string | Name of the taskbot. |
TaskbotVersionId |
guid | Version id of the taskbot. |
ChatId |
guid | Id of the chat. |
TriggerByType |
smallInt | Type of the trigger by. |
TriggerBy |
guid | Id of the trigger by. |
StartTime |
datetime | Start time of the time range. |
IsDeleted |
bool | Whether the taskbot trigger record is deleted or not. |
TaskbotActionRecord.Id |
guid | Id of the taskbot action record. |
TaskbotActionRecord.TaskbotTriggerRecordId |
reference | Id of the taskbot trigger record. |
TaskbotActionRecord.TaskbotActionId |
guid | Id of the taskbot action. |
TaskbotActionRecord.TriggeredTime |
datetime | Time when the taskbot action was triggered. |
TaskbotActionRecord.Path |
string | Path of the taskbot action record. |
TaskbotActionRecord.IsDeleted |
bool | Whether the taskbot action record is deleted or not. |
TaskbotEndRecord.Id |
guid | Id of the taskbot end record. |
TaskbotEndRecord.TaskbotTriggerRecordId |
reference | Id of the taskbot trigger record. |
TaskbotEndRecord.EndTime |
datetime | Time when the taskbot end record. |
TaskbotEndRecord.EndType |
smallInt | Type of the taskbot end record. |
TaskbotEndRecord.IsDeleted |
bool | Whether the taskbot end record is deleted or not. |
Cube ChatbotActionRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the chatbot action record. |
ChatbotId |
reference | Id of the chatbot. |
Chatbot.Id |
guid | Id of the chatbot. |
Chatbot.Name |
string | Name of the chatbot. |
ChannelId |
string | Id of the channel. |
IsDeleted |
bool | Whether the chatbot action record is deleted or not. |
CreatedTime |
datetime | Time when the chatbot action record was created. |
Cube SentimentRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the sentiment record. |
IsDeleted |
bool | Whether the sentiment record is deleted or not. |
SentimentType |
smallInt | Type of the sentiment. Allowed values are "Very nagative", "Negative", "Neutral", "Positive", "Very positive" |
ChannelId |
string | Id of the channel. |
ChatId |
guid | Id of the chat. |
MessageGuid |
guid | Id of the message. |
SentimentScore |
int | Score of the sentiment. |
Cube VoicebotDetectIntentRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the voicebot detect intent record. |
VoicebotId |
reference | Id of the voicebot. |
Voicebot.Id |
guid | Id of the voicebot. |
Voicebot.Name |
string | Name of the voicebot. |
Question |
string | Question of the intent. |
IntentId |
reference | Id of the intent. |
Intent.Id |
guid | Id of the voicebot intent. |
Intent.Name |
string | Name of the voicebot intent. |
Intent.VoicebotIntentCategoryId |
reference | Id of the voicebot intent category. |
Intent.VoicebotIntentCategory.Id |
guid | Id of the voicebot intent category. |
Intent.VoicebotIntentCategory.Name |
string | Name of the voicebot intent category. |
Score |
decimal | Score of the intent. |
AnswerType |
smallInt | Type of the answer. |
CreatedTime |
datetime | Time when the voicebot detect intent record was created. |
IsDeleted |
bool | Whether the voicebot detect intent record is deleted or not. |
Cube TaskbotCollectFeedbackRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | |
TaskbotId |
reference | |
Taskbot.Id |
guid | Id of the taskbot. |
Taskbot.Name |
string | Name of the taskbot. |
ChatId |
guid | |
TaskbotActionId |
guid | |
FeedbackType |
smallInt | |
CreatedTime |
datetime | |
IsDeleted |
bool |
Cube QueueSession Fields:
Name | Type | Description |
---|---|---|
Id |
guid | |
QueueId |
reference | |
Queue.Id |
guid | |
Queue.Name |
string | |
Queue.LocationId |
reference | |
Queue.Location.Id |
guid | |
Queue.Location.Name |
string | |
ServiceAgentId |
reference | |
ServiceAgent.Id |
guid | Id of agent. |
ServiceAgent.IsAdmin |
string | Whether the agent is an administrator or not. |
ServiceAgent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
ServiceAgent.FirstName |
string | |
ServiceAgent.LastName |
string | |
Status |
smallInt | |
TimeFromCreatedToArrived |
timespan | |
TimeFromArrivedToEnded |
timespan | |
TimeFromCreatedToSummoned |
timespan | |
TimeFromSummonedToArrived |
timespan | |
OriginalEstimatedWaitingTime |
timespan | |
CreatedTime |
datetime | |
SummonedTime |
datetime | |
ArrivedTime |
datetime | |
NoShowTime |
datetime | |
EndedTime |
datetime | |
IsDeleted |
bool | |
IsSummoned |
bool | |
ServiceType |
string |
Cube ChatbotGenerativeAnswersTriggerRecord Fields:
Name | Type | Description |
---|---|---|
Id |
guid | |
ChatId |
guid | |
ChatbotId |
reference | |
Chatbot.Id |
guid | Id of the chatbot. |
Chatbot.Name |
string | Name of the chatbot. |
ChannelId |
string | |
LlmEngineId |
guid | |
SentTokens |
int | |
ReceivedTokens |
int | |
AnswerResult |
smallInt | |
TriggeredTime |
datetime | |
IsDeleted |
bool | |
ChatbotPromptCompletionRecord.ChatbotGenerativeAnswersTriggerRecordId |
reference | |
ChatbotPromptCompletionRecord.Prompt |
string | |
ChatbotPromptCompletionRecord.Completion |
string | |
ChatbotPromptCompletionRecord.IsDeleted |
bool | |
ChatbotPromptCompletionRecord.StandaloneQuestionPrompt |
string | |
ChatbotPromptCompletionRecord.StandaloneQuestions |
string |
Cube Ticket Fields:
Name | Type | Description |
---|---|---|
Id |
int | Id of the ticket. |
ReplyingAgent |
smallInt | Indicates what type of response the ticket has. Allowed values are "noReply", "agentOnly", "botOnly", "agentAndBot". |
CreatedTime |
datetime | Time when the ticket was created. |
AssigneeId |
reference | Id of agent or chatbot that the ticket is assigned to. |
AssigneeAgent.Id |
guid | Id of agent. |
AssigneeAgent.IsAdmin |
string | Whether the agent is an administrator or not. |
AssigneeAgent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
AssigneeAgent.FirstName |
string | |
AssigneeAgent.LastName |
string | |
AssigneeChatbot.Id |
guid | Id of the chatbot. |
AssigneeChatbot.Name |
string | Name of the chatbot. |
Status |
smallInt | Status of the ticket. Enum: 0: New. 1: Pending Internal. 2: Pending External. 3: On Hold. 4: Resolved. |
AssigneeType |
smallInt | Type of the ticket assignee. Enum: 1: Agent. 5: Chatbot. |
ResolvedTime |
datetime | Resloved time of the ticket. |
MergedToTargetId |
int | Id of the ticket that it was merged to. |
DepartmentAssigneeId |
reference | Id of department that the ticket is assigned to. |
DepartmentAssignee.Id |
guid | Id of deparmtent. |
DepartmentAssignee.Name |
string | Name of deparmtent. |
ChannelId |
reference | Id of the channel of the first message of the ticket. |
Channel.Id |
string | Id of the channel. |
Channel.Name |
string | Name of the channel. |
ChannelAccountId |
reference | Id of the channel account of the first message of the ticket. |
ChannelAccount.Id |
guid | Id of the channel account. |
ChannelAccount.Name |
string | Name of the channel account. |
ChannelAccount.AppId |
string | Id of the channel app which the channel account belongs to. Allowed values are "Email","Facebook","Facebook","Twitter","WeChat","WeChat","WhatsApp" exc. |
ReopenedTime |
datetime | Time when the resolved ticket was reopened. |
IsInRecycleBin |
bool | Whether the ticket is in recyle bin or not. |
Priority |
smallInt | Priority of the ticket. Enum: 1: Urgent. 2: High. 3: Normal. 4: Low. |
FirstResponseTimeSpan |
timespan | Time it took for the agent to send the first response after a ticket is created. |
ResponseTimeSpan |
timespan | Total amount of time the status of the ticket was pending internal. |
ResponseCount |
int | Number of replies. |
ResolvedTimeSpan |
timespan | Total time it took to resolve the ticket. |
LastMessageChannelId |
reference | |
LastMessageChannel.Id |
string | Id of the channel. |
LastMessageChannel.Name |
string | Name of the channel. |
LastMessageChannelAccountId |
reference | |
LastMessageChannelAccount.Id |
guid | Id of the channel account. |
LastMessageChannelAccount.Name |
string | Name of the channel account. |
LastMessageChannelAccount.AppId |
string | Id of the channel app which the channel account belongs to. Allowed values are "Email","Facebook","Facebook","Twitter","WeChat","WeChat","WhatsApp" exc. |
LastUpdatedTime |
datetime | |
LastStatusChangedTime |
datetime | |
LastRepliedTime |
datetime | |
Message.Id |
guid | Id of the message. |
Message.TicketId |
reference | Id of the ticket which the message belongs to. |
Message.SentByType |
smallInt | Role of the sender. Enum: 1:Agent. 3:Contact. 4:Visitor. 5: Chatbot. 6: ChannelAccount. 7: System. |
Message.ChannelId |
guid | Name of the message channel. |
Message.Time |
datetime | Time when the message was created. |
Message.IsInternal |
bool | |
TicketSLA.Id |
guid | Id of the SLA. |
TicketSLA.TicketId |
reference | Id of the ticket which the SLA belongs to. |
TicketSLA.SlaPolicyId |
reference | Id of the SLA Policy. |
TicketSLA.SlaPolicy.Id |
guid | Id of the SLA Policy. |
TicketSLA.SlaPolicy.Name |
string | Name of the SLA Policy. |
TicketSLA.FirstRespondBreachStatus |
smallInt | Breach status for first response. Enum: 0: Agent didn't take action(reply or resolve), and didn't breach the sla policy. 1:Agent has taken action, and didn't breach the sla policy. 2: Agent didn't take action, and has breached the sla policy. 3: Agent has taken action, and has breached the sla policy. 4: Agent has taken action, but ignore the breach status. |
TicketSLA.FirstRespondDuration |
timespan | How long does it take the first response to be sent. |
TicketSLA.NextRespondBreachCount |
int | Number of tickets whose next responses were sent within the SLA. |
TicketSLA.NextRespondCount |
int | Number of tickets whose next responses breach the SLA. |
TicketSLA.NextRespondDuration |
timespan | How long does it take the next response to be sent. |
TicketSLA.NextRespondBreachStatus |
smallInt | Breach status for next response. Enum: 0: Agent didn't take action(reply or resolve), and didn't breach the sla policy. 1:Agent has taken action, and didn't breach the sla policy. 2: Agent didn't take action, and has breached the sla policy. 3: Agent has taken action, and has breached the sla policy. 4: Agent has taken action, but ignore the breach status. |
TicketSLA.ResolveTimeBreachStatus |
smallInt | Breach status for resolving. Enum: 0: Agent didn't take action(reply or resolve), and didn't breach the sla policy. 1:Agent has taken action, and didn't breach the sla policy. 2: Agent didn't take action, and has breached the sla policy. 3: Agent has taken action, and has breached the sla policy. 4: Agent has taken action, but ignore the breach status. |
TicketSLA.ResolvedDuration |
timespan | How long does it take a ticket to be resolved. |
TicketTagRelation.TicketId |
reference | |
TicketTagRelation.TagId |
reference | |
TicketTagRelation.Tag.Id |
guid | Id of the voicebot. |
TicketTagRelation.Tag.Name |
string | Name of the voicebot. |
Cube Message Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the message. |
TicketId |
int | Id of the ticket which the message belongs to. |
SentByType |
smallInt | Role of the sender. Enum: 1:Agent. 3:Contact. 4:Visitor. 5: Chatbot. 6: ChannelAccount. 7: System. |
Time |
datetime | Time when the message was created. |
IsInternal |
bool |
Cube TicketSLA Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the SLA. |
TicketId |
int | Id of the ticket which the SLA belongs to. |
SlaPolicyId |
reference | Id of the SLA Policy. |
SlaPolicy.Id |
guid | Id of the SLA Policy. |
SlaPolicy.Name |
string | Name of the SLA Policy. |
FirstRespondBreachStatus |
smallInt | Breach status for first response. Enum: 0: Agent didn't take action(reply or resolve), and didn't breach the sla policy. 1:Agent has taken action, and didn't breach the sla policy. 2: Agent didn't take action, and has breached the sla policy. 3: Agent has taken action, and has breached the sla policy. 4: Agent has taken action, but ignore the breach status. |
FirstRespondDuration |
timespan | How long does it take the first response to be sent. |
NextRespondBreachCount |
int | Number of tickets whose next responses were sent within the SLA. |
NextRespondCount |
int | Number of tickets whose next responses breach the SLA. |
NextRespondDuration |
timespan | How long does it take the next response to be sent. |
NextRespondBreachStatus |
smallInt | Breach status for next response. Enum: 0: Agent didn't take action(reply or resolve), and didn't breach the sla policy. 1:Agent has taken action, and didn't breach the sla policy. 2: Agent didn't take action, and has breached the sla policy. 3: Agent has taken action, and has breached the sla policy. 4: Agent has taken action, but ignore the breach status. |
ResolveTimeBreachStatus |
smallInt | Breach status for resolving. Enum: 0: Agent didn't take action(reply or resolve), and didn't breach the sla policy. 1:Agent has taken action, and didn't breach the sla policy. 2: Agent didn't take action, and has breached the sla policy. 3: Agent has taken action, and has breached the sla policy. 4: Agent has taken action, but ignore the breach status. |
ResolvedDuration |
timespan | How long does it take a ticket to be resolved. |
Cube TaskbotCollectedInfo Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the current item. |
TaskbotId |
reference | Id of the taskbot. |
Taskbot.Id |
guid | Id of the taskbot. |
Taskbot.Name |
string | Name of the taskbot. |
CreatedTime |
datetime | Time of the current item created. |
ChatbotId |
reference | |
Chatbot.Id |
guid | Id of the chatbot. |
Chatbot.Name |
string | Name of the chatbot. |
BotType |
smallInt |
Cube TaskbotBookedCalendlyMeeting Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the current Calendly Meeting. |
TaskbotId |
reference | Id of the taskbot. |
Taskbot.Id |
guid | Id of the taskbot. |
Taskbot.Name |
string | Name of the taskbot. |
MeetingBookedTime |
datetime | Time of the meeting booked. |
BotType |
smallInt | |
ChatbotId |
reference | |
Chatbot.Id |
guid | Id of the chatbot. |
Chatbot.Name |
string | Name of the chatbot. |
Cube VoicebotCallLog Fields:
Name | Type | Description |
---|---|---|
Id |
guid | |
VoicebotId |
reference | |
Voicebot.Id |
guid | Id of the voicebot. |
Voicebot.Name |
string | Name of the voicebot. |
StartTime |
datetime | |
Status |
smallInt | |
CallDuration |
int | |
ConcurrencyNum |
int |
Cube AgentStatusLog Fields:
Name | Type | Description |
---|---|---|
Id |
guid | Id of the agent status log. |
AgentId |
reference | Id of the agent. |
Agent.Id |
guid | Id of agent. |
Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
Agent.FirstName |
string | |
Agent.LastName |
string | |
DepartmentId |
reference | Id of the department. |
Department.Id |
guid | Id of deparmtent. |
Department.Name |
string | Name of deparmtent. |
StartTime |
datetime | Time when the agent status started. |
EndTime |
datetime | Time when the agent status ended. |
Status |
string | Allowed values are "online", "away" "offline". |
CustomAwayId |
guid | Id of the custom away satus. |
IfStatusEnd |
bool | Whether the status is ended or not. |
LoggedIn |
int | Total logged-in time of the agent. |
Online |
int | Total online time of the agent. |
Away |
int | Total away time of the agent. |
Duration |
int | Duration of the agent status log. |
DepartmentAgentRelation.DepartmentId |
reference | Id of the department. |
DepartmentAgentRelation.Department.Id |
guid | Id of deparmtent. |
DepartmentAgentRelation.Department.Name |
string | Name of deparmtent. |
DepartmentAgentRelation.AgentId |
reference | Id of the agent. |
DepartmentAgentRelation.Agent.Id |
guid | Id of agent. |
DepartmentAgentRelation.Agent.IsAdmin |
string | Whether the agent is an administrator or not. |
DepartmentAgentRelation.Agent.DisplayName |
string | Different Agents can have the same Display Name. If not display name given, will be set by both first name and last name. |
DepartmentAgentRelation.Agent.FirstName |
string | |
DepartmentAgentRelation.Agent.LastName |
string |