Appearance

List Interactions ​

Endpoint ​

http
GET /unified/conversational-intelligence/interactions
Integrations supported
  • Gong

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
start_time
string · date-time

Start of the interaction period

Required in
  • Gong
end_time
string · date-time

End of the interaction period

Required in
  • Gong
users
array

Filter by one or more users

Supported in
  • Gong

Response Body ​

result
object[]

List of Interactions

id
string
REQUIRED · 

The unique identifier for the interaction record

Supported in
  • Gong
user
object

The user the interaction record belongs to

Supported in
  • Gong
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

Supported in
  • Gong
end_time
string · date-time

End of the aggregation period in ISO 8601 format

Supported in
  • Gong
timezone
string

Time zone used for the aggregation period in the source system

Supported in
  • Gong
aggregation_period
string

Granularity of the aggregation.

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

Standard interaction metrics for the user in the period

Supported in
  • Gong
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.

Supported in
  • Gong
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.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

debug
object

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. null for static responses or when truto_skip_api_call=true.

requestUrl
string
requestOptions
object
data
responseHeaders
object
nextCursor
string
isLooping
boolean
isEmptyResult
boolean
resultCount
number