Comm100

Name	Type	Description
`total`	object	A key-value dictionary based on query, the keys is comes from cube query entity's fields
`series`	object[]	A array of dictionary based on query, the data of this array is obtained by dividing all the data according to the row group. For example, the value in the row group is department, then each item of data in this array is obtained according to a different department

Name	Type	Required	Description
`cubeEntities`	cubeQueryModel[]	yes	Reference to Cube Query Entity
`mergeType`	string	yes	Allowed values are "column", "row", "rowToColumn"
`timezone`	double	yes	Offset of the time, Based on UTC

Name	Type	Description
`name`	string	Name of the cube query
`fields`	fieldModel[]	Reference to Field
`rowGroups`	rowGroupModel[]	Reference to Row Group
`filters`	filterModel[]	Reference to Filter
`timezone`	string	Offset of the time, Based on UTC

Name	Type	Description
`name`	string	Name of the field
`calculationType`	string	Allowed values are "count", "max", "average", "sum", "expression", "originalValue", "uniqueCount"
`valueType`	string	Allowed values are "int", "decimal", "percent", "timespan", "string"
`expression`	string	For some fields that need to be calculated using other fields, we can configure the evaluation expression. We can use "+-*/" and "()"
`fieldName`	string	Corresponding to the field name in cube entity
`conditionExpression`	string	For more complex query conditions, we can configure condition expression that refer to the name of the above condition. Here we can use logical operators such as "()", "&", "\|"
`conditions`	fieldConditionModel[]	Reference to Field Condition

Name	Type	Description
`name`	string	Name of the field condition
`fieldName`	string	Name of the field, point to the field used for get data based on condition, only data that meets the conditions will be counted in the results
`operate`	string	Allowed values are "equals", "notEquals"
`values`	string[]	Array of values used as conditions

Name	Type	Description
`name`	string	Name of the row group
`fieldName`	string	Name of the field, point to the field used for group data
`isFull`	bool	The field corresponding to fieldName, if its type is reference, decide whether to return all possible values of that field according to the value of isFull, regardless of whether the group corresponding to that value has data
`timeDisplayType`	string	Allowed values are "hour", "day", "week", "month", "_24x7", "halfHour"

Name	Type	Description
`fieldName`	string	Name of the field, point to the field used for filter data, used to obtain part of the data according to specific conditions, such as a certain agent, a certain department, a certain period of time data
`matchType`	string	Allowed values are "equals", "notEquals", "between", "lessThan", "greaterThan"
`value`	string[]	Array of values to filter data

