Skip to content

Interactions Object ​



id
string
REQUIRED · 

The unique identifier for the interaction record

user
object

The user the interaction record belongs to

id
string
REQUIRED · 

The unique identifier for the user

name
string

Name of the user

emails
object[]

List of email addresses of the user

email
string

Email address of the user

is_primary
boolean

Whether the email address is the primary email address of the user

start_time
string · date-time

Start of the aggregation period in ISO 8601 format

end_time
string · date-time

End of the aggregation period in ISO 8601 format

timezone
string

Time zone used for the aggregation period in the source system

aggregation_period
string

Granularity of the aggregation.

All possible enum values:
  • day
  • week
  • month
  • total
metrics
object

Standard interaction metrics for the user in the period

longest_monologue
number

Longest monologue duration or score for the user in the period

longest_customer_story
number

Longest customer story duration or score for the user in the period

interactivity
number

Interactivity score for the user in the period

patience
number

Patience score for the user in the period

question_rate
number

Question rate for the user in the period

additional_metrics
object[]

Additional interaction metrics from the source when they do not map to the standard metrics object. Use for forward-compatible or vendor-specific metrics.

name
string

Name of the interaction metric in the source system

value
number

Value of the interaction metric

created_at
string · date-time

When the interaction record was created in the source system

updated_at
string · date-time

When the interaction record was last updated in the source system

remote_data
object

Raw data returned from the remote API call.