Skip to content

Interactions Object

Properties

idstring
required·

The unique identifier for the interaction record

additional_metricsobject[]

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

namestring

Name of the interaction metric in the source system

valuenumber

Value of the interaction metric

aggregation_periodstring

Granularity of the aggregation.

Possible values:
dayweekmonthtotal
created_atstring · date-time

When the interaction record was created in the source system

end_timestring · date-time

End of the aggregation period in ISO 8601 format

metricsobject

Standard interaction metrics for the user in the period

interactivitynumber

Interactivity score for the user in the period

longest_customer_storynumber

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

longest_monologuenumber

Longest monologue duration or score for the user in the period

patiencenumber

Patience score for the user in the period

question_ratenumber

Question rate for the user in the period

remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_timestring · date-time

Start of the aggregation period in ISO 8601 format

timezonestring

Time zone used for the aggregation period in the source system

updated_atstring · date-time

When the interaction record was last updated in the source system

userobject

The user the interaction record belongs to

idstring
required·

The unique identifier for the user

emailsobject[]

List of email addresses of the user

2 properties
emailstring

Email address of the user

is_primaryboolean

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

namestring

Name of the user