TraceSegment
A segment as the api returns it, with the api marks merged in. A turn segment carries its Turn metrics and, from 1.5.0, its cost estimate; stages, providers, quality and cost are null on setup and end.
An object with 12 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
cost | TurnCost or null | no | The Turn's cost estimate, the same as its Turn metrics carry; null on setup and end and when the Call was not rated. Added in 1.5.0. From 1.29.0 (workspace ADR 0078, decision 7) the api sends it only to a reader that holds usage:read and omits it for any other, such as the viewer role; a reader treats its absence as null. |
end_ms | integer or null | yes | Null when the segment never closed, as when the Call dropped mid-Turn. |
kind | TraceSegmentKind | yes | |
marks | array of TraceMark | yes | |
providers | TraceProviders or null | yes | |
quality | TraceQuality or null | yes | |
schema_version | 1 | yes | |
seq | integer | yes | The order of the segment in the trace. |
stages | TraceStages or null | yes | |
start_ms | integer | yes | |
truncated | boolean | yes | Low-priority marks (STT partials first) were dropped to stay within the bounds. |
turn_seq | integer or null | yes | The seq of the Turn a turn segment covers; null for setup and end. |