Calculate a conversation metric
Calculates an aggregate metric from conversation logs for the selected account and time range. Results can also include time buckets and, for eligible reseller accounts, organization or agent comparisons. Use the normal conversation logs endpoint to inspect the records behind a metric.
Authorizations
Vida API Token
Body
Account whose authorized conversation data should be analyzed.
Inclusive start of the range as Unix seconds.
Inclusive end of the range as Unix seconds. Must be after startAt.
Metric calculation applied to each matching conversation log.
Include metric values grouped into time buckets.
Add ranked group results. Organization and agent grouping are available when the selected account has access to those account levels.
none, organization, agent Organization subset used for reseller-level grouped metrics.
Match organization or agent names in grouped results.
100Field used to order grouped results.
metricValue, eventCount Sort direction for grouped results.
asc, desc Group-result page number.
x >= 1Number of grouped results per page.
1 <= x <= 100Recalculate instead of using a recent identical result.
Response
Metric calculated successfully
true
Metric value across every matching conversation.
Sum used to calculate the aggregate.
Number of matching conversation records.
x >= 0Requested minimum sample size, when supplied.
x >= 1Whether the aggregate meets the requested minimum sample size.
Metric values keyed by Unix-second bucket start.
Matching record counts by bucket when a minimum sample size is used.
Organization or agent comparisons when groupBy is enabled.
Present when grouped results are requested.