API Reference
Home
Start typing to search…

Retrieve insights for multiple conversations

get https://api.cuein.ai/insights/v1/conversations

Retrieve paginated conversation insights records based on date range as input

Query Params
date-time
required

Starting time frame value ('YYYY-MM-DD' or 'YYYY-MM-DD HH:mm:SS') for filtering conversation records on the processing timestamp by Cuein

date-time
required

Ending time frame value ('YYYY-MM-DD' or 'YYYY-MM-DD HH:mm:SS') for filtering conversation records on the processing timestamp by Cuein

string

Token to use for next batch lookup (empty returns the first batch of records)

int64
required

Limit of results to return (default system limits exist)

Responses

Response body
object
meta
object

data about returned results

int64

count of conversation insights records returned

string

token to be used for the next batch call (if not present, there are no more results)

conversations
array of objects

list of conversation insights records

conversations
object
string

unique customer dataset specific id (caseId/transcriptId)

string

summary for the entire conversation

date-time

Returns the timestamp of the last message in the conversation

date-time

Returns processing timestamp by Cuein for the conversation

additionalId
array of objects

list of additional identifiers for the conversation

additionalId
object
string

Name of a specific id/key

contactId

string

Value for the id key

intents
array of objects

list of contact reasons/user intents for which user is seeking support/assistance

intents
object
string

short description for the specific insight

int64

index of the utterance in the conversation/case (starting from 1)

string

optional reference to the message id in the conversation (if provided)

categories
array of objects

one or more cluster categories the insight belongs to

categories
object
string
required

Cluster label the insight is part of

number

Cluster score between 0 & 1 for insight association with specific cluster label

string

a short label for the insight (for outlier insights not part of existing clusters)

rootCauses
array of objects

list of root causes for the contact reasons/user intents

rootCauses
object
string

short description for the specific insight

int64

index of the utterance in the conversation/case (starting from 1)

string

optional reference to the message id in the conversation (if provided)

categories
array of objects

one or more cluster categories the insight belongs to

categories
object
string
required

Cluster label the insight is part of

number

Cluster score between 0 & 1 for insight association with specific cluster label

string

a short label for the insight (for outlier insights not part of existing clusters)

resolutions
array of objects

list of resolutions provided by bot or agent for providing support/assistance

resolutions
object
string

short description for the specific insight

int64

index of the utterance in the conversation/case (starting from 1)

string

optional reference to the message id in the conversation (if provided)

categories
array of objects

one or more cluster categories the insight belongs to

categories
object
string
required

Cluster label the insight is part of

number

Cluster score between 0 & 1 for insight association with specific cluster label

string

a short label for the insight (for outlier insights not part of existing clusters)

policies
array of objects

list of policies associated with the session

policies
object
string

short description for the specific insight

int64

index of the utterance in the conversation/case (starting from 1)

string

optional reference to the message id in the conversation (if provided)

categories
array of objects

one or more cluster categories the insight belongs to

categories
object
string
required

Cluster label the insight is part of

number

Cluster score between 0 & 1 for insight association with specific cluster label

string

a short label for the insight (for outlier insights not part of existing clusters)

metrics
array of objects

AI driven annotations/metrics for the conversation session

metrics
object
string

Name for a specific annotation/metric

deflection inferredCSAT effortScore resolved abandoned frustration confusion nextSteps transferEscalation empathy

AI generated values for various metric values

botMetrics
array of objects

AI driven annotations/metrics for the chatbot section of the conversation session, if any

botMetrics
object
string

Name for a specific annotation/metric

deflection inferredCSAT effortScore resolved abandoned frustration confusion nextSteps transferEscalation empathy

AI generated values for various metric values

agentMetrics
array of objects

AI driven annotations/metrics for the agent section of the conversation session, if any

agentMetrics
object
string

Name for a specific annotation/metric

deflection inferredCSAT effortScore resolved abandoned frustration confusion nextSteps transferEscalation empathy

AI generated values for various metric values

sourceMetadata
object

Selected key-value tags from original source metadata

Has additional fields
400

Invalid Request Payload

401

Authentication Failure

500

Internal Cuein Error

Updated about 1 month ago

Did this page help you?
Language
Credentials

Updated about 1 month ago

Did this page help you?