Skip to main content
POST
Get Interaction Multi Aggregates
You need an API key to authenticate. See here for more information about the API keys.
object
required
The time range to consider when computing the metrics and analytics to show.
object[]
required
Filters you can use to get data based only on the interactions you are interested in.
object[][]
You can use group_by filters to aggregate data according to your preferences. This endpoint allows you to get data aggregated in different ways with a single call.For example, if you want both negative_intent and intents in a single API call, you can set the group_by_groups value to the following list:
The inner lists can specify additional groupings for splitting your data. Suppose you want to get both intent and negative_user_intent further split by topic. In this case, your request should include the field as:
string[]
The variables for which values are required. If not specified, all available variables will be computed. The supported variables are
  • n_interactions
  • n_users
  • user_feedback
  • cost
  • latency_seconds
  • n_intents
  • retention
integer
required
Parameter needed for pagination. It indicates the number of rows per page.
integer
required
Parameter needed for pagination. It indicates the offset to be applied to the first rows returned.

Response

integer
Needed for pagination. The total number of rows available.
integer
Needed for pagination. It indicates the offset to be applied to the first rows returned.
integer
Needed for pagination. It indicates the number of rows per page.
object[]
The data aggregated using the given group_by field.