POST
/
api
/
external
/
get-interaction-multi-aggregates

You need an API key to authenticate. See here for more information about the API keys.

time_range
object
required

The time range to consider when computing the metrics and analytics to show.

filters
object[]
required

Filters you can use to get data based only on the interactions you are interested in.

group_by_groups
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:

[[{kind: user_intent}], [{kind: negative_user_intent}]]

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:

[[{kind: user_intent}, {kind: topic}], [{kind: negative_user_intent}, {kind: topic}]]
variables
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
limit
integer
required

Parameter needed for pagination. It indicates the number of rows per page.

offset
integer
required

Parameter needed for pagination. It indicates the offset to be applied to the first rows returned.

Response

total
integer

Needed for pagination. The total number of rows available.

offset
integer

Needed for pagination. It indicates the offset to be applied to the first rows returned.

limit
integer

Needed for pagination. It indicates the number of rows per page.

data
object[]

The data aggregated using the given group_by field.