Get CX AI
Leveraging the unique interactionIdentifier provided upon successfully declaring the audio, transcript, or chat interaction, this endpoint enables you to instantly retrieve CX AI analysis outputs.
When this GET request successfully executes, an HTTP status will be returned to indicate the request was successful, along with a JSON response providing detailed CX AI output.
If an error occurs when requesting to declare the interaction, a standard HTTP status will be retuned to indicate the request was unsuccessful, along with a JSON response containing additional details to assist in troubleshooting.
Element | Type | Description |
{participant} | object | Top level for speaker label, identifying whether output was determined based on speech across "allParticipants", "participantOne", or "participantTwo" |
{participant}/enlightenBundles | array of objects | Top level for each eligible AI behavioral model |
{participant}/enlightenBundles/name | string | Name of Enlighten Bundle associated with model, will be "Customer Satisfaction" or "Vulnerable Customer" |
{participant}enlightenBundles/models | array of objects | Ordered list of analysis outputs associated with each available model from bundle |
{participant}/enlightenBundles/models/name | string | Name of model |
{participant}/enlightenBundles/models/score | float | Overall score |
{participant}/enlightenBundles/models/minScore | float | Lowest score calculated throughout interaction |
{participant}/enlightenBundles/models/minScoreOffset | number | Time of lowest score calculated throughout interaction |
{participant}/enlightenBundles/models/maxScore | float | Highest score calculated throughout interaction |
{participant}/enlightenBundles/models/maxScoreOffset | number | Time of highest score calculated throughout interaction |
{participant}/enlightenBundles/models/quartile1 | float | Score calculated across first quartile of interaction |
{participant}/enlightenBundles/models/quartile2 | float | Score calculated across second quartile of interaction |
{participant}/enlightenBundles/models/quartile3 | float | Score calculated across third quartile of interaction |
{participant}/enlightenBundles/models/quartile4 | float | Score calculated across fourth quartile of interaction |
{participant}/voiceActivitySegments | array of objects or null | Top level for each "voice" or "silence" segment |
{participant}/voiceActivitySegments/startTimeOffset | number | Start time of segment |
{participant}/voiceActivitySegments/endTimeOffset | number | End time of segment |
{participant}/voiceActivitySegments/result | string | Type of segment, will be "voice" or "silence" |