Provides the number of visits and chats (including refused and missed chats) within a specific time period.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"chats","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"Status0","conditions":[{"name":"Status0","fieldName":"Status","operate":"equals","values":["0"]}]},{"name":"missedChats","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"missedChatStatus","conditions":[{"name":"missedChatStatus","fieldName":"Status","operate":"equals","values":["2","3"]}]},{"name":"refusedChats","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"refusedChatStatus","conditions":[{"name":"refusedChatStatus","fieldName":"Status","operate":"equals","values":["1"]}]},{"name":"chatRequests","calculationType":"expression","valueType":"int","expression":"chats + missedChats + refusedChats","fieldName":"","conditionExpression":"","conditions":[]},{"name":"chatAcceptanceRate","calculationType":"expression","valueType":"percent","expression":"chats / chatRequests","fieldName":"","conditionExpression":"","conditions":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/03/25","2021/04/23"]}]},{"name":"VisitsStatistics","fields":[{"name":"visits","calculationType":"sum","valueType":"int","expression":"","fieldName":"VisitCount","conditionExpression":"","conditions":[]}],"rowGroups":[{"name":"time","fieldName":"LogTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"LogTime","matchType":"between","value":["2021/03/25","2021/04/23"]}]}],"mergeType":"column","timezone":-420}'

Response:

HTTP/1.1 200 OK

Real time details.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Ticket","fields":[{"name":"unassignedTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"AssigneeId","conditionExpression":"noAgent & noDepartment & MergedToTargetId0","conditions":[{"name":"noAgent","fieldName":"AssigneeId","operate":"equals","values":["00000000-0000-0000-0000-000000000000"]},{"name":"noDepartment","fieldName":"DepartmentAssigneeId","operate":"equals","values":["00000000-0000-0000-0000-000000000000"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]},{"name":"openTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Id","conditionExpression":"notResolved & MergedToTargetId0","conditions":[{"name":"notResolved","fieldName":"Status","operate":"notEquals","values":["5"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]},{"name":"newTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Id","conditionExpression":"Status1 & MergedToTargetId0","conditions":[{"name":"Status1","fieldName":"Status","operate":"equals","values":["1"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]},{"name":"pendingInternalTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Id","conditionExpression":"Status2 & MergedToTargetId0","conditions":[{"name":"Status2","fieldName":"Status","operate":"equals","values":["2"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]},{"name":"pendingExternalTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Id","conditionExpression":"Status3 & MergedToTargetId0","conditions":[{"name":"Status3","fieldName":"Status","operate":"equals","values":["3"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]},{"name":"onHoldTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Id","conditionExpression":"Status4 & MergedToTargetId0","conditions":[{"name":"Status4","fieldName":"Status","operate":"equals","values":["4"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]},{"name":"urgentTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Priority","conditionExpression":"Status1 & MergedToTargetId0","conditions":[{"name":"Status1","fieldName":"Priority","operate":"equals","values":["1"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]},{"name":"highPriorityTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Priority","conditionExpression":"Status2 & MergedToTargetId0","conditions":[{"name":"Status2","fieldName":"Priority","operate":"equals","values":["2"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]}],"rowGroups":[],"filters":[{"fieldName":"CreatedTime","matchType":"lessThan","value":["2021/05/31"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]},{"name":"Ticket","fields":[{"name":"todayCreatedTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Id","conditionExpression":"MergedToTargetId0","conditions":[{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]}],"rowGroups":[],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/05/30","2021/05/30"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]},{"name":"Ticket","fields":[{"name":"todayResolvedTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Id","conditionExpression":"MergedToTargetId0","conditions":[{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]}],"rowGroups":[],"filters":[{"fieldName":"ResolvedTime","matchType":"between","value":["2021/05/30","2021/05/30"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]},{"name":"Ticket","fields":[{"name":"todayRepliedTickets","valueType":"int","expression":"","calculationType":"uniqueCount","fieldName":"Id","conditionExpression":"SentByType1 & MergedToTargetId0","conditions":[{"name":"SentByType1","fieldName":"Message.SentByType","operate":"equals","values":["1"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]}],"rowGroups":[],"filters":[{"fieldName":"Message.Time","matchType":"between","value":["2021/05/30","2021/05/30"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]},{"name":"Ticket","fields":[{"name":"todayReopenedTickets","valueType":"int","expression":"","calculationType":"count","fieldName":"Id","conditionExpression":"MergedToTargetId0","conditions":[{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}]}],"rowGroups":[],"filters":[{"fieldName":"ReopenedTime","matchType":"between","value":["2021/05/30","2021/05/30"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]}],"timezone":-420,"mergeType":"column"}'

Response:

HTTP/1.1 200 OK

Volume details by day.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Ticket","fields":[{"name":"openTickets","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"Status!5 & MergedToTargetId0","conditions":[{"name":"Status!5","fieldName":"Status","operate":"notEquals","values":["5"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"createdTickets","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"MergedToTargetId0","conditions":[{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"CreatedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/05/29","2021/05/29"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]},{"name":"Ticket","fields":[{"name":"resolvedTickets","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"MergedToTargetId0","conditions":[{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"ResolvedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"ResolvedTime","matchType":"between","value":["2021/05/29","2021/05/29"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]},{"name":"Ticket","fields":[{"name":"reopenedTickets","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"MergedToTargetId0","conditions":[{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"ReopenedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"ReopenedTime","matchType":"between","value":["2021/05/29","2021/05/29"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]},{"name":"Ticket","fields":[{"name":"repliedTickets","calculationType":"uniqueCount","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"MergedToTargetId0 & SentByType1","conditions":[{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]},{"name":"SentByType1","fieldName":"Message.SentByType","operate":"equals","values":["1"]}],"enumItems":[]},{"name":"visitorMessages","calculationType":"count","valueType":"int","expression":"","fieldName":"Message.SentByType","conditionExpression":"(SentByType3|SentByType4)&MergedToTargetId0","conditions":[{"name":"SentByType3","fieldName":"Message.SentByType","operate":"equals","values":["3"]},{"name":"SentByType4","fieldName":"Message.SentByType","operate":"equals","values":["4"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"agentMessages","calculationType":"count","valueType":"int","expression":"","fieldName":"Message.SentByType","conditionExpression":"SentByType&MergedToTargetId0","conditions":[{"name":"SentByType","fieldName":"Message.SentByType","operate":"equals","values":["1","5"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"Message.Time","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"Message.Time","matchType":"between","value":["2021/05/29","2021/05/29"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]}],"mergeType":"column","timezone":-420}'

Response:

HTTP/1.1 200 OK

Channel details by day.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Ticket","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"email","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelIdEmail","conditions":[{"name":"ChannelIdEmail","fieldName":"ChannelId","operate":"equals","values":["Email"]}],"enumItems":[]},{"name":"facebookWallPost","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelFacebookWallPost","conditions":[{"name":"ChannelFacebookWallPost","fieldName":"ChannelId","operate":"equals","values":["FacebookWallPost"]}],"enumItems":[]},{"name":"facebookVisitorPost","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelFacebookVisitorPost","conditions":[{"name":"ChannelFacebookVisitorPost","fieldName":"ChannelId","operate":"equals","values":["FacebookVisitorPost"]}],"enumItems":[]},{"name":"facebookMessenger","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelFacebookMessenger","conditions":[{"name":"ChannelFacebookMessenger","fieldName":"ChannelId","operate":"equals","values":["FacebookMessenger"]}],"enumItems":[]},{"name":"facebookTotal","calculationType":"expression","valueType":"int","expression":"facebookWallPost + facebookVisitorPost + facebookMessenger","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"tweet","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelTweet","conditions":[{"name":"ChannelTweet","fieldName":"ChannelId","operate":"equals","values":["Tweet"]}],"enumItems":[]},{"name":"tweeterDirectMessage","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelTweeterDirectMessage","conditions":[{"name":"ChannelTweeterDirectMessage","fieldName":"ChannelId","operate":"equals","values":["TwitterDirectMessage"]}],"enumItems":[]},{"name":"tweeterTotal","calculationType":"expression","valueType":"int","expression":"tweet + tweeterDirectMessage","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"weChat","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelWeChat","conditions":[{"name":"ChannelWeChat","fieldName":"ChannelId","operate":"equals","values":["Wechat"]}],"enumItems":[]},{"name":"sms","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelSms","conditions":[{"name":"ChannelSms","fieldName":"ChannelId","operate":"equals","values":["SMS"]}],"enumItems":[]},{"name":"whatsApp","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelWhatsApp","conditions":[{"name":"ChannelWhatsApp","fieldName":"ChannelId","operate":"equals","values":["WhatsApp"]}],"enumItems":[]},{"name":"chat","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelChat","conditions":[{"name":"ChannelChat","fieldName":"ChannelId","operate":"equals","values":["Chat"]}],"enumItems":[]},{"name":"offlineMessage","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelOfflineMessage","conditions":[{"name":"ChannelOfflineMessage","fieldName":"ChannelId","operate":"equals","values":["OfflineMessage"]}],"enumItems":[]},{"name":"internal","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChannelInternal","conditions":[{"name":"ChannelInternal","fieldName":"ChannelId","operate":"equals","values":["Internal"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"CreatedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/05/29","2021/05/29"]},{"fieldName":"MergedToTargetId","matchType":"equals","value":["0"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]}],"mergeType":"column","timezone":-420}'

Response:

HTTP/1.1 200 OK

Efficiency details by day.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Ticket","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"allChannels","calculationType":"uniqueCount","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgResponseTime","calculationType":"expression","valueType":"timespan","expression":"sumResponseTime/sumResponseCount","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgFirstResponseTime","calculationType":"average","valueType":"timespan","expression":"","fieldName":"FirstResponseTimeSpan","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgTicketTime","calculationType":"average","valueType":"timespan","expression":"","fieldName":"ResolvedTimeSpan","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgVisitorMessages","calculationType":"expression","valueType":"decimal","expression":"visitorMessages/allChannels","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgAgentMessages","calculationType":"expression","valueType":"decimal","expression":"agentMessages/allChannels","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"sumResponseCount","calculationType":"sum","valueType":"int","expression":"","fieldName":"ResponseCount","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"sumResponseTime","calculationType":"sum","valueType":"int","expression":"","fieldName":"ResponseTimeSpan","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"CreatedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/05/29","2021/05/29"]},{"fieldName":"Status","matchType":"equals","value":["5"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]},{"name":"Ticket","fields":[{"name":"visitorMessages","calculationType":"count","valueType":"int","expression":"","fieldName":"Message.SentByType","conditionExpression":"(SentByType3|SentByType4)&MergedToTargetId0","conditions":[{"name":"SentByType3","fieldName":"Message.SentByType","operate":"equals","values":["3"]},{"name":"SentByType4","fieldName":"Message.SentByType","operate":"equals","values":["4"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"agentMessages","calculationType":"count","valueType":"int","expression":"","fieldName":"Message.SentByType","conditionExpression":"SentByType&MergedToTargetId0","conditions":[{"name":"SentByType","fieldName":"Message.SentByType","operate":"equals","values":["1","5"]},{"name":"MergedToTargetId0","fieldName":"MergedToTargetId","operate":"equals","values":["0"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"CreatedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/05/29","2021/05/29"]},{"fieldName":"Status","matchType":"equals","value":["5"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]}]}],"mergeType":"column","timezone":-420}'

Response:

HTTP/1.1 200 OK

SLA Policies details.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Ticket","fields":[{"name":"slaPolicyId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"TicketSLA.SlaPolicy.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"slaPolicy","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"TicketSLA.SlaPolicy.Name","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"firstResponseSlaCount","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"FirstRespondBreachStatus1","conditions":[{"name":"FirstRespondBreachStatus1","fieldName":"TicketSLA.FirstRespondBreachStatus","operate":"equals","values":["1"]}],"enumItems":[]},{"name":"firstResponseSlaTotal","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"FirstRespondBreachStatus123","conditions":[{"name":"FirstRespondBreachStatus123","fieldName":"TicketSLA.FirstRespondBreachStatus","operate":"equals","values":["1","2","3"]}],"enumItems":[]},{"name":"firstRespondRate","calculationType":"expression","valueType":"percent","expression":"firstResponseSlaCount/firstResponseSlaTotal","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"firstRespondDuration","calculationType":"sum","valueType":"decimal","expression":"","fieldName":"TicketSLA.FirstRespondDuration","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"FirstRespondDurationTotal","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"FirstRespondBreachStatus13","conditions":[{"name":"FirstRespondBreachStatus13","fieldName":"TicketSLA.FirstRespondBreachStatus","operate":"equals","values":["1","3"]}],"enumItems":[]},{"name":"avgFirstRespondSlaTime","calculationType":"expression","valueType":"timespan","expression":"firstRespondDuration/FirstRespondDurationTotal","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"sumNextRespondCount","calculationType":"sum","valueType":"int","expression":"","fieldName":"TicketSLA.NextRespondCount","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"sumNextRespondBreachCount","calculationType":"sum","valueType":"int","expression":"","fieldName":"TicketSLA.NextRespondBreachCount","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"nextResponseSlaRate","calculationType":"expression","valueType":"percent","expression":"(sumNextRespondCount-sumNextRespondBreachCount)/sumNextRespondCount","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"sumNextRespondDuration","calculationType":"sum","valueType":"int","expression":"","fieldName":"TicketSLA.NextRespondDuration","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgNextRespondSlaTime","calculationType":"expression","valueType":"timespan","expression":"sumNextRespondDuration/sumNextRespondCount","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"resolutionSlaCount","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ResolveTimeBreachStatus1","conditions":[{"name":"ResolveTimeBreachStatus1","fieldName":"TicketSLA.ResolveTimeBreachStatus","operate":"equals","values":["1"]}],"enumItems":[]},{"name":"resolutionSlaCountTotal","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ResolveTimeBreachStatus1234","conditions":[{"name":"ResolveTimeBreachStatus1234","fieldName":"TicketSLA.ResolveTimeBreachStatus","operate":"equals","values":["1","2","3","4"]}],"enumItems":[]},{"name":"resolutionSlaRate","calculationType":"expression","valueType":"percent","expression":"resolutionSlaCount/resolutionSlaCountTotal","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"sumResolvedDuration","calculationType":"sum","valueType":"int","expression":"","fieldName":"TicketSLA.ResolvedDuration","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"resolutionSlaDurationTotal","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ResolveTimeBreachStatus134","conditions":[{"name":"ResolveTimeBreachStatus134","fieldName":"TicketSLA.ResolveTimeBreachStatus","operate":"equals","values":["1","3","4"]}],"enumItems":[]},{"name":"avgResolutionSlaTime","calculationType":"expression","valueType":"timespan","expression":"sumResolvedDuration/resolutionSlaDurationTotal","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"breachTickets","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"FirstRespondBreachStatus23 | ResolveTimeBreachStatus23 | NextRespondBreachCount23","conditions":[{"name":"FirstRespondBreachStatus23","fieldName":"TicketSLA.FirstRespondBreachStatus","operate":"equals","values":["2","3"]},{"name":"ResolveTimeBreachStatus23","fieldName":"TicketSLA.ResolveTimeBreachStatus","operate":"equals","values":["2","3"]},{"name":"NextRespondBreachCount23","fieldName":"TicketSLA.NextRespondBreachCount","operate":"equals","values":["2","3"]}],"enumItems":[]}],"rowGroups":[{"name":"slaPolicyId","fieldName":"TicketSLA.SlaPolicyId","isFull":true}],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/05/29","2021/05/29"]},{"fieldName":"MergedToTargetId","matchType":"equals","value":["0"]},{"fieldName":"IsInRecycleBin","matchType":"equals","value":["0"]},{"fieldName":"TicketSLA.SlaPolicy.Id","matchType":"notEquals","value":[null]}]}],"mergeType":"column","timezone":-420}'

Response:

HTTP/1.1 200 OK

Availability details by Month.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"AgentStatusLog","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[]},{"name":"online","calculationType":"sum","valueType":"timespan","expression":"","fieldName":"Online","conditionExpression":"","conditions":[]}],"rowGroups":[{"name":"time","fieldName":"StartTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"StartTime","matchType":"between","value":["2021/04/27","2021/05/26"]}]}],"mergeType":"column","timezone":-720}'

Response:

HTTP/1.1 200 OK

Canned Messages details by site.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"CannedMessageUseRecord","fields":[{"name":"cannedMessage","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"CannedMessage.Name","conditionExpression":"","conditions":[]},{"name":"usedTimes","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[]},{"name":"usedAgents","calculationType":"uniqueCount","valueType":"int","expression":"","fieldName":"AgentId","conditionExpression":"","conditions":[]},{"name":"cannedMessageId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"CannedMessage.Id","conditionExpression":"","conditions":[]}],"rowGroups":[{"name":"cannedMessageId","fieldName":"CannedMessage.Id","isFull":true}],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/04/27","2021/05/26"]},{"fieldName":"CannedMessage.Id","matchType":"notEquals","value":[null]}]}],"mergeType":"column","timezone":-720}'

Response:

HTTP/1.1 200 OK

Provides the number of chats initiated by visitors, by agents, or by predefined rules as well as the request page of those chats.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"chatsByVisitors","calculationType":"count","valueType":"int","expression":"","fieldName":"Source","conditionExpression":"Source0 & NormalStatus","conditions":[{"name":"Source0","fieldName":"Source","operate":"equals","values":["0"]},{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]},{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"chatsFromAutoInvitation","calculationType":"count","valueType":"int","expression":"","fieldName":"Source","conditionExpression":"Source1 & NormalStatus","conditions":[{"name":"Source1","fieldName":"Source","operate":"equals","values":["1"]},{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]},{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"chatsFromManualInvitation","calculationType":"count","valueType":"int","expression":"","fieldName":"Source","conditionExpression":"Source2 & NormalStatus","conditions":[{"name":"Source2","fieldName":"Source","operate":"equals","values":["2"]},{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]},{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"chats","calculationType":"expression","valueType":"int","expression":"chatsByVisitors + chatsFromAutoInvitation + chatsFromManualInvitation","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/04/27","2021/05/26"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Shows the number of visitors who waited in the queue, abandoned the queue, switched to offline message or were refused by agents.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"queuedChatRequests","calculationType":"expression","valueType":"int","expression":"chatsFromQueue+switchedToMessaged+abandonedChats+refusedChats","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"chatsFromQueue","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"Status0","conditions":[{"name":"Status0","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"switchedToMessaged","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"Status2 & ChatType16","conditions":[{"name":"Status2","fieldName":"Status","operate":"equals","values":["2"]},{"name":"ChatType16","fieldName":"ChatType","operate":"equals","values":["16"]}],"enumItems":[]},{"name":"abandonedChats","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"Status4 & ChatTypeNot16","conditions":[{"name":"Status4","fieldName":"Status","operate":"equals","values":["2"]},{"name":"ChatTypeNot16","fieldName":"ChatType","operate":"notEquals","values":["16"]}],"enumItems":[]},{"name":"refusedChats","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"Status1","conditions":[{"name":"Status1","fieldName":"Status","operate":"equals","values":["1"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/02/01","2021/03/01"]},{"fieldName":"IsQueued","matchType":"equals","value":["1"]}]},{"name":"QueueStatistics","fields":[{"name":"maxQueueSize","calculationType":"max","valueType":"int","expression":"","fieldName":"QueueLength","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"Time","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"Time","matchType":"between","value":["2021/02/01","2021/03/01"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Provides the details on visitors' average and the longest wait times within a specific time range.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgWaitingTime","calculationType":"average","valueType":"timespan","expression":"","fieldName":"WaitingTime","conditionExpression":"ChatType02","conditions":[{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]}],"enumItems":[]},{"name":"avgWaitingTimeOfMissedChats","calculationType":"average","valueType":"timespan","expression":"","fieldName":"WaitingTime","conditionExpression":"ChatType02 & Status2","conditions":[{"name":"Status2","fieldName":"Status","operate":"equals","values":["2"]},{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]}],"enumItems":[]},{"name":"maxWaitingTime","calculationType":"max","valueType":"timespan","expression":"","fieldName":"WaitingTime","conditionExpression":"ChatType02","conditions":[{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]}],"enumItems":[]},{"name":"maxWaitingTimeOfMissedChats","calculationType":"max","valueType":"timespan","expression":"","fieldName":"WaitingTime","conditionExpression":"ChatType02 & Status2","conditions":[{"name":"Status2","fieldName":"Status","operate":"equals","values":["2"]},{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/02/01","2021/03/01"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Provides a clear picture on the number of chats being transferred between agents and departments.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"TransferLog","fields":[{"name":"totalTransferredChats","calculationType":"uniqueCount","valueType":"int","expression":"","fieldName":"ChatGuid","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"departmentTransferredChats","calculationType":"uniqueCount","valueType":"int","expression":"","fieldName":"ChatGuid","conditionExpression":"TransferType1","conditions":[{"name":"TransferType1","fieldName":"TransferType","operate":"equals","values":["1"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"Time","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"Time","matchType":"between","value":["2021/02/01","2021/03/01"]}]},{"name":"TransferLog","fields":[{"name":"departmentTransferredInChats","calculationType":"count","valueType":"int","expression":"","fieldName":"TransferType","conditionExpression":"TransferType1","conditions":[{"name":"TransferType1","fieldName":"TransferType","operate":"equals","values":["1"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"Time","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"Time","matchType":"between","value":["2021/02/01","2021/03/01"]}]},{"name":"TransferLog","fields":[{"name":"departmentTransferredOutChats","calculationType":"count","valueType":"int","expression":"","fieldName":"TransferType","conditionExpression":"TransferType1","conditions":[{"name":"TransferType1","fieldName":"TransferType","operate":"equals","values":["1"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"Time","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"Time","matchType":"between","value":["2021/02/01","2021/03/01"]}]},{"name":"Chat","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"chats","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"NormalStatus","conditions":[{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/02/01","2021/03/01"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Provides data regarding agents' overall performance in terms of chat time and wait time within a specific time period.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"avgChatTime","calculationType":"average","valueType":"timespan","expression":"","fieldName":"Duration","conditionExpression":"ChatType02","conditions":[{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]}],"enumItems":[]},{"name":"avgWaitTime","calculationType":"average","valueType":"timespan","expression":"","fieldName":"WaitingTime","conditionExpression":"ChatType02","conditions":[{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]}],"enumItems":[]},{"name":"chats","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"ChatType02 & Status0","conditions":[{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]},{"name":"Status0","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"totalChatTime","calculationType":"sum","valueType":"timespan","expression":"","fieldName":"Duration","conditionExpression":"ChatType02","conditions":[{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]}],"enumItems":[]},{"name":"lastMessageSentByAgent","calculationType":"count","valueType":"int","expression":"","fieldName":"LastMessageSentBy","conditionExpression":"LastMessageSentBy1 & ChatType02","conditions":[{"name":"LastMessageSentBy1","fieldName":"LastMessageSentBy","operate":"equals","values":["1"]},{"name":"ChatType02","fieldName":"ChatType","operate":"equals","values":["0","2"]}],"enumItems":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/02/01","2021/03/01"]},{"fieldName":"Status","matchType":"equals","value":["0"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Gives a comprehensive view on the agent workload by providings data regarding agents' chat time and number of chats handled.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"AgentStatusLog","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"linearChatTime","calculationType":"count","valueType":"timespan","expression":"","fieldName":"StartTime","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"idleTime","calculationType":"count","valueType":"timespan","expression":"","fieldName":"EndTime","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"loginTime","calculationType":"count","valueType":"timespan","expression":"","fieldName":"StartTime","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"agentUtilization","calculationType":"expression","valueType":"percent","expression":"linearChatTime/loginTime","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"StartTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"StartTime","matchType":"between","value":["2021/02/01","2021/03/01"]}]},{"name":"Chat","fields":[{"name":"totalChatTime","calculationType":"sum","valueType":"timespan","expression":"","fieldName":"Duration","conditionExpression":"NormalStatus","conditions":[{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"chats","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"NormalStatus","conditions":[{"name":"NormalStatus","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"avgConcurrentChats","calculationType":"expression","valueType":"decimal","expression":"totalChatTime/loginTime","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/02/01","2021/03/01"]},{"fieldName":"ChatType","matchType":"equals","value":["0","2"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Provides data regarding the agents' responsiveness, total chat time and visitor wait time.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"avgAgentResponseTime","calculationType":"average","valueType":"timespan","expression":"","fieldName":"AvgResponseTime","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgWaitTime","calculationType":"average","valueType":"timespan","expression":"","fieldName":"WaitingTime","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgChatTime","calculationType":"average","valueType":"timespan","expression":"","fieldName":"Duration","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgAgentChatMessages","calculationType":"average","valueType":"decimal","expression":"","fieldName":"AgentMessagesCount","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgVisitorChatMessages","calculationType":"average","valueType":"decimal","expression":"","fieldName":"VisitorMessagesCount","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"avgCannedMessages","calculationType":"average","valueType":"int","expression":"","fieldName":"CannedMessageCount","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"lastMessageSentByAgent","calculationType":"count","valueType":"int","expression":"","fieldName":"LastMessageSentBy","conditionExpression":"LastMessageSentBy1","conditions":[{"name":"LastMessageSentBy1","fieldName":"LastMessageSentBy","operate":"equals","values":["1"]}],"enumItems":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/02/01","2021/03/01"]},{"fieldName":"Status","matchType":"equals","value":["0"]},{"fieldName":"ChatType","matchType":"equals","value":["0","2"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK


                                {
    "total": {
        "avgAgentResponseTime": 41.77,
        "avgWaitTime": 39.59,
        "avgChatTime": 2212.10,
        "avgAgentChatMessages": 0.88,
        "avgVisitorChatMessages": 0.66,
        "avgCannedMessages": 0.03,
        "lastMessageSentByAgent": 193
    },
    "series": [
        {
            "time": "2021-02-01",
            "avgAgentResponseTime": 0.0,
            "avgWaitTime": 6.58,
            "avgChatTime": 14741.21,
            "avgAgentChatMessages": 0.47,
            "avgVisitorChatMessages": 0.05,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 5.0
        },
        {
            "time": "2021-02-02",
            "avgAgentResponseTime": 76.83,
            "avgWaitTime": 2.88,
            "avgChatTime": 1301.79,
            "avgAgentChatMessages": 0.17,
            "avgVisitorChatMessages": 0.25,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 1.0
        },
        {
            "time": "2021-02-03",
            "avgAgentResponseTime": 1.1,
            "avgWaitTime": 1.24,
            "avgChatTime": 479.78,
            "avgAgentChatMessages": 0.86,
            "avgVisitorChatMessages": 0.39,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 16.0
        },
        {
            "time": "2021-02-04",
            "avgAgentResponseTime": 0.29,
            "avgWaitTime": 17.51,
            "avgChatTime": 2407.36,
            "avgAgentChatMessages": 0.53,
            "avgVisitorChatMessages": 0.22,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 15.0
        },
        {
            "time": "2021-02-05",
            "avgAgentResponseTime": 2.73,
            "avgWaitTime": 0.55,
            "avgChatTime": 18629.73,
            "avgAgentChatMessages": 0.91,
            "avgVisitorChatMessages": 0.55,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 6.0
        },
        {
            "time": "2021-02-06",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-07",
            "avgAgentResponseTime": 431.36,
            "avgWaitTime": 3.04,
            "avgChatTime": 2181.61,
            "avgAgentChatMessages": 2.07,
            "avgVisitorChatMessages": 0.61,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 13.0
        },
        {
            "time": "2021-02-08",
            "avgAgentResponseTime": 0.2,
            "avgWaitTime": 5.4,
            "avgChatTime": 290.5,
            "avgAgentChatMessages": 0.8,
            "avgVisitorChatMessages": 0.3,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 8.0
        },
        {
            "time": "2021-02-09",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-10",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-11",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-12",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-13",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-14",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-15",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-16",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-17",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-18",
            "avgAgentResponseTime": 0.0,
            "avgWaitTime": 5.0,
            "avgChatTime": 57114.0,
            "avgAgentChatMessages": 0.0,
            "avgVisitorChatMessages": 0.0,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 0.0
        },
        {
            "time": "2021-02-19",
            "avgAgentResponseTime": 49.05,
            "avgWaitTime": 5.62,
            "avgChatTime": 666.9,
            "avgAgentChatMessages": 0.9,
            "avgVisitorChatMessages": 1.05,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 16.0
        },
        {
            "time": "2021-02-20",
            "avgAgentResponseTime": 29.68,
            "avgWaitTime": 18.39,
            "avgChatTime": 574.61,
            "avgAgentChatMessages": 0.71,
            "avgVisitorChatMessages": 0.64,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 14.0
        },
        {
            "time": "2021-02-21",
            "avgAgentResponseTime": 0,
            "avgWaitTime": 0,
            "avgChatTime": 0,
            "avgAgentChatMessages": 0,
            "avgVisitorChatMessages": 0,
            "avgCannedMessages": 0,
            "lastMessageSentByAgent": 0
        },
        {
            "time": "2021-02-22",
            "avgAgentResponseTime": 24.69,
            "avgWaitTime": 50.34,
            "avgChatTime": 826.23,
            "avgAgentChatMessages": 1.94,
            "avgVisitorChatMessages": 1.17,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 18.0
        },
        {
            "time": "2021-02-23",
            "avgAgentResponseTime": 4.76,
            "avgWaitTime": 1.8,
            "avgChatTime": 867.8,
            "avgAgentChatMessages": 0.32,
            "avgVisitorChatMessages": 0.8,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 8.0
        },
        {
            "time": "2021-02-24",
            "avgAgentResponseTime": 10.4,
            "avgWaitTime": 9.17,
            "avgChatTime": 80.7,
            "avgAgentChatMessages": 0.83,
            "avgVisitorChatMessages": 0.67,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 12.0
        },
        {
            "time": "2021-02-25",
            "avgAgentResponseTime": 35.38,
            "avgWaitTime": 17.25,
            "avgChatTime": 2737.03,
            "avgAgentChatMessages": 0.72,
            "avgVisitorChatMessages": 1.22,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 12.0
        },
        {
            "time": "2021-02-26",
            "avgAgentResponseTime": 89.0,
            "avgWaitTime": 5.64,
            "avgChatTime": 7581.91,
            "avgAgentChatMessages": 0.91,
            "avgVisitorChatMessages": 3.09,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 3.0
        },
        {
            "time": "2021-02-27",
            "avgAgentResponseTime": 10.92,
            "avgWaitTime": 8.36,
            "avgChatTime": 517.32,
            "avgAgentChatMessages": 0.76,
            "avgVisitorChatMessages": 0.64,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 10.0
        },
        {
            "time": "2021-02-28",
            "avgAgentResponseTime": 0.0,
            "avgWaitTime": 4.25,
            "avgChatTime": 320.0,
            "avgAgentChatMessages": 0.5,
            "avgVisitorChatMessages": 0.75,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 0.0
        },
        {
            "time": "2021-03-01",
            "avgAgentResponseTime": 0.56,
            "avgWaitTime": 290.92,
            "avgChatTime": 440.68,
            "avgAgentChatMessages": 1.1,
            "avgVisitorChatMessages": 0.32,
            "avgCannedMessages": 0.0,
            "lastMessageSentByAgent": 36.0
        }
    ]
}

Provides insights on customer satisfaction by showsing rating scores of individual agents and departments.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"ratingTimes","calculationType":"count","valueType":"int","expression":"","fieldName":"PostChatSurvey.ChatId","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"score5","calculationType":"count","valueType":"int","expression":"","fieldName":"PostChatSurvey.RatingGrade","conditionExpression":"RatingGrade5","conditions":[{"name":"RatingGrade5","fieldName":"PostChatSurvey.RatingGrade","operate":"equals","values":["5"]}],"enumItems":[]},{"name":"score4","calculationType":"count","valueType":"int","expression":"","fieldName":"PostChatSurvey.RatingGrade","conditionExpression":"RatingGrade4","conditions":[{"name":"RatingGrade4","fieldName":"PostChatSurvey.RatingGrade","operate":"equals","values":["4"]}],"enumItems":[]},{"name":"score3","calculationType":"count","valueType":"int","expression":"","fieldName":"PostChatSurvey.RatingGrade","conditionExpression":"RatingGrade3","conditions":[{"name":"RatingGrade3","fieldName":"PostChatSurvey.RatingGrade","operate":"equals","values":["3"]}],"enumItems":[]},{"name":"score2","calculationType":"count","valueType":"int","expression":"","fieldName":"PostChatSurvey.RatingGrade","conditionExpression":"RatingGrade2","conditions":[{"name":"RatingGrade2","fieldName":"PostChatSurvey.RatingGrade","operate":"equals","values":["2"]}],"enumItems":[]},{"name":"score1","calculationType":"count","valueType":"int","expression":"","fieldName":"PostChatSurvey.RatingGrade","conditionExpression":"RatingGrade1","conditions":[{"name":"RatingGrade1","fieldName":"PostChatSurvey.RatingGrade","operate":"equals","values":["1"]}],"enumItems":[]},{"name":"avgScore","calculationType":"average","valueType":"decimal","expression":"","fieldName":"PostChatSurvey.RatingGrade","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"PostChatSurvey.SubmitTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"PostChatSurvey.SubmitTime","matchType":"between","value":["2021/02/01","2021/03/01"]},{"fieldName":"PostChatSurvey.RatingGrade","matchType":"greaterThan","value":["0"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Provides insight on how visitors felt about agents' professionalism, responsiveness, and helpfulness.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"campaignId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"campaignName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Name","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"count","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"type","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Type","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fieldId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fieldName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Name","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"score","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"campaignId","fieldName":"CampaignId","isFull":false},{"name":"fieldId","fieldName":"ChatFieldResult.FieldId","isFull":false},{"name":"score","fieldName":"ChatFieldResult.Value","isFull":false}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/04/28","2021/05/27"]},{"fieldName":"ChatFieldResult.Field.Type","matchType":"equals","value":["7"]},{"fieldName":"ChatFieldResult.FormType","matchType":"equals","value":["2"]}]},{"name":"Chat","fields":[{"name":"campaignId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"campaignName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Name","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"count","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"option","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"type","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Type","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fieldId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fieldName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Name","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"campaignId","fieldName":"CampaignId","isFull":false},{"name":"fieldId","fieldName":"ChatFieldResult.FieldId","isFull":false},{"name":"option","fieldName":"ChatFieldResult.Value","isFull":false}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/04/28","2021/05/27"]},{"fieldName":"ChatFieldResult.Field.Type","matchType":"equals","value":["3","4","5","6"]},{"fieldName":"ChatFieldResult.FormType","matchType":"equals","value":["2"]}]}],"mergeType":"row","timezone":480}'

Response:

HTTP/1.1 200 OK

Provides insight on visitor data collected from pre-chat surveys.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"campaignId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"campaignName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Name","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"count","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"option","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"type","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Type","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fieldId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fieldName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Name","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"campaignId","fieldName":"CampaignId","isFull":false},{"name":"fieldId","fieldName":"ChatFieldResult.FieldId","isFull":false},{"name":"option","fieldName":"ChatFieldResult.Value","isFull":false}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/04/28","2021/05/27"]},{"fieldName":"ChatFieldResult.Field.Type","matchType":"equals","value":["3","4","5","6"]},{"fieldName":"ChatFieldResult.FormType","matchType":"equals","value":["0"]}]}],"mergeType":"row","timezone":480}'

Response:

HTTP/1.1 200 OK

Shows the categorization details of the chats as well as the wrap-up completion rate according to the wrap-up survey.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"Chat","fields":[{"name":"campaignId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"campaignName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Name","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"count","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"categoryOptionId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatWrapupCategory.CategoryOption.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"categoryOptionName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatWrapupCategory.CategoryOption.Name","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"campaignId","fieldName":"CampaignId","isFull":false},{"name":"optionId","fieldName":"ChatWrapupCategory.CategoryOptionId","isFull":false}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/05/03","2021/06/01"]}]},{"name":"Chat","fields":[{"name":"campaignId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"campaignName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"Campaign.Name","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"count","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"option","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"type","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Type","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fieldId","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fieldName","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"ChatFieldResult.Field.Name","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"campaignId","fieldName":"CampaignId","isFull":false},{"name":"fieldId","fieldName":"ChatFieldResult.FieldId","isFull":false},{"name":"option","fieldName":"ChatFieldResult.Value","isFull":false}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/05/03","2021/06/01"]},{"fieldName":"ChatFieldResult.Field.Type","matchType":"equals","value":["3","4","5","6"]},{"fieldName":"ChatFieldResult.FormType","matchType":"equals","value":["3"]}]}],"mergeType":"row","timezone":480}'

Response:

HTTP/1.1 200 OK

Shows all achieved conversions, total conversion value and the conversion rate.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"ConversionLog","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"conversions","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"convertedVisitors","calculationType":"uniqueCount","valueType":"int","expression":"","fieldName":"VisitorId","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"convertedChattedVisitors","calculationType":"uniqueCount","valueType":"int","expression":"","fieldName":"VisitorId","conditionExpression":"ChatIdNotEmpty","conditions":[{"name":"ChatIdNotEmpty","fieldName":"ChatGuid","operate":"notEquals","values":["00000000-0000-0000-0000-000000000000"]}],"enumItems":[]},{"name":"convRateOfChattedVisitors","calculationType":"expression","valueType":"percent","expression":"convertedChattedVisitors/chattedVisitors","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"value","calculationType":"sum","valueType":"decimal","expression":"","fieldName":"ConversionValue","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"CreatedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/02/01","2021/03/01"]}]},{"name":"Chat","fields":[{"name":"chats","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"chattedVisitors","calculationType":"uniqueCount","valueType":"int","expression":"","fieldName":"Session.VisitorId","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"RequestedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"RequestedTime","matchType":"between","value":["2021/02/01","2021/03/01"]},{"fieldName":"Status","matchType":"equals","value":["0"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Shows the number of invitations sent manually by agents as well as the acceptance rate.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"ManualInvitationLog","fields":[{"name":"sent","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"Status0","conditions":[{"name":"Status0","fieldName":"Status","operate":"equals","values":["0"]}],"enumItems":[]},{"name":"accepted","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"Status1","conditions":[{"name":"Status1","fieldName":"Status","operate":"equals","values":["1"]}],"enumItems":[]},{"name":"acceptanceRate","calculationType":"expression","valueType":"percent","expression":"accepted/sent","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"sumInvitation","calculationType":"count","valueType":"int","expression":"","fieldName":"Status","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"SentTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"SentTime","matchType":"between","value":["2021/02/01","2021/03/01"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Shows the number of invitations triggered by predefined rules as well as the acceptance rate.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"AutoInvitationStatistics","fields":[{"name":"sent","calculationType":"sum","valueType":"int","expression":"","fieldName":"SentNum","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"accepted","calculationType":"sum","valueType":"int","expression":"","fieldName":"AcceptNum","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"acceptanceRate","calculationType":"expression","valueType":"percent","expression":"accepted/sent","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"LogTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"LogTime","matchType":"between","value":["2021/03/01","2021/03/31"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK

Provides details on the number of offline messages left by the visitos as well as their source.

Sample Request :

curl https://api15.comm100.io/v4/reportingquery/reports/query \

-X 'POST' \

-H 'Authorization: Bearer {access_token}' \

-H 'Content-Type: application/json' \

-D '{"cubeEntities":[{"name":"OfflineMessage","fields":[{"name":"time","calculationType":"originalValue","valueType":"string","expression":"","fieldName":"","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fromOfflineButton","calculationType":"count","valueType":"int","expression":"","fieldName":"Source","conditionExpression":"SourceOffline","conditions":[{"name":"SourceOffline","fieldName":"Source","operate":"equals","values":["0","1","2"]}],"enumItems":[]},{"name":"messages","calculationType":"count","valueType":"int","expression":"","fieldName":"Id","conditionExpression":"","conditions":[],"enumItems":[]},{"name":"fromChatQueue","calculationType":"count","valueType":"int","expression":"","fieldName":"Source","conditionExpression":"SourceQueue","conditions":[{"name":"SourceQueue","fieldName":"Source","operate":"equals","values":["3"]}],"enumItems":[]},{"name":"fromBot","calculationType":"count","valueType":"int","expression":"","fieldName":"Source","conditionExpression":"SourceBot","conditions":[{"name":"SourceBot","fieldName":"Source","operate":"equals","values":["4"]}],"enumItems":[]}],"rowGroups":[{"name":"time","fieldName":"CreatedTime","isFull":true,"timeDisplayType":"day"}],"filters":[{"fieldName":"CreatedTime","matchType":"between","value":["2021/03/01","2021/03/31"]}]}],"mergeType":"column","timezone":480}'

Response:

HTTP/1.1 200 OK