Reporting API Field Definitions

Reporting API Reference Fields

AgentModeEventDef

NameTypeDate FilterCan FilterCan GroupIs Computed
_idObject
AgentIdNumberX
ChannelProviderIdNumberX
CurrentChannelStateIdNumberX
CurrentChannelStateTrackedAsStateTrackedAsX
EpochNumberX
EpochDateNumberXX
EpochHourNumberXX
EpochQuarterHourNumberXX
EventAtUtcDate/TimeXX
EventTypeReportMessageEventTypeX
FirstNameBooleanX
LastNameBooleanX
LoggedInBooleanX
PendingStateIdNumberX
PreviousChannelStateDurationNumberX
PreviousChannelStateIdNumberX
PreviousChannelStateTrackedAsStateTrackedAsX
QueueListOther (object[])
RoutingProfileIdNumberX
SubStateSubStateX
TenantIdNumberX

InteractionRollupDef

NameTypeDate FilterCan FilterCan GroupIs Computed
_idObjectX
ANIBooleanX
AbandonTypeAbandonTypesXX
AbandonedAtUtcDate/TimeXX
AbandonedQuarterHourUtcDate/TimeXX
AbandonedHourUtcDate/TimeXX
AbandonedDayUtcDate/TimeXX
AbandonedTimeNumberX
AcceptTimeNumberX
AgentFirstNameBooleanX
AgentFirstResponseTimeNumberX
AgentHandleTimeNumberX
AgentIdNumberXX
AgentLastNameBooleanX
AgentReplyCountNumberX
ChannelProviderTypeChannelProviderTypesXX
ChannelTypeChannelTypesXX
ChannelUniqueIdentifierBooleanX
CurrentQueueCountNumberX
CustomerReplyCountNumberX
DNISBooleanXX
DataErrorDetectedBooleanX
DirectionMotionEventDirectionsXX
EndedDateTimeUtcDate/TimeXX
EndedDayUtcDate/TimeXX
EndedHourUtcDate/TimeXX
EndedQuarterHourUtcDate/TimeXX
EndedDateUtcDate/TimeXX
EndedEpochNumberX
EndedEpochDateNumberXX
EndedEpochHourNumberXX
EndedEpochQuarterHourNumberXX
EndedReasonConversationEndedTypesXX
EventCountNumberX
FirstAcceptedAtUtcDate/TimeXX
FirstAcceptedDayUtcDate/TimeXX
FirstAcceptedHourUtcDate/TimeXX
FirstAcceptedQuarterHourUtcDate/TimeXX
FirstAcceptedEpochNumberX
FirstDeliveredAtUtcDate/TimeXX
FirstDeliveredEpochNumberX
FirstDequeuedAtUtcDate/TimeXX
FirstDequeuedEpochNumberX
FirstQueuedAtUtcDate/TimeXX
FirstQueuedDayUtcDate/TimeXX
FirstQueuedHourUtcDate/TimeXX
FirstQueuedQuarterHourUtcDate/TimeXX
FirstQueuedEpochNumberX
FirstRollupAtUtcDate/TimeXX
FromCityBooleanX
FromCountryBooleanX
FromStateBooleanX
FromZipBooleanX
HasQueuedBooleanX
HoldCountNumberX
InteractionIdGUIDX
InteractionIdStrBooleanX
InteractionTimeNumberX
IsAbandonedBooleanX
AbandonedAppliedNumberX
IsAnsweredBooleanX
AnsweredAppliedNumberX
IsCRMUpdateEventBooleanX
IsInServiceLevelServiceLevelResultXX
IsInServiceLevelAppliedNumberX
ServiceLevelAppliesNumberX
LongestTimeWaitingOnAgentNumberX
LongestTimeWaitingOnCustomerNumberX
MostRecentRollupAtUtcDate/TimeXX
MuteCountNumberX
QueueIdNumberXX
QueuedTimeNumberX
RecordWrittenAtEpochNumberX
RecordWrittenAtUtcDate/TimeXX
RoutingProfileIdNumberX
ServiceLevelSecondsNumberX
StartedDateTimeUtcDate/TimeXX
StartedDayUtcDate/TimeXX
StartedHourUtcDate/TimeXX
StartedQuarterHourUtcDate/TimeXX
TotalWaitTimeNumberX
StartedDateUtcDate/TimeXX
StartedEpochNumberX
StartedEpochDateNumberXX
StartedEpochHourNumberXX
StartedEpochQuarterHourNumberXX
StirVerstatBooleanX
TenantIdNumberXX
TicketIdNumberX
TotalHoldTimeNumberX
TotalMuteTimeNumberX
TotalRingTimeNumberX
TotalTalkTimeNumberX
TotalTimeWaitingOnAgentNumberX
TotalTimeWaitingOnCustomerNumberX
WasDeliveredBooleanX
WorkflowTimeNumberX

