Interaction events fields
Type | Group | Name | Description |
---|---|---|---|
Filter-only fields | |||
Duration target | This filter-only field defines the duration for the Duration target met dimension. The duration target unit — milliseconds, seconds, minutes, hours, days — depends on the value in Duration unit. Adding Duration target as a dashboard filter allows you to dynamically change the target duration dimension. | ||
Duration unit | This filter-only field defines the duration unit — milliseconds, seconds, minutes, hours, days — for duration measures. By default, this is milliseconds. Adding Duration unit as a dashboard filter allows you to dynamically change duration units. | ||
Offset unit | This filter-only field defines the duration unit — milliseconds, seconds, minutes, hours, days — for offset measures. By default, this is milliseconds. Adding Offset unit as a dashboard filter allows you to dynamically change offset units. | ||
Dimensions | |||
Conversation | |||
ID | The unique identifier for the conversation. A conversation can contain multiple interactions, for example, an inbound call, a queued callback, and a subsequent callback attempt. | ||
Interaction | |||
Connect from | The address of the party that initiated the interaction; the source of the interaction. For a call, the address is a phone number. For a non-call interaction, the address changes based upon the media type. For example, the address may be an email address for cases.
| ||
Connect to | The address of the party being contacted by the interaction; the target of the interaction. For a call, the address is a phone number. For a non-call interaction, the address changes based upon the media type. For example, the address may be an email address for cases.
| ||
ID | The unique identifier for the interaction. | ||
Initial direction | The direction of the interaction when it started — one of Inbound (initiated by an external party), Outbound (initiated by an agent to an external party), or Internal (initiated by an agent to another agent). | ||
Interaction plan | The name of the first interaction plan the interaction entered. | ||
Interaction plan mapping | The name of the mapping that connected the interaction's initial destination to the first interaction plan. | ||
Media manager | The origin of an interaction — one of VBC, VCC, Salesforce, or SkypeForBusiness (depending on features enabled for the account). | ||
Media type | The means of communication used for the interaction. For example, Phone, Email, or External Work. | ||
Outcome | The computed outcome of the interaction — one of:
| ||
Service name | If you are using Interaction Plans Manager:
Otherwise:
| ||
Status | The processing status of an interaction — one of Ongoing (the interaction is still being processed), Completed (the interaction has been processed), or InternalError (an error occurred during processing). | ||
Interaction - start bucket | |||
1 hour | The hour of the day in which the interaction started. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example 11. | ||
Day of week | The day of the week on which the interaction started. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, Wednesday. This dimension is commonly used to filter out interactions over the weekend. | ||
Month (name) | The name of the month in which the interaction started. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, July. | ||
Time of day | The time at which the interaction started to the nearest minute. In hh:mm format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 19:36. | ||
Year | The year in which the interaction started. In YYYY format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2022. | ||
Interaction - start date | |||
15 min | The date and time at which the interaction started, rounded down to the nearest 15 minute period. In YYYY-MM-DD hh:mm format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2021-07-31 19:15. | ||
Date | The date on which the interaction started. In YYYY-MM-DD format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2021-07-31. | ||
Month | The month in which the interaction started. In YYYY-MM format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2021-07. | ||
Quarter | The quarter of the year in which the interaction started. In YYYY-Qx format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2022-Q3 | ||
Time | The exact date and time at which the interaction started to the nearest second. In YYYY-MM-DD hh:mm:ss format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2021-07-31 19:36:45. | ||
Week | The Monday of the week in which the interaction started. In YYYY-MM-DD format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2021-07-26. | ||
Interaction channel | |||
Agent ID | If Role is 'Agent', this is the unique identifier for the agent. This is the ID of the agent as defined in User Admin in the VCC admin portal during agent creation. If Role is 'External' and the interaction went through a Call Connect Router applet, Agent ID is 'CCRConnect', otherwise the Agent ID is null. If Role is 'Monitor', Agent ID is null. | ||
End reason | The reason the channel ended — one of:
| ||
ID | The unique identifier for the channel. | ||
Initiating agent ID | The unique identifier for the agent who initiated a consult or transfer. | ||
Initiating reason | The reason the channel began — one of:
| ||
Role | The role of the party in the channel — one of External, Agent, or Monitor. | ||
Sequence | The order in which the party in the channel joined the call or non-call interaction. Sequence is zero-based — the first party to join the interaction is 0. | ||
Touchpoint | The address of the party in the channel, such as a phone number or email address (if known). For secure payment channels, the value is AgentAssist. | ||
Interaction event | |||
Applet type | The type of applet that the interaction entered at the time of the event. To get only records with a value in this dimension, filter by Interaction Events Type equals 'Applet'. | ||
Audio problem | The problem with the audio that the agent reported during the interaction event. If available, Audio problem will be one of the following values: Too loud, Too quiet, Echo, Distortion, Background noise, Delay, Other. If an agent reported multiple problems with the same interaction, those problems will appear in Audio problem for other interaction events. Value is only populated for phone type interactions — it is null for any interactions that are not calls. For information about audio problems, see Reporting problems in ContactPad. To get only records with a value in this dimension, filter by Interaction Events Type equals 'AudioProblemReported'. | ||
Call rating | The rating that the agent gave the interaction. If available, Call rating is a number 1–5. Value is only populated for phone type interactions — it is null for any interactions that are not calls. For information about call ratings, see Post Call Quality Rating in ContactPad. To get only records with a value in this dimension, filter by Interaction Events Type equals 'CallRating'. | ||
Data source value | The value of a data source associated with the interaction. Only available when a data source has been mapped using Data Source Mapping. For information about data source mapping, see Data Source Mappings. To get only records with a value in this dimension, filter by Interaction Events Type equals 'DataSourceValueAquired'. | ||
Disposition | The outcome of the interaction set by the agent. For information about disposition codes, see Disposition codes. To get only records with a value in this dimension, filter by Interaction Events Type equals 'Disposition'. | ||
Duration | The length of the event. Unit is determined by filter-only field Duration unit. By default, in milliseconds. Duration for some event types is always 0. | ||
Duration (time) | The time that the event lasted to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Duration target met | Indicates whether the duration of the event is within the duration defined in Duration target filter — either 'Yes' or 'No'. | ||
End offset | The total time after the start of the interaction that the event ended. Unit is determined by filter-only field Offset unit. By default, in milliseconds. | ||
End offset (time) | The duration after the start of the interaction that the event ended in [h]:mm:ss format. | ||
Initiating agent ID | The unique identifier for the agent who caused the event. Currently only available when an agent puts an interaction on hold. | ||
Monitor type | The type of the monitoring for particular event — one of:
| ||
Name | The name of the queue, applet, interaction plan, or data source in events of the respective types. | ||
Sequence | The order in which the event started within its channel. Sequence is zero-based — the first event to start is 0. | ||
Start offset | The total time after the start of the interaction that the event started. Unit is determined by filter-only field Offset unit. By default, in milliseconds. | ||
Start offset (time) | The total time after the start of the interaction that the event started to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Subtype | The subtype of a Held event — one of:
| ||
Type | The type of event. Possible values are:
| ||
Interaction event - end bucket | |||
1 hour | The hour of the day in which the event ended. For example 11. | ||
15 minutes | The time at which the event ended, rounded down to the nearest 15 minute period. In hh:mm format. For example, 19:15. | ||
Day of week | The day of the week on which the event ended. For example, Wednesday. This dimension is commonly used to filter out events over the weekend. | ||
Month (name) | The name of the month in which the event ended. For example, July. | ||
Time of day | The time at which the event ended to the nearest minute. In hh:mm format. For example, 19:36. | ||
Year | The year in which the event ended.In YYYY format. For example, 2022. | ||
Interaction event - end date | |||
15 min | The date and time at which the event ended, rounded down to the nearest 15 minute period. In YYYY-MM-DD hh:mm format. For example, 2021-07-31 19:15. | ||
Date | The date on which the event ended in YYYY-MM-DD format. For example, 2021-07-31. | ||
Month | The month in which the event ended. In YYYY-MM format. For example, 2021-07. | ||
Quarter | The quarter of the year in which the event ended. In YYYY-Qx format. For example, 2022-Q3 | ||
Time | The exact date and time at which the event ended to the nearest second. In YYYY-MM-DD hh:mm:ss format. For example, 2021-07-31 19:36:45. | ||
Week | The Monday of the week in which the event ended. In YYYY-MM-DD format. For example, 2021-07-26. | ||
Year | The year in which the event ended. In YYYY format. For example, 2022. | ||
Interaction event - queue | |||
Presented skills | The skills that an interaction was tagged with when it entered this queue. Multiple values are sorted alphabetically and separated by commas. Duplicates are removed. | ||
Queue name | The name of the queue. | ||
Result | The outcome of a queue event. Possible values are:
| ||
Virtual queues | The virtual queues that the interaction entered. Multiple values are separated by commas. | ||
Interaction event - start bucket | |||
15 minutes | The year in which the event started. In YYYY format. For example, 2022. | ||
1 hour | The hour of the day in which the event started. For example 11. | ||
Day of week | The time at which the event ended, rounded down to the nearest 15 minute period. In hh:mm format. For example, 19:15. | ||
Month (name) | The day of the week on which the event started. For example, Wednesday. This dimension is commonly used to filter out events over the weekend. | ||
Time of day | The name of the month in which the event started. For example, July. | ||
Year | The time at which the event started to the nearest minute. In hh:mm format. For example, 19:36. | ||
Interaction event - start date | |||
15 min | The date and time at which the event started, rounded down to the nearest 15 minute period. In YYYY-MM-DD hh:mm format. For example, 2021-07-31 19:15. | ||
Date | The date on which the event started in YYYY-MM-DD format. For example, 2021-07-31. | ||
Month | The month in which the event started. In YYYY-MM format. For example, 2021-07. | ||
Quarter | The quarter of the year in which the event started. In YYYY-Qx format. For example, 2022-Q3 | ||
Time | The exact date and time at which the event started to the nearest second. In YYYY-MM-DD hh:mm:ss format. For example, 2021-07-31 19:36:45. | ||
Week | The Monday of the week in which the event started. In YYYY-MM-DD format. For example, 2021-07-26. | ||
Year | The year in which the event started. In YYYY format. For example, 2022. | ||
Measures | |||
Event count | The number of events included in selected dimensions. | ||
Event duration | |||
Average | The average duration of selected events. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
Maximum | The duration of the longest selected event. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
Minimum | The duration of the shortest selected event. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
Total | The total duration of selected events. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
Event duration (time) | |||
Average | The average duration of selected events to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Maximum | The duration of the longest selected event to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Minimum | The duration of the shortest selected event to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Total | The total duration of selected events to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Event duration percentile | |||
2nd | The time that 2% of all selected events were completed within Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
25th | The time that 25% of all selected events were completed within. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
50th | The time that 50% of all selected events were completed within. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
75th | The time that 75% of all selected events were completed within. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
90th | The time that 90% of all selected events were completed within. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
98th | The time that 98% of all selected events were completed within. Unit is determined by filter-only field Duration unit. By default, in milliseconds. | ||
Event duration percentile (time) | |||
2nd | The time that 2% of all selected events were completed within to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
25th | The time that 25% of all selected events were completed within to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
50th | The time that 50% of all selected events were completed within to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
75th | The time that 75% of all selected events were completed within to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
90th | The time that 90% of all selected events were completed within to the nearest second. In hh:mm:ss format. or example, 01:32:54. | ||
98th | The time that 98% of all selected events were completed within to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Event end date | |||
Maximum | The end date and time of the most recent selected event to the nearest minute. In YYYY-MM-DD hh:mm format. For example, 2021-07-31 19:15. | ||
Minimum | The end date and time of the least recent selected event to the nearest minute. In YYYY-MM-DD hh:mm format. For example, 2021-07-31 19:15. | ||
Event offset | |||
Average | The average time after the start of the interaction that the selected events started. Unit is determined by filter-only field Offset unit. By default, in milliseconds. | ||
Maximum | The maximum time after the start of the interaction that the selected events started. Unit is determined by filter-only field Offset unit. By default, in milliseconds. | ||
Minimum | The minimum time after the start of the interaction that the selected events started. Unit is determined by filter-only field Offset unit. By default, in milliseconds. | ||
Total | The total time after the start of the interaction that the selected events started. Unit is determined by filter-only field Offset unit. By default, in milliseconds. | ||
Event offset (time) | |||
Average | The average time after the start of the interaction that the selected events started to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Maximum | The maximum time after the start of the interaction that the selected events started to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Minimum | The minimum time after the start of the interaction that the selected events started to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Total | The total time after the start of the interaction that the selected events started to the nearest second. In hh:mm:ss format. For example, 01:32:54. | ||
Event start date | |||
Maximum | The start date and time of the most recent selected event to the nearest minute. In YYYY-MM-DD hh:mm format. For example, 2021-07-31 19:15. | ||
Minimum | The start date and time of the least recent selected event to the nearest minute. In YYYY-MM-DD hh:mm format. For example, 2021-07-31 19:15. | ||
Handle time | The total approximate time agents spent working on interactions to the nearest second. Unit is determined by filter-only field Duration unit. By default, in milliseconds. If multiple agents have handled the interactions, all agents' handle time in relation to the interactions is included. Handle time includes the time agents have spent in alerting, connected, and wrap states, for interactions where an agent connected. For example, 5574000. | ||
Handle time (time) | The total approximate time agents spent working with interactions to the nearest second. Unit is determined by filter-only field Duration unit. By default, in hh:mm:ss format. If multiple agents have handled the interactions, all agents' handle time in relation to the interactions is included. Handle time includes the time agents have spent in alerting, connected, and wrap states, for interactions where an agent connected. For example, 01:32:54. | ||
Interaction count | The number of interactions included in selected dimensions. | ||
Interaction start date | |||
Maximum | The start date and time of the most recent selected interaction to the nearest minute. In YYYY-MM-DD hh:mm format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2021-07-31 19:15. | ||
Minimum | The start date and time of the least recent selected interaction to the nearest minute. In YYYY-MM-DD hh:mm format. For an inbound interaction, this is when it arrived in VCC. For an outbound or internal interaction, this is when the agent initiated it. For example, 2021-07-31 19:15. |
Virtual Assistant fields
Type | Group | Name | Description |
---|---|---|---|
Dimensions | |||
Interaction event | |||
Chat messages (count) | The number of chat messages handled by the virtual agent. | ||
Result | The result indicates the status of the Virtual Agent session in Vonage AI Studio and can be one of three states: Resolved, Escalated, or Abandoned. | ||
Measures | |||
[Virtual assistants] Chat messages (count) | |||
Average | The average number of messages sent or received during a chat-based virtual agent session. | ||
Maximum | The maximum number of messages sent or received during a chat-based virtual agent session. | ||
Minimum | The minimum number of messages sent or received during a chat-based virtual agent session. | ||
Total | The total number of messages sent or received during all chat-based virtual agent sessions. | ||
[Virtual Assistants] Entries (count) | |||
Average | The average number of times an interaction connected to a virtual agent. | ||
Maximum | The maximum number of times an interaction connected to a virtual agent. | ||
Minimum | The minimum number of times an interaction connected to a virtual agent. | ||
Total | The total number of times an interaction connected to a virtual agent. | ||
[Virtual Assistants] Time in virtual assistant (duration) | |||
Average | The average duration of virtual agent sessions in milliseconds. | ||
Maximum | The duration of the longest virtual agent session in milliseconds. | ||
Minimum | The duration of the shortest virtual agent session in milliseconds. | ||
Total | The total duration of virtual agent sessions in milliseconds. | ||
[Virtual Assistants] Time in virtual assistant (hh:mm:ss) | |||
Average | The average duration of virtual agent sessions in hh:mm:ss format. | ||
Maximum | The duration of the longest virtual agent session in hh:mm:ss format. | ||
Minimum | The duration of the shortest virtual agent session in hh:mm:ss format. | ||
Total | The total duration of virtual agent sessions in hh:mm:ss format. | ||
[Virtual Assistants] Time to abandon (duration) | |||
Average | The average duration of abandoned virtual agent sessions in milliseconds. | ||
Maximum | The duration of the longest abandoned virtual agent session in milliseconds. | ||
Minimum | The duration of the shortest abandoned virtual agent session in milliseconds. | ||
Total | The total duration of abandoned virtual agent sessions in milliseconds. | ||
[Virtual Assistants] Time to abandon (hh:mm:ss) | |||
Average | The average duration of abandoned virtual agent sessions in hh:mm:ss format. | ||
Maximum | The duration of the longest abandoned virtual agent session in hh:mm:ss format. | ||
Minimum | The duration of the shortest abandoned virtual agent session in hh:mm:ss format. | ||
Total | The total duration of abandoned virtual agent sessions in hh:mm:ss format. | ||
[Virtual Assistant] Time to escalate (duration) | |||
Average | The average duration of escalated virtual agent sessions in milliseconds. | ||
Maximum | The duration of the longest escalated virtual agent session in milliseconds. | ||
Minimum | The duration of the shortest escalated virtual agent session in milliseconds. | ||
Total | The total duration of escalated virtual agent sessions in milliseconds. | ||
[Virtual Assistants] Time to escalate (hh:mm:ss) | |||
Average | The average duration of escalated virtual agent sessions in hh:mm:ss format. | ||
Maximum | The duration of the longest escalated virtual agent session in hh:mm:ss format. | ||
Minimum | The duration of the shortest escalated virtual agent session in hh:mm:ss format. | ||
Total | The total duration of escalated virtual agent sessions in hh:mm:ss format. | ||
[Virtual Assistants] Time to resolve (duration) | |||
Average | The average duration of resolved virtual agent sessions in milliseconds. | ||
Maximum | The duration of the longest resolved virtual agent session in milliseconds. | ||
Minimum | The duration of the shortest resolved virtual agent session in milliseconds. | ||
Total | The total duration of resolved virtual agent sessions in milliseconds. | ||
[Virtual Assistants] Time to resolve (hh:mm:ss) | |||
Average | The average duration of resolved virtual agent sessions in hh:mm:ss format. | ||
Maximum | The duration of the longest resolved virtual agent session in hh:mm:ss format. | ||
Minimum | The duration of the shortest resolved virtual agent session in hh:mm:ss format. | ||
Total | The total duration of resolved virtual agent sessions in hh:mm:ss format. |
For general assistance, please contact Customer Support.
For help using this documentation, please send an email to docs_feedback@vonage.com. We're happy to hear from you. Your contribution helps everyone at Vonage! Please include the name of the page in your email.