Skip to main content
POST
Calculate a conversation metric

Authorizations

token
string
query
required

Vida API Token

Body

application/json
targetAccountId
integer
required

Account whose authorized conversation data should be analyzed.

startAt
integer
required

Inclusive start of the range as Unix seconds.

endAt
integer
required

Inclusive end of the range as Unix seconds. Must be after startAt.

definition
object
required

Metric calculation applied to each matching conversation log.

includeTimeSeries
boolean
default:true

Include metric values grouped into time buckets.

groupBy
enum<string>

Add ranked group results. Organization and agent grouping are available when the selected account has access to those account levels.

Available options:
none,
organization,
agent
scope
object

Organization subset used for reseller-level grouped metrics.

Match organization or agent names in grouped results.

Maximum string length: 100
sort
enum<string>
default:metricValue

Field used to order grouped results.

Available options:
metricValue,
eventCount
direction
enum<string>
default:desc

Sort direction for grouped results.

Available options:
asc,
desc
page
integer
default:1

Group-result page number.

Required range: x >= 1
pageSize
integer
default:25

Number of grouped results per page.

Required range: 1 <= x <= 100
refresh
boolean
default:false

Recalculate instead of using a recent identical result.

Response

Metric calculated successfully

success
boolean
Example:

true

aggregate
number | null

Metric value across every matching conversation.

metricTotal
number

Sum used to calculate the aggregate.

eventCount
integer

Number of matching conversation records.

Required range: x >= 0
minimumSampleSize
integer

Requested minimum sample size, when supplied.

Required range: x >= 1
qualified
boolean

Whether the aggregate meets the requested minimum sample size.

timeSeries
object

Metric values keyed by Unix-second bucket start.

timeSeriesEventCounts
object

Matching record counts by bucket when a minimum sample size is used.

groups
object[]

Organization or agent comparisons when groupBy is enabled.

pagination
object

Present when grouped results are requested.