Reporting API Reference Enumerations

AbandonTypes

NameValue
BeforeSL0
BeforeSL0
AfterSL1

ChannelProviderTypes

NameValue
UNKNOWN_UNKNOWN0
BotFramework_Chat1
Twilio_Voice2
Twilio_SMS3
API_API4
TIMED_CRON5
SendgridInbound_Email6
Mcx_Web7

ChannelTypes

NameValue
Unknown0
Chat1
Phone2
Video3
Email4
API5
SMS6
CaseRouting7

ConversationEndedTypes

NameValue
AgentEnded0
CustomerEnded1
AgentTimedOut2
CustomerTimedOut3
TimedOutInQueue4
GenericTimeout5
Unknown6
AgentPingTimeout7
CustomerPingTimeout8
CustomerSideNotAvailable9
TimeoutCaughtOnTimer10
CustomerDisconnectedInQueue11
CustomerDisconnectedInWorkflow12
Block13
Reset14
BotEnded15
CustomerPingTimeoutWhileInQueue16
EndedWithError17
CallBusy18
CallCircuitFailure19
CallTransferred20
QueueingError21

MotionEventDirections

NameValue
Inbound0
Outbound1

ReportMessageEventType

NameValue
INVALID_MESSAGE0
INTERACTION_STARTED1
INTERACTION_ERROR2
INTERACTION_WORKFLOW_CONNECTED3
INTERACTION_WORKFLOW_ABANDONED4
INTERACTION_WORKFLOW_EXIT5
INTERACTION_QUEUE_CONNECTED6
INTERACTION_QUEUE_ABANDONED7
INTERACTION_TICKET_CREATED8
INTERACTION_WORKITEM_CREATED9
INTERACTION_DELIVERED10
INTERACTION_REJECTED11
INTERACTION_ACCEPTED12
INTERACTION_PARTY_CONNECTED13
INTERACTION_PARTY_RESPONDED14
INTERACTION_HOLD15
INTERACTION_UNHOLD16
INTERACTION_REDIRECTED17
INTERACTION_MUTE18
INTERACTION_UNMUTE19
INTERACTION_PARTY_DISCONNECTED20
INTERACTION_ENDED21
AGENT_LOGGED_IN22
AGENT_LOGGED_OUT23
AGENT_STATE_CHANGED24
INTERACTION_REPORTING_TAG_AS_COMPLETED25
INTERACTION_REPORTING_TAG_ADD26
INTERACTION_REPORTING_TAG_REMOVE27
INTERACTION_QUEUE_DEQUEUED28
INTERACTION_VOICEMAIL29
INTERACTION_INITIATED30
INTERACTION_REQUEUED31
AGENT_REJECTED32
INTERACTION_PARKED33
INTERACTION_UNPARKED34
RING_GROUP_CALL_INITIATED35
RING_GROUP_CALL_COMPLETED36
RING_GROUP_CALL_ANSWERED37
RING_GROUP_CALL_MEMBER_FAILED38
RING_GROUP_CALL_UNKNOWN_PHONE39
RING_GROUP_CALL_MEMBER_NOANSWER40
RING_GROUP_CALL_MEMBER_UNAVAILABLE41

ServiceLevelResult

NameValue
False0
True1
NotEligible-1

StateTrackedAs

NameValue
Available0
Unavailable1
Unknown2
LoggedOff3

SubState

NameValue
None0
AtCapacity1
OutOfService2
Outbound3
Working4