Administrators can define destinations (“endpoints”) to which key events can be exported. These reporting destinations are remote host servers that are external to the Contact system.
Multiple offline reporting destinations can be defined, meaning that different companies can send data to different destinations and/or a single company can send data to more than one location. The platform owner can then use the BI tool of their choice either to enable customers to access their event data or to create reports themselves as a service and distribute these to customers.
Administrators must have the Offline Reporting Destinations: Modify privilege to manage offline reporting destinations.
Add a new destination #
| Note: Be aware that the data transmitted to the URL of the host to receive events may contain General Data Protection Regulation (GDPR) sensitive information. As the reporting destination provider, you are responsible for taking any necessary precautions. |
- Navigate to System > Offline Reporting
- (Mandatory) Enter the Name of the reporting destination
- Enter an optional brief Description for the reporting destination
- (Mandatory) For URL of host to receive events, enter the URL address on the remote host server to which the events are exported
- The URL address must be in the format: https://hostname. For example: https://localhost:3612/example.
- To allow a non-secure URL address (HTTP rather than HTTPS) to receive event transmissions, tick the Allow non-secure URL checkbox (not recommended)
- For Channel Support Levels, select the event type(s) that may be sent to the offline reporting destination and the API version for each data stream
- A “channel” is an individual index within an offline reporting destination for a specific company. The following channel event types can be selected:
- Agent calls
- Agent chats
- Agent emails
- Agent SMS
- Agent status
- Contact calls
- Contact chats
- Contact emails
- Contact SMS
- Missed calls
- Queue calls
- Queue chats
- Queue emails
- The version of a channel indicates which fields are supported for an event. Only these fields are sent to the reporting destination. To view a list of the fields associated with that channel and the version at which they were introduced, click the question (?) icon
- A “channel” is an individual index within an offline reporting destination for a specific company. The following channel event types can be selected:
- Select the resellers that may use the offline reporting destination
- Click Save Changes
The Offline Reporting Destination will be added.
| Note: Not every event will include all of the fields shown in the help list; they may not be present in the original event as stored in the reports database. Multiple channel event types can be selected for a company. The selected version does not have to be the same for each channel. |
Pause Event Transmission #
You might want to pause event transmission, for example, while upgrades are performed on the remote host server. It may take a minute for this control to take effect.
- Select the appropriate reporting destination in the list
- Tick the Pause event transmission checkbox
Offline Reporting Types #
Enum Name |
Value |
Description |
|---|---|---|
CallData |
callData |
Call data reports (e.g. calls per agent, queue, service number) |
StatusData |
statusData |
Status data reports (e.g. time spent in each status) |
Diagnostics |
diagnostics |
Diagnostic reports (e.g. all call events for a day) |
EmailData |
emailData |
Email data reports (e.g. emails per agent/queue) |
WebchatData |
webchatData |
Webchat data reports (e.g. webchats per agent/queue) |
SMSData |
smsData |
SMS data reports (e.g. SMS per agent) |
PayByLinkData |
payByLinkData |
Pay by Link reports (e.g. links per agent) |
ServiceTypeData |
serviceTypeData |
Service type data associated with each user/account |
Offline Reporting Subtypes #
Call Data Subtypes
Enum Name |
Value |
Description |
|---|---|---|
ServiceNumber |
serviceNumber |
Call data by service number |
Queue |
queue |
Call data by queue |
Agent |
agent |
Call data by agent |
VirtualAgent |
virtualAgent |
Call data by virtual agent |
Ivr |
ivr |
Call data by IVR menu |
Classification |
classification |
Call classification data |
CallTransfer |
callTransfer |
Call transfer–focused data |
QueueTransfer |
queueTransfer |
Queue transfer–focused data |
Callers |
callers |
Call data by caller |
CallFlows |
callFlows |
Call flow data |
Voicemail |
voicemail |
Voicemail-related call data |
Calls |
calls |
Per-call records |
QueueKpi |
queueKpi |
Queue KPI statistics |
ScheduleCalls |
scheduleCalls |
Scheduled call records |
UnreturnedMissedCalls |
unreturnedMissedCalls |
Unreturned missed calls |
CallTrace |
callTrace |
Call trace report |
DroppedCalls |
droppedCall |
Dropped calls |
Email Data Subtypes
Subtype |
Value |
Description |
|---|---|---|
EmailQueue |
emailQueue |
Email data by queue |
EmailAgent |
emailAgent |
Email data by agent |
EmailFlows |
emailFlows |
Email flow node transit data |
EmailClassification |
emailClassification |
Email classification data |
InboundEmail |
inboundEmail |
Inbound email data |
OutboundEmailAgent |
outboundEmailAgent |
Outbound emails by agent |
OutboundEmailRecipient |
outboundEmailRecipient |
Outbound emails by recipient |
OutboundEmailTemplate |
outboundEmailTemplate |
Outbound emails by template |
Webchat Data Subtypes
Subtype |
Value |
Description |
|---|---|---|
WebchatAgent |
webchatAgent |
Webchat data by agent |
WebchatQueue |
webchatQueue |
Webchat data by queue |
WebchatFlows |
webchatFlows |
Webchat flow node transit data |
Status Data Subtypes
Subtype |
Value |
Description |
|---|---|---|
WorkingHours |
workingHours |
Time spent working |
BreakReasons |
breakReasons |
Time spent on different break types |
Diagnostics Subtypes
Subtype |
Value |
Description |
|---|---|---|
CallEvent |
callEvent |
Breakdown of call events |
StatusChange |
statusChange |
Breakdown of status changes |
ActivityAudit |
activityAudit |
User activity audit |
SMS Data Subtypes
Subtype |
Value |
Description |
|---|---|---|
SMSAgent |
smsAgent |
SMS data by agent |
SMSTemplate |
smsTemplate |
SMS data by template |
OutboundSMSRecipient |
outboundSMSRecipient |
SMS data by recipient |
Pay by Link Data Subtypes
Subtype |
Value |
Description |
|---|---|---|
SMSAgent |
smsAgent |
SMS data by agent |
SMSTemplate |
smsTemplate |
SMS data by template |
OutboundSMSRecipient |
outboundSMSRecipient |
SMS data by recipient |
Service Type Subtypes
Subtype |
Value |
Description |
|---|---|---|
UserCount |
userCount |
User count by service type |
