curl --request POST \
--url https://backend.nebuly.com/api/external/get-interaction-aggregates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"time_range": {
"start": "<string>",
"end": "<string>"
},
"filters": [
{
"kind": "<string>",
"tag": "<string>",
"values": [
"<string>"
],
"is_exclude": true
}
],
"group_by": {
"kind": "<string>",
"tag": "<string>",
"field": "<string>"
},
"variables": [
"<string>"
],
"additional_group_bys": [
{
"kind": "<string>"
}
],
"limit": 123,
"offset": 123
}'
{
"total": 123,
"offset": 123,
"limit": 123,
"data": [
{
"group_name": "<string>",
"n_interactions": 123,
"n_users": 123,
"n_feedback": 123,
"n_positive_implicit_user_feedback": 123,
"n_negative_implicit_user_feedback": 123,
"n_positive_explicit_user_feedback": 123,
"n_negative_explicit_user_feedback": 123,
"n_users_negative": 123,
"n_users_negative_implicit": 123,
"n_users_negative_explicit": 123,
"explicit_feedback_ratio": 123,
"n_paste_output": 123,
"n_interactions_negative": 123,
"n_interactions_negative_implicit": 123,
"n_interactions_negative_explicit": 123,
"n_conversations_positive_explicit": 123,
"n_conversations_negative_explicit": 123,
"n_intents": 123,
"cost": 123,
"latency_seconds": 123,
"retention": 123,
"topics": [
"<string>"
],
"session_time": 123,
"session_length": 123,
"start_session": "<string>",
"end_session": "<string>",
"percentage_negative_feedback": 123,
"percentage_negative_feedback_explicit": 123,
"conversation_percentage_negative_feedback": 123,
"conversation_percentage_negative_feedback_explicit": 123,
"sentiment_score": 123,
"conversation_sentiment_score": 123,
"n_positive_messages": 123,
"n_negative_messages": 123,
"n_topics": 123,
"n_topics_conversations": 123,
"n_user_actions": 123,
"n_user_actions_conversations": 123,
"n_negative_intent": 123,
"n_keywords": 123,
"n_data_sources": 123,
"n_emotions": 123,
"tags": [
{
"tag_name": "<string>",
"n_tag_values": 123
}
],
"bounce_rate": 123,
"penetration": 123,
"user_rating": 123
}
]
}
curl --request POST \
--url https://backend.nebuly.com/api/external/get-interaction-aggregates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"time_range": {
"start": "<string>",
"end": "<string>"
},
"filters": [
{
"kind": "<string>",
"tag": "<string>",
"values": [
"<string>"
],
"is_exclude": true
}
],
"group_by": {
"kind": "<string>",
"tag": "<string>",
"field": "<string>"
},
"variables": [
"<string>"
],
"additional_group_bys": [
{
"kind": "<string>"
}
],
"limit": 123,
"offset": 123
}'
{
"total": 123,
"offset": 123,
"limit": 123,
"data": [
{
"group_name": "<string>",
"n_interactions": 123,
"n_users": 123,
"n_feedback": 123,
"n_positive_implicit_user_feedback": 123,
"n_negative_implicit_user_feedback": 123,
"n_positive_explicit_user_feedback": 123,
"n_negative_explicit_user_feedback": 123,
"n_users_negative": 123,
"n_users_negative_implicit": 123,
"n_users_negative_explicit": 123,
"explicit_feedback_ratio": 123,
"n_paste_output": 123,
"n_interactions_negative": 123,
"n_interactions_negative_implicit": 123,
"n_interactions_negative_explicit": 123,
"n_conversations_positive_explicit": 123,
"n_conversations_negative_explicit": 123,
"n_intents": 123,
"cost": 123,
"latency_seconds": 123,
"retention": 123,
"topics": [
"<string>"
],
"session_time": 123,
"session_length": 123,
"start_session": "<string>",
"end_session": "<string>",
"percentage_negative_feedback": 123,
"percentage_negative_feedback_explicit": 123,
"conversation_percentage_negative_feedback": 123,
"conversation_percentage_negative_feedback_explicit": 123,
"sentiment_score": 123,
"conversation_sentiment_score": 123,
"n_positive_messages": 123,
"n_negative_messages": 123,
"n_topics": 123,
"n_topics_conversations": 123,
"n_user_actions": 123,
"n_user_actions_conversations": 123,
"n_negative_intent": 123,
"n_keywords": 123,
"n_data_sources": 123,
"n_emotions": 123,
"tags": [
{
"tag_name": "<string>",
"n_tag_values": 123
}
],
"bounce_rate": 123,
"penetration": 123,
"user_rating": 123
}
]
}
variables
field in the request body.group_by
field to aggregate results by various dimensions—for example, by intent
or positive_implicit_feedback
.group_by
is provided, the response returns overall totals across all interactions.
You need an API key to authenticate. See here for more information about the API keys.
Show properties
kind
is "topic"
and the values are "value A"
and "value B"
,topic="value A"
OR topic="value B"
.group_name
in the response.Show properties
Show child attributes
percentage_negative_feedback
, but calculated at the conversation level, meaning it considers the entire conversation rather than individual interactions.percentage_negative_feedback_explicit
, but calculated at the conversation level, meaning it considers the entire conversation rather than individual interactions.conversation_id
filter is applied, n_tag_values will return the distinct tags with their distinct values rather than countgroup_by
filters to further refine the aggregations.group_by
Show properties
Show properties
group_by
filter.percentage_negative_feedback
, but calculated at the conversation level, meaning it considers the entire conversation rather than individual interactions for the selected group.percentage_negative_feedback_explicit
, but calculated at the conversation level, meaning it considers the entire conversation rather than individual interactions for the selected group.