--- title: "Cube" slug: "server-api-reporting-cube" updated: 2022-12-01T09:08:11Z published: 2022-12-01T09:08:11Z canonical: "developer.comm100.com/server-api-reporting-cube" --- > ## Documentation Index > Fetch the complete documentation index at: https://developer.comm100.com/llms.txt > Use this file to discover all available pages before exploring further. # Cube ## Cube 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 JSON Format Cube is represented as simple flat JSON objects with the following keys: | Name | Type | Description | | --- | --- | --- | | !`name` | string | Name of this cube | | `fields` | [field[]](/docs/server-api-reporting-cube#FieldModel) | 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 With Fields List ### 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` | smallInt | 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 | Allowed values are "normal", "refused", "missed", "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 | Allowed values are "chatButton", "autoInvitation", "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 | Allowed values are "none", "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` | int | 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` | int | Waiting time of the chat. | | `Duration` | int | 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 | Allowed values are "visitor", "agent", "chatBot", "system". | | `BotId` | reference | Id of the bot. | | `Bot.Id` | guid | Id of the chatbot. | | `Bot.Name` | string | Name of the chatbot. | | `ChatType` | smallInt | Allowed values are "agentOnly", "chatBotOnly", "fromBotToAgent", "fromBotToOfflineMessage", "waitingToOfflineMessage", "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 | Id of the skill. | | `Skill.Name` | string | Name of the visitor. | | `PreviousScript` | string | | | `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 | First name of the agent. | | `ChatWrapup.Agent.LastName` | string | Last name of the agent. | | `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 | First name of the agent. | | `ChatAgent.Agent.LastName` | string | Last name of the agent. | | `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 | Allowed values are "preChat", "offlineMessage", "postChat", "wrapUp", "pciForm", "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 | Allowed values are "text", "textArea", "radioBox", "checkBox", "dropdownList", "checkboxList", "nps", "attachment", "rating", "checkboxListOptionGroups", "category", "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.Status` | int | Allowed values are "notCompleted", "completed". | | `CobrowseHistory.SessionCode` | string | Session code of the co-browsing history. | | `CobrowseHistory.Duration` | int | | | `BotSentimentRecord.Id` | int | | | `BotSentimentRecord.ChatId` | int | | | `BotSentimentRecord.VeryPositiveCount` | int | | | `BotSentimentRecord.PositiveCount` | int | | | `BotSentimentRecord.NetureCount` | int | | | `BotSentimentRecord.NegativeCount` | int | | | `BotSentimentRecord.VeryNegativeCount` | int | | | `ChatChatbotMap.BotId` | reference | | | `ChatChatbotMap.Bot.Id` | guid | | | `ChatChatbotMap.Bot.Name` | string | | | `ChatChatbotMap.StartTime` | datetime | | | `ChatChatbotMap.EndTime` | datetime | | | `ChatChatbotMap.Duration` | int | | | `ChatChatbotMap.ChatId` | reference | | | `ChatChatbotMap.IsDeleted` | bool | | ### 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` | smallInt | 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 | First name of the agent. | | `Agent.LastName` | string | Last name of the agent. | | `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 | Allowed values are "chatButton", "autoInvitation", "manualInvitation", "bot", "queue". | | `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 | Id of the skill. | | `Skill.Name` | string | Name of the visitor. | | `OfflineMessageFieldResult.Id` | int | Id of the offline message field result. | | `OfflineMessageFieldResult.FormType` | smallInt | Allowed values are "preChat", "offlineMessage", "postChat", "wrapUp", "pciForm", "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 | Allowed values are "text", "textArea", "radioBox", "checkBox", "dropdownList", "checkboxList", "nps", "attachment", "rating", "checkboxListOptionGroups", "category", "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. | | `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 | First name of the agent. | | `FromAgent.LastName` | string | Last name of the agent. | | `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 | First name of the agent. | | `ToAgent.LastName` | string | Last name of the agent. | | `Content` | string | Conente of the message. | | `AttachmentFileKey` | string | | | `Time` | string | | | `IsDeleted` | bool | Whether the transfer log 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 | First name of the agent. | | `Agent.LastName` | string | Last name of the agent. | | `SentTime` | datetime | Send time of the manual invitation. | | `Status` | smallInt | Allowed values are "sent", "accepted","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 | Allowed values are "site", "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 | First name of the agent. | | `Agent.LastName` | string | Last name of the agent. | | `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 | Allowed values are "agent", "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 | First name of the agent. | | `Agent.LastName` | string | Last name of the agent. | | `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 | First name of the agent. | | `FromAgent.LastName` | string | Last name of the agent. | | `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 | First name of the agent. | | `ToAgent.LastName` | string | Last name of the agent. | | `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. | ### 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 | First name of the agent. | | `Agent.LastName` | string | Last name of the agent. | | `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 | First name of the agent. | | `Agent.LastName` | string | Last name of the agent. | | `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 | | | `ChatbotId` | reference | | | `Chatbot.Id` | guid | Id of the chatbot. | | `Chatbot.Name` | string | Name of the chatbot. | | `ChannelId` | string | | | `IsDeleted` | bool | | | `CreatedTime` | datetime | | ### Cube SentimentRecord Fields: | Name | Type | Description | | --- | --- | --- | | `Id` | guid | | | `IsDeleted` | bool | | | `SentimentType` | smallInt | | | `ChannelId` | string | | | `ChatId` | guid | | | `MessageGuid` | guid | | | `SentimentScore` | int | | ### Cube VoicebotDetectIntentRecord Fields: | Name | Type | Description | | --- | --- | --- | | `Id` | guid | | | `VoicebotId` | reference | | | `Voicebot.Id` | guid | | | `Voicebot.Name` | string | | | `Question` | string | | | `IntentId` | reference | | | `Intent.Id` | guid | | | `Intent.Name` | string | | | `Intent.VoicebotIntentCategoryId` | reference | | | `Intent.VoicebotIntentCategory.Id` | guid | | | `Intent.VoicebotIntentCategory.Name` | string | | | `Score` | decimal | | | `AnswerType` | smallint | | | `CreatedTime` | datetime | | | `IsDeleted` | bool | | ### 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.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 | First name of the agent. | | `AssigneeAgent.LastName` | string | Last name of the agent. | | `AssigneeChatbotId` | reference | | | `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` | int | Time it took for the agent to send the first response after a ticket is created. | | `ResponseTimeSpan` | int | Total amount of time the status of the ticket was pending internal. | | `ResponseCount` | int | Number of replies. | | `ResolvedTimeSpan` | int | Total time it took to resolve the ticket. | | `LastMessageChannelId` | reference | | | `LastMessageChannel.Id` | string | Id of the last message channel. | | `LastMessageChannel.Name` | string | Name of the last message channel. | | `LastMessageChannelAccountId` | reference | | | `LastMessageChannelAccount.Id` | guid | Id of the last message channel account. | | `LastMessageChannelAccount.Name` | string | Name of the last message channel account. | | `LastMessageChannelAccount.AppId` | string | App id of the last message channel account. | | `LastUpdatedTime` | datetime | Last time of the ticket update. | | `LastStatusChangedTime` | datetime | Last time of the ticket change status. | | `LastRepliedTime` | datetime | Last time of the ticket relied. | | `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. | | `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` | int | 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` | int | 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` | int | How long does it take a ticket to be resolved. | | `TicketTagRelation.TicketId` | reference | | | `TicketTagRelation.TagId` | reference | | | `TicketTagRelation.Tag.Id` | int | Id of tag. | | `TicketTagRelation.Tag.Name` | int | Name of tag. | ### 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. | ### 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` | int | 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` | int | 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` | int | 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 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.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 | First name of the agent. | | `Agent.LastName` | string | Last name of the agent. | | `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. | | `Status` | guid | Allowed values are "online", "away" "chat". | | `CustomAwayId` | guid | Id of the custom away satus. | | `LoggedInTime` | timespan | Total logged-in time of the agent. | | `LinearChatTime` | timespan | Total linear chat time of the agent. | | `OnlineTime` | timespan | Total online time of the agent. | | `AwayTime` | timespan | Total away time of the agent. | | `IdleTime` | timespan | Total idle time of the agent. | | `DepartmentAgentRelation.DepartmentId` | reference | Id of the department. | | `DepartmentAgentRelation.AgentId` | reference | Id of the agent. |