List Interactions
/unified/conversational-intelligence/interactions
Query Parameters
Refer Specifying query parameters in Truto APIs
Start of the interaction period
1 supported1 required
End of the interaction period
1 supported1 required
Filter by one or more users
1 supported
The unique identifier of the user
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount).debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
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.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
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.
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.
List of Interactions
The unique identifier for the interaction record
1 supported
Additional interaction metrics from the source when they do not map to the standard metrics object. Use for forward-compatible or vendor-specific metrics.
1 supported
2 properties
Name of the interaction metric in the source system
Value of the interaction metric
Granularity of the aggregation.
dayweekmonthtotal
1 supported
When the interaction record was created in the source system
End of the aggregation period in ISO 8601 format
1 supported
Standard interaction metrics for the user in the period
1 supported
5 properties
Interactivity score for the user in the period
Longest customer story duration or score for the user in the period
Longest monologue duration or score for the user in the period
Patience score for the user in the period
Question rate for the user in the period
Raw data returned from the remote API call.
Start of the aggregation period in ISO 8601 format
1 supported
Time zone used for the aggregation period in the source system
1 supported
When the interaction record was last updated in the source system
The user the interaction record belongs to
1 supported
3 properties
The unique identifier for the user
List of email addresses of the user
2 properties
Email address of the user
Whether the email address is the primary email address of the user
Name of the user
truto unified conversational-intelligence interactions \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'conversational-intelligence',
'interactions',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"conversational-intelligence",
"interactions",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/conversational-intelligence/interactions?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/conversational-intelligence/interactions?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/conversational-intelligence/interactions"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())