Get Interaction Aggregates
This endpoint returns aggregate values among interactions. The returned aggregates are:
- number of interactions
- number of users
- number of positive implicit feedback
- number of positive explicit feedback
- number of negative implicit feedback
- number of negative explicit feedback
Using the optional group by field you can aggregate the interaction on different view, e.g. grouping by “intent” or “positive_implicit_feedback”.
You need an API key to authenticate. See here for more information about the API keys.
The time range to consider when computing the metrics and analytics to show.
Filters you can use to get data based only on the interactions you are interested in.
Filters you can use to get data based only on the interactions you are interested in. If no value is give, the total aggregated values among the desired interactions are returned.
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
Optional additional group by
filters. These group by
filters can be used to further refine the aggregations, splitting the selected variables for the main group by
into more detailed categories using the additional filters.
Parameter needed for pagination. It indicates the number of rows per page.
Parameter needed for pagination. It indicates the offset to be applied to the first rows returned.
Response
Needed for pagination. The total number of rows available.
Needed for pagination. It indicates the offset to be applied to the first rows returned.
Needed for pagination. It indicates the number of rows per page.
The data aggregated using the given group_by field.