Reporting API Reference Fields
AgentModeEventDef
| Name | Type | Date Filter | Can Filter | Can Group | Is Computed |
|---|---|---|---|---|---|
| _id | Object | ||||
| AgentId | Number | X | |||
| ChannelProviderId | Number | X | |||
| CurrentChannelStateId | Number | X | |||
| CurrentChannelStateTrackedAs | StateTrackedAs | X | |||
| Epoch | Number | X | |||
| EpochDate | Number | X | X | ||
| EpochHour | Number | X | X | ||
| EpochQuarterHour | Number | X | X | ||
| EventAtUtc | Date/Time | X | X | ||
| EventType | ReportMessageEventType | X | |||
| FirstName | Boolean | X | |||
| LastName | Boolean | X | |||
| LoggedIn | Boolean | X | |||
| PendingStateId | Number | X | |||
| PreviousChannelStateDuration | Number | X | |||
| PreviousChannelStateId | Number | X | |||
| PreviousChannelStateTrackedAs | StateTrackedAs | X | |||
| QueueList | Other (object[]) | ||||
| RoutingProfileId | Number | X | |||
| SubState | SubState | X | |||
| TenantId | Number | X |
InteractionRollupDef
| Name | Type | Date Filter | Can Filter | Can Group | Is Computed |
|---|---|---|---|---|---|
| _id | Object | X | |||
| ANI | Boolean | X | |||
| AbandonType | AbandonTypes | X | X | ||
| AbandonedAtUtc | Date/Time | X | X | ||
| AbandonedQuarterHourUtc | Date/Time | X | X | ||
| AbandonedHourUtc | Date/Time | X | X | ||
| AbandonedDayUtc | Date/Time | X | X | ||
| AbandonedTime | Number | X | |||
| AcceptTime | Number | X | |||
| AgentFirstName | Boolean | X | |||
| AgentFirstResponseTime | Number | X | |||
| AgentHandleTime | Number | X | |||
| AgentId | Number | X | X | ||
| AgentLastName | Boolean | X | |||
| AgentReplyCount | Number | X | |||
| ChannelProviderType | ChannelProviderTypes | X | X | ||
| ChannelType | ChannelTypes | X | X | ||
| ChannelUniqueIdentifier | Boolean | X | |||
| CurrentQueueCount | Number | X | |||
| CustomerReplyCount | Number | X | |||
| DNIS | Boolean | X | X | ||
| DataErrorDetected | Boolean | X | |||
| Direction | MotionEventDirections | X | X | ||
| EndedDateTimeUtc | Date/Time | X | X | ||
| EndedDayUtc | Date/Time | X | X | ||
| EndedHourUtc | Date/Time | X | X | ||
| EndedQuarterHourUtc | Date/Time | X | X | ||
| EndedDateUtc | Date/Time | X | X | ||
| EndedEpoch | Number | X | |||
| EndedEpochDate | Number | X | X | ||
| EndedEpochHour | Number | X | X | ||
| EndedEpochQuarterHour | Number | X | X | ||
| EndedReason | ConversationEndedTypes | X | X | ||
| EventCount | Number | X | |||
| FirstAcceptedAtUtc | Date/Time | X | X | ||
| FirstAcceptedDayUtc | Date/Time | X | X | ||
| FirstAcceptedHourUtc | Date/Time | X | X | ||
| FirstAcceptedQuarterHourUtc | Date/Time | X | X | ||
| FirstAcceptedEpoch | Number | X | |||
| FirstDeliveredAtUtc | Date/Time | X | X | ||
| FirstDeliveredEpoch | Number | X | |||
| FirstDequeuedAtUtc | Date/Time | X | X | ||
| FirstDequeuedEpoch | Number | X | |||
| FirstQueuedAtUtc | Date/Time | X | X | ||
| FirstQueuedDayUtc | Date/Time | X | X | ||
| FirstQueuedHourUtc | Date/Time | X | X | ||
| FirstQueuedQuarterHourUtc | Date/Time | X | X | ||
| FirstQueuedEpoch | Number | X | |||
| FirstRollupAtUtc | Date/Time | X | X | ||
| FromCity | Boolean | X | |||
| FromCountry | Boolean | X | |||
| FromState | Boolean | X | |||
| FromZip | Boolean | X | |||
| HasQueued | Boolean | X | |||
| HoldCount | Number | X | |||
| InteractionId | GUID | X | |||
| InteractionIdStr | Boolean | X | |||
| InteractionTime | Number | X | |||
| IsAbandoned | Boolean | X | |||
| AbandonedApplied | Number | X | |||
| IsAnswered | Boolean | X | |||
| AnsweredApplied | Number | X | |||
| IsCRMUpdateEvent | Boolean | X | |||
| IsInServiceLevel | ServiceLevelResult | X | X | ||
| IsInServiceLevelApplied | Number | X | |||
| ServiceLevelApplies | Number | X | |||
| LongestTimeWaitingOnAgent | Number | X | |||
| LongestTimeWaitingOnCustomer | Number | X | |||
| MostRecentRollupAtUtc | Date/Time | X | X | ||
| MuteCount | Number | X | |||
| QueueId | Number | X | X | ||
| QueuedTime | Number | X | |||
| RecordWrittenAtEpoch | Number | X | |||
| RecordWrittenAtUtc | Date/Time | X | X | ||
| RoutingProfileId | Number | X | |||
| ServiceLevelSeconds | Number | X | |||
| StartedDateTimeUtc | Date/Time | X | X | ||
| StartedDayUtc | Date/Time | X | X | ||
| StartedHourUtc | Date/Time | X | X | ||
| StartedQuarterHourUtc | Date/Time | X | X | ||
| TotalWaitTime | Number | X | |||
| StartedDateUtc | Date/Time | X | X | ||
| StartedEpoch | Number | X | |||
| StartedEpochDate | Number | X | X | ||
| StartedEpochHour | Number | X | X | ||
| StartedEpochQuarterHour | Number | X | X | ||
| StirVerstat | Boolean | X | |||
| TenantId | Number | X | X | ||
| TicketId | Number | X | |||
| TotalHoldTime | Number | X | |||
| TotalMuteTime | Number | X | |||
| TotalRingTime | Number | X | |||
| TotalTalkTime | Number | X | |||
| TotalTimeWaitingOnAgent | Number | X | |||
| TotalTimeWaitingOnCustomer | Number | X | |||
| WasDelivered | Boolean | X | |||
| WorkflowTime | Number | X |
Reporting API Reference Enumerations
AbandonTypes
| Name | Value |
|---|---|
| BeforeSL | 0 |
| BeforeSL | 0 |
| AfterSL | 1 |
ChannelProviderTypes
| Name | Value |
|---|---|
| UNKNOWN_UNKNOWN | 0 |
| BotFramework_Chat | 1 |
| Twilio_Voice | 2 |
| Twilio_SMS | 3 |
| API_API | 4 |
| TIMED_CRON | 5 |
| SendgridInbound_Email | 6 |
| Mcx_Web | 7 |
ChannelTypes
| Name | Value |
|---|---|
| Unknown | 0 |
| Chat | 1 |
| Phone | 2 |
| Video | 3 |
| 4 | |
| API | 5 |
| SMS | 6 |
| CaseRouting | 7 |
ConversationEndedTypes
| Name | Value |
|---|---|
| AgentEnded | 0 |
| CustomerEnded | 1 |
| AgentTimedOut | 2 |
| CustomerTimedOut | 3 |
| TimedOutInQueue | 4 |
| GenericTimeout | 5 |
| Unknown | 6 |
| AgentPingTimeout | 7 |
| CustomerPingTimeout | 8 |
| CustomerSideNotAvailable | 9 |
| TimeoutCaughtOnTimer | 10 |
| CustomerDisconnectedInQueue | 11 |
| CustomerDisconnectedInWorkflow | 12 |
| Block | 13 |
| Reset | 14 |
| BotEnded | 15 |
| CustomerPingTimeoutWhileInQueue | 16 |
| EndedWithError | 17 |
| CallBusy | 18 |
| CallCircuitFailure | 19 |
| CallTransferred | 20 |
| QueueingError | 21 |
MotionEventDirections
| Name | Value |
|---|---|
| Inbound | 0 |
| Outbound | 1 |
ReportMessageEventType
| Name | Value |
|---|---|
| INVALID_MESSAGE | 0 |
| INTERACTION_STARTED | 1 |
| INTERACTION_ERROR | 2 |
| INTERACTION_WORKFLOW_CONNECTED | 3 |
| INTERACTION_WORKFLOW_ABANDONED | 4 |
| INTERACTION_WORKFLOW_EXIT | 5 |
| INTERACTION_QUEUE_CONNECTED | 6 |
| INTERACTION_QUEUE_ABANDONED | 7 |
| INTERACTION_TICKET_CREATED | 8 |
| INTERACTION_WORKITEM_CREATED | 9 |
| INTERACTION_DELIVERED | 10 |
| INTERACTION_REJECTED | 11 |
| INTERACTION_ACCEPTED | 12 |
| INTERACTION_PARTY_CONNECTED | 13 |
| INTERACTION_PARTY_RESPONDED | 14 |
| INTERACTION_HOLD | 15 |
| INTERACTION_UNHOLD | 16 |
| INTERACTION_REDIRECTED | 17 |
| INTERACTION_MUTE | 18 |
| INTERACTION_UNMUTE | 19 |
| INTERACTION_PARTY_DISCONNECTED | 20 |
| INTERACTION_ENDED | 21 |
| AGENT_LOGGED_IN | 22 |
| AGENT_LOGGED_OUT | 23 |
| AGENT_STATE_CHANGED | 24 |
| INTERACTION_REPORTING_TAG_AS_COMPLETED | 25 |
| INTERACTION_REPORTING_TAG_ADD | 26 |
| INTERACTION_REPORTING_TAG_REMOVE | 27 |
| INTERACTION_QUEUE_DEQUEUED | 28 |
| INTERACTION_VOICEMAIL | 29 |
| INTERACTION_INITIATED | 30 |
| INTERACTION_REQUEUED | 31 |
| AGENT_REJECTED | 32 |
| INTERACTION_PARKED | 33 |
| INTERACTION_UNPARKED | 34 |
| RING_GROUP_CALL_INITIATED | 35 |
| RING_GROUP_CALL_COMPLETED | 36 |
| RING_GROUP_CALL_ANSWERED | 37 |
| RING_GROUP_CALL_MEMBER_FAILED | 38 |
| RING_GROUP_CALL_UNKNOWN_PHONE | 39 |
| RING_GROUP_CALL_MEMBER_NOANSWER | 40 |
| RING_GROUP_CALL_MEMBER_UNAVAILABLE | 41 |
ServiceLevelResult
| Name | Value |
|---|---|
| False | 0 |
| True | 1 |
| NotEligible | -1 |
StateTrackedAs
| Name | Value |
|---|---|
| Available | 0 |
| Unavailable | 1 |
| Unknown | 2 |
| LoggedOff | 3 |
SubState
| Name | Value |
|---|---|
| None | 0 |
| AtCapacity | 1 |
| OutOfService | 2 |
| Outbound | 3 |
| Working | 4